From e78fc537c9522c62469db756c9459054fd004fa5 Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Sat, 29 Aug 2020 20:18:04 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2A_Cap.html | 434 +- Documentation/AI.AI_A2A_Dispatcher.html | 434 +- Documentation/AI.AI_A2A_GCI.html | 33 + Documentation/AI.AI_A2A_Patrol.html | 33 + Documentation/AI.AI_A2G_BAI.html | 33 + Documentation/AI.AI_A2G_CAS.html | 33 + Documentation/AI.AI_A2G_Dispatcher.html | 434 +- Documentation/AI.AI_A2G_SEAD.html | 33 + Documentation/AI.AI_AIR_Dispatcher.html | 478 +- Documentation/AI.AI_Air.html | 434 +- Documentation/AI.AI_Air_Engage.html | 33 + Documentation/AI.AI_Air_Patrol.html | 434 +- Documentation/AI.AI_Air_Squadron.html | 33 + Documentation/AI.AI_Bai.html | 434 +- Documentation/AI.AI_Balancer.html | 434 +- Documentation/AI.AI_Cap.html | 434 +- Documentation/AI.AI_Cargo.html | 434 +- Documentation/AI.AI_Cargo_APC.html | 434 +- Documentation/AI.AI_Cargo_Airplane.html | 434 +- Documentation/AI.AI_Cargo_Dispatcher.html | 434 +- Documentation/AI.AI_Cargo_Dispatcher_APC.html | 434 +- .../AI.AI_Cargo_Dispatcher_Airplane.html | 434 +- .../AI.AI_Cargo_Dispatcher_Helicopter.html | 434 +- Documentation/AI.AI_Cargo_Helicopter.html | 434 +- Documentation/AI.AI_Cas.html | 434 +- .../AI.AI_ESCORT_DISPATCHER_REQUEST.html | 434 +- Documentation/AI.AI_Escort.html | 33 + Documentation/AI.AI_Escort_Dispatcher.html | 434 +- Documentation/AI.AI_Formation.html | 790 +- Documentation/AI.AI_Patrol.html | 434 +- Documentation/Actions.Account.html | 434 +- Documentation/Actions.Assign.html | 434 +- Documentation/Actions.Assist.html | 434 +- Documentation/Actions.Route.html | 434 +- Documentation/Cargo.Cargo.html | 434 +- Documentation/Cargo.CargoCrate.html | 33 + Documentation/Cargo.CargoGroup.html | 61 +- Documentation/Cargo.CargoSlingload.html | 33 + Documentation/Cargo.CargoUnit.html | 55 + Documentation/Core.Base.html | 33 + Documentation/Core.Database.html | 222 +- Documentation/Core.Event.html | 33 + Documentation/Core.Fsm.html | 1703 ++- Documentation/Core.Goal.html | 434 +- Documentation/Core.Menu.html | 33 + Documentation/Core.Message.html | 33 + Documentation/Core.Point.html | 592 +- Documentation/Core.Radio.html | 333 +- Documentation/Core.RadioQueue.html | 43 +- Documentation/Core.RadioSpeech.html | 39 +- Documentation/Core.Report.html | 33 + Documentation/Core.ScheduleDispatcher.html | 33 + Documentation/Core.Scheduler.html | 33 + Documentation/Core.Set.html | 3135 +++++- Documentation/Core.Settings.html | 41 +- Documentation/Core.Spawn.html | 325 +- Documentation/Core.SpawnStatic.html | 33 + Documentation/Core.Spot.html | 533 +- Documentation/Core.Timer.html | 5624 ++++++++++ Documentation/Core.UserFlag.html | 33 + Documentation/Core.UserSound.html | 33 + Documentation/Core.Velocity.html | 33 + Documentation/Core.Zone.html | 434 +- Documentation/DCS.html | 111 +- Documentation/ENUMS.html | 152 + Documentation/Functional.ATC_Ground.html | 33 + Documentation/Functional.Arty.html | 434 +- Documentation/Functional.CleanUp.html | 33 + Documentation/Functional.Designate.html | 544 +- Documentation/Functional.Detection.html | 1670 ++- Documentation/Functional.Escort.html | 33 + Documentation/Functional.FOX.html | 434 +- Documentation/Functional.MissileTrainer.html | 33 + Documentation/Functional.Movement.html | 33 + Documentation/Functional.PseudoATC.html | 33 + Documentation/Functional.Range.html | 434 +- Documentation/Functional.Rat.html | 108 +- Documentation/Functional.Scoring.html | 33 + Documentation/Functional.Sead.html | 33 + Documentation/Functional.Suppression.html | 434 +- Documentation/Functional.Warehouse.html | 434 +- .../Functional.ZoneCaptureCoalition.html | 33 + Documentation/Functional.ZoneGoal.html | 33 + Documentation/Functional.ZoneGoalCargo.html | 33 + .../Functional.ZoneGoalCoalition.html | 33 + Documentation/Ops.Airboss.html | 450 +- Documentation/Ops.Atis.html | 506 +- Documentation/Ops.RecoveryTanker.html | 434 +- Documentation/Ops.RescueHelo.html | 434 +- Documentation/Tasking.CommandCenter.html | 33 + Documentation/Tasking.DetectionManager.html | 434 +- Documentation/Tasking.Mission.html | 434 +- Documentation/Tasking.Task.html | 33 + Documentation/Tasking.TaskInfo.html | 33 + Documentation/Tasking.TaskZoneCapture.html | 33 + Documentation/Tasking.Task_A2A.html | 33 + .../Tasking.Task_A2A_Dispatcher.html | 434 +- Documentation/Tasking.Task_A2G.html | 33 + .../Tasking.Task_A2G_Dispatcher.html | 434 +- Documentation/Tasking.Task_Cargo.html | 33 + Documentation/Tasking.Task_Cargo_CSAR.html | 33 + .../Tasking.Task_Cargo_Dispatcher.html | 610 +- .../Tasking.Task_Cargo_Transport.html | 33 + Documentation/Tasking.Task_Manager.html | 434 +- .../Tasking.Task_Zone_Capture_Dispatcher.html | 434 +- Documentation/Utilities.PROFILER.html | 2328 ++++ Documentation/Utils.html | 169 +- Documentation/Wrapper.Airbase.html | 1093 +- Documentation/Wrapper.Client.html | 198 +- Documentation/Wrapper.Controllable.html | 198 +- Documentation/Wrapper.Group.html | 295 +- Documentation/Wrapper.Identifiable.html | 33 + Documentation/Wrapper.Marker.html | 9587 +++++++++++++++++ Documentation/Wrapper.Object.html | 33 + Documentation/Wrapper.Positionable.html | 258 +- Documentation/Wrapper.Scenery.html | 170 +- Documentation/Wrapper.Static.html | 170 +- Documentation/Wrapper.Unit.html | 198 +- Documentation/index.html | 69 + Documentation/routines.html | 33 + 120 files changed, 46952 insertions(+), 4751 deletions(-) create mode 100644 Documentation/Core.Timer.html create mode 100644 Documentation/Utilities.PROFILER.html create mode 100644 Documentation/Wrapper.Marker.html diff --git a/Documentation/AI.AI_A2A_Cap.html b/Documentation/AI.AI_A2A_Cap.html index 43003ff8e..86ea2889d 100644 --- a/Documentation/AI.AI_A2A_Cap.html +++ b/Documentation/AI.AI_A2A_Cap.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2240,7 +2273,13 @@ Use the method AI.AI_Cap#AI

AI_A2A_CAP.CallScheduler

- +

Call scheduler.

+ + + +

AI_A2A_CAP.ClassName

+ +

Name of the class.

@@ -2252,7 +2291,7 @@ Use the method AI.AI_Cap#AI

AI_A2A_CAP:GetCurrentState()

- +

Get current state.

@@ -2274,7 +2313,7 @@ Use the method AI.AI_Cap#AI -

AI_A2A_CAP:GetScores()

+

AI_A2A_CAP:GetScores(Scores)

Returns a table with the scores defined.

@@ -2288,7 +2327,7 @@ Use the method AI.AI_Cap#AI

AI_A2A_CAP:GetState()

- +

Get current state.

@@ -2304,15 +2343,15 @@ Use the method AI.AI_Cap#AI -

AI_A2A_CAP:Is(State)

+

AI_A2A_CAP:Is(State, If)

- +

Check if FSM is in state.

AI_A2A_CAP:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2324,7 +2363,7 @@ Use the method AI.AI_Cap#AI

AI_A2A_CAP.Scores

- +

Scores.

@@ -2378,73 +2417,73 @@ Use the method AI.AI_Cap#AI

AI_A2A_CAP:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_A2A_CAP:_create_transition(EventName)

- +

Create transition.

AI_A2A_CAP:_delayed_transition(EventName)

- +

Delayed transition.

AI_A2A_CAP:_eventmap(Events, EventStructure)

- +

Event map.

AI_A2A_CAP:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_A2A_CAP:_handler(EventName, ...)

- +

Handler.

AI_A2A_CAP:_isendstate(Current)

- +

Is end state.

AI_A2A_CAP:_submap(subs, sub, name)

- +

Sub maps.

AI_A2A_CAP:can(e)

- +

Check if can do an event.

AI_A2A_CAP:cannot(e)

- +

Check if cannot do an event.

AI_A2A_CAP.current

- +

Current state name.

@@ -2454,21 +2493,21 @@ Use the method AI.AI_Cap#AI -

AI_A2A_CAP:is(state)

+

AI_A2A_CAP:is(State, If, state)

- +

Check if FSM is in state.

AI_A2A_CAP.options

- +

Options.

AI_A2A_CAP.subs

- +

Subs.

@@ -7928,11 +7967,14 @@ Once the time is finished, the old AI will return to the base.

+ #string State

-

+ +

The FSM state.

+
@@ -8257,7 +8299,7 @@ Once the time is finished, the old AI will return to the base.

AI_A2A_CAP:GetCurrentState()

- +

Get current state.

@@ -8265,6 +8307,17 @@ Once the time is finished, the old AI will return to the base.

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -8284,6 +8337,17 @@ Once the time is finished, the old AI will return to the base.

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -8350,7 +8414,7 @@ Once the time is finished, the old AI will return to the base.

- +

Sub processes.

@@ -8362,7 +8426,7 @@ Once the time is finished, the old AI will return to the base.

Returns a table with the scores defined.

@@ -8373,6 +8437,18 @@ Once the time is finished, the old AI will return to the base.

+

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -8414,7 +8490,7 @@ Once the time is finished, the old AI will return to the base.

AI_A2A_CAP:GetState()

- +

Get current state.

@@ -8422,6 +8498,17 @@ Once the time is finished, the old AI will return to the base.

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -8441,6 +8528,17 @@ Once the time is finished, the old AI will return to the base.

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -8467,7 +8565,7 @@ Once the time is finished, the old AI will return to the base.

- +

Transitions.

@@ -8479,10 +8577,10 @@ Once the time is finished, the old AI will return to the base.

- +

Check if FSM is in state.

@@ -8490,15 +8588,31 @@ Once the time is finished, the old AI will return to the base.

-

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -8512,7 +8626,7 @@ Once the time is finished, the old AI will return to the base.

AI_A2A_CAP:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -8524,11 +8638,14 @@ Once the time is finished, the old AI will return to the base.

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -8655,7 +8772,7 @@ Once the time is finished, the old AI will return to the base.

AI_A2A_CAP:_add_to_map(Map, Event)

- +

Add to map.

@@ -8667,21 +8784,27 @@ Once the time is finished, the old AI will return to the base.

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -8695,7 +8818,7 @@ Once the time is finished, the old AI will return to the base.

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

- +

Call handler.

@@ -8707,43 +8830,65 @@ Once the time is finished, the old AI will return to the base.

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -8755,7 +8900,7 @@ Once the time is finished, the old AI will return to the base.

AI_A2A_CAP:_create_transition(EventName)

- +

Create transition.

@@ -8767,13 +8912,27 @@ Once the time is finished, the old AI will return to the base.

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -8785,7 +8944,7 @@ Once the time is finished, the old AI will return to the base.

AI_A2A_CAP:_delayed_transition(EventName)

- +

Delayed transition.

@@ -8797,13 +8956,27 @@ Once the time is finished, the old AI will return to the base.

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -8815,7 +8988,7 @@ Once the time is finished, the old AI will return to the base.

AI_A2A_CAP:_eventmap(Events, EventStructure)

- +

Event map.

@@ -8827,21 +9000,27 @@ Once the time is finished, the old AI will return to the base.

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -8855,7 +9034,7 @@ Once the time is finished, the old AI will return to the base.

AI_A2A_CAP:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -8867,23 +9046,40 @@ Once the time is finished, the old AI will return to the base.

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -8895,7 +9091,7 @@ Once the time is finished, the old AI will return to the base.

AI_A2A_CAP:_handler(EventName, ...)

- +

Handler.

@@ -8907,11 +9103,14 @@ Once the time is finished, the old AI will return to the base.

+ #string EventName

-

+ +

Event name.

+
@@ -8921,7 +9120,9 @@ Once the time is finished, the old AI will return to the base.

-

+ +

Arguments.

+
@@ -8935,7 +9136,7 @@ Once the time is finished, the old AI will return to the base.

AI_A2A_CAP:_isendstate(Current)

- +

Is end state.

@@ -8947,13 +9148,35 @@ Once the time is finished, the old AI will return to the base.

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -8965,7 +9188,7 @@ Once the time is finished, the old AI will return to the base.

AI_A2A_CAP:_submap(subs, sub, name)

- +

Sub maps.

@@ -8977,31 +9200,40 @@ Once the time is finished, the old AI will return to the base.

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -9015,7 +9247,7 @@ Once the time is finished, the old AI will return to the base.

AI_A2A_CAP:can(e)

- +

Check if can do an event.

@@ -9027,13 +9259,35 @@ Once the time is finished, the old AI will return to the base.

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -9045,7 +9299,7 @@ Once the time is finished, the old AI will return to the base.

AI_A2A_CAP:cannot(e)

- +

Check if cannot do an event.

@@ -9057,13 +9311,27 @@ Once the time is finished, the old AI will return to the base.

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -9072,10 +9340,10 @@ Once the time is finished, the old AI will return to the base.

- +

Check if FSM is in state.

@@ -9083,7 +9351,33 @@ Once the time is finished, the old AI will return to the base.

-

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/AI.AI_A2A_Dispatcher.html b/Documentation/AI.AI_A2A_Dispatcher.html index 106efa53b..1316cb8da 100644 --- a/Documentation/AI.AI_A2A_Dispatcher.html +++ b/Documentation/AI.AI_A2A_Dispatcher.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -3476,7 +3509,13 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea

AI_A2A_DISPATCHER.CallScheduler

- +

Call scheduler.

+ + + +

AI_A2A_DISPATCHER.ClassName

+ +

Name of the class.

@@ -3488,7 +3527,7 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea

AI_A2A_DISPATCHER:GetCurrentState()

- +

Get current state.

@@ -3510,7 +3549,7 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea -

AI_A2A_DISPATCHER:GetScores()

+

AI_A2A_DISPATCHER:GetScores(Scores)

Returns a table with the scores defined.

@@ -3524,7 +3563,7 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea

AI_A2A_DISPATCHER:GetState()

- +

Get current state.

@@ -3540,15 +3579,15 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea -

AI_A2A_DISPATCHER:Is(State)

+

AI_A2A_DISPATCHER:Is(State, If)

- +

Check if FSM is in state.

AI_A2A_DISPATCHER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -3560,7 +3599,7 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea

AI_A2A_DISPATCHER.Scores

- +

Scores.

@@ -3614,73 +3653,73 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea

AI_A2A_DISPATCHER:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_A2A_DISPATCHER:_create_transition(EventName)

- +

Create transition.

AI_A2A_DISPATCHER:_delayed_transition(EventName)

- +

Delayed transition.

AI_A2A_DISPATCHER:_eventmap(Events, EventStructure)

- +

Event map.

AI_A2A_DISPATCHER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_A2A_DISPATCHER:_handler(EventName, ...)

- +

Handler.

AI_A2A_DISPATCHER:_isendstate(Current)

- +

Is end state.

AI_A2A_DISPATCHER:_submap(subs, sub, name)

- +

Sub maps.

AI_A2A_DISPATCHER:can(e)

- +

Check if can do an event.

AI_A2A_DISPATCHER:cannot(e)

- +

Check if cannot do an event.

AI_A2A_DISPATCHER.current

- +

Current state name.

@@ -3690,21 +3729,21 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea -

AI_A2A_DISPATCHER:is(state)

+

AI_A2A_DISPATCHER:is(State, If, state)

- +

Check if FSM is in state.

AI_A2A_DISPATCHER.options

- +

Options.

AI_A2A_DISPATCHER.subs

- +

Subs.

@@ -12293,11 +12332,14 @@ They will lock the parking spot.

+ #string State

-

+ +

The FSM state.

+
@@ -12622,7 +12664,7 @@ They will lock the parking spot.

AI_A2A_DISPATCHER:GetCurrentState()

- +

Get current state.

@@ -12630,6 +12672,17 @@ They will lock the parking spot.

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -12649,6 +12702,17 @@ They will lock the parking spot.

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -12715,7 +12779,7 @@ They will lock the parking spot.

- +

Sub processes.

@@ -12727,7 +12791,7 @@ They will lock the parking spot.

Returns a table with the scores defined.

@@ -12738,6 +12802,18 @@ They will lock the parking spot.

+

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -12779,7 +12855,7 @@ They will lock the parking spot.

AI_A2A_DISPATCHER:GetState()

- +

Get current state.

@@ -12787,6 +12863,17 @@ They will lock the parking spot.

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -12806,6 +12893,17 @@ They will lock the parking spot.

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -12832,7 +12930,7 @@ They will lock the parking spot.

- +

Transitions.

@@ -12844,10 +12942,10 @@ They will lock the parking spot.

- +

Check if FSM is in state.

@@ -12855,15 +12953,31 @@ They will lock the parking spot.

-

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -12877,7 +12991,7 @@ They will lock the parking spot.

AI_A2A_DISPATCHER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -12889,11 +13003,14 @@ They will lock the parking spot.

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -13020,7 +13137,7 @@ They will lock the parking spot.

AI_A2A_DISPATCHER:_add_to_map(Map, Event)

- +

Add to map.

@@ -13032,21 +13149,27 @@ They will lock the parking spot.

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -13060,7 +13183,7 @@ They will lock the parking spot.

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

- +

Call handler.

@@ -13072,43 +13195,65 @@ They will lock the parking spot.

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -13120,7 +13265,7 @@ They will lock the parking spot.

AI_A2A_DISPATCHER:_create_transition(EventName)

- +

Create transition.

@@ -13132,13 +13277,27 @@ They will lock the parking spot.

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -13150,7 +13309,7 @@ They will lock the parking spot.

AI_A2A_DISPATCHER:_delayed_transition(EventName)

- +

Delayed transition.

@@ -13162,13 +13321,27 @@ They will lock the parking spot.

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -13180,7 +13353,7 @@ They will lock the parking spot.

AI_A2A_DISPATCHER:_eventmap(Events, EventStructure)

- +

Event map.

@@ -13192,21 +13365,27 @@ They will lock the parking spot.

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -13220,7 +13399,7 @@ They will lock the parking spot.

AI_A2A_DISPATCHER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -13232,23 +13411,40 @@ They will lock the parking spot.

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -13260,7 +13456,7 @@ They will lock the parking spot.

AI_A2A_DISPATCHER:_handler(EventName, ...)

- +

Handler.

@@ -13272,11 +13468,14 @@ They will lock the parking spot.

+ #string EventName

-

+ +

Event name.

+
@@ -13286,7 +13485,9 @@ They will lock the parking spot.

-

+ +

Arguments.

+
@@ -13300,7 +13501,7 @@ They will lock the parking spot.

AI_A2A_DISPATCHER:_isendstate(Current)

- +

Is end state.

@@ -13312,13 +13513,35 @@ They will lock the parking spot.

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -13330,7 +13553,7 @@ They will lock the parking spot.

AI_A2A_DISPATCHER:_submap(subs, sub, name)

- +

Sub maps.

@@ -13342,31 +13565,40 @@ They will lock the parking spot.

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -13380,7 +13612,7 @@ They will lock the parking spot.

AI_A2A_DISPATCHER:can(e)

- +

Check if can do an event.

@@ -13392,13 +13624,35 @@ They will lock the parking spot.

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -13410,7 +13664,7 @@ They will lock the parking spot.

AI_A2A_DISPATCHER:cannot(e)

- +

Check if cannot do an event.

@@ -13422,13 +13676,27 @@ They will lock the parking spot.

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -13437,10 +13705,10 @@ They will lock the parking spot.

- +

Check if FSM is in state.

@@ -13448,7 +13716,33 @@ They will lock the parking spot.

-

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/AI.AI_A2A_GCI.html b/Documentation/AI.AI_A2A_GCI.html index 788df70d2..8b73f7fa2 100644 --- a/Documentation/AI.AI_A2A_GCI.html +++ b/Documentation/AI.AI_A2A_GCI.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/AI.AI_A2A_Patrol.html b/Documentation/AI.AI_A2A_Patrol.html index 0fc11e303..43b8077b9 100644 --- a/Documentation/AI.AI_A2A_Patrol.html +++ b/Documentation/AI.AI_A2A_Patrol.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/AI.AI_A2G_BAI.html b/Documentation/AI.AI_A2G_BAI.html index b5d2d831c..e2ee58937 100644 --- a/Documentation/AI.AI_A2G_BAI.html +++ b/Documentation/AI.AI_A2G_BAI.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/AI.AI_A2G_CAS.html b/Documentation/AI.AI_A2G_CAS.html index fb8dcb842..5713e9c68 100644 --- a/Documentation/AI.AI_A2G_CAS.html +++ b/Documentation/AI.AI_A2G_CAS.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index bf1e7c576..f2f750635 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -3463,7 +3496,13 @@ of the squadron will be destroyed. This to keep consistency of air operations no

AI_A2G_DISPATCHER.CallScheduler

- +

Call scheduler.

+ + + +

AI_A2G_DISPATCHER.ClassName

+ +

Name of the class.

@@ -3475,7 +3514,7 @@ of the squadron will be destroyed. This to keep consistency of air operations no

AI_A2G_DISPATCHER:GetCurrentState()

- +

Get current state.

@@ -3497,7 +3536,7 @@ of the squadron will be destroyed. This to keep consistency of air operations no -

AI_A2G_DISPATCHER:GetScores()

+

AI_A2G_DISPATCHER:GetScores(Scores)

Returns a table with the scores defined.

@@ -3511,7 +3550,7 @@ of the squadron will be destroyed. This to keep consistency of air operations no

AI_A2G_DISPATCHER:GetState()

- +

Get current state.

@@ -3527,15 +3566,15 @@ of the squadron will be destroyed. This to keep consistency of air operations no -

AI_A2G_DISPATCHER:Is(State)

+

AI_A2G_DISPATCHER:Is(State, If)

- +

Check if FSM is in state.

AI_A2G_DISPATCHER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -3547,7 +3586,7 @@ of the squadron will be destroyed. This to keep consistency of air operations no

AI_A2G_DISPATCHER.Scores

- +

Scores.

@@ -3601,73 +3640,73 @@ of the squadron will be destroyed. This to keep consistency of air operations no

AI_A2G_DISPATCHER:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_A2G_DISPATCHER:_create_transition(EventName)

- +

Create transition.

AI_A2G_DISPATCHER:_delayed_transition(EventName)

- +

Delayed transition.

AI_A2G_DISPATCHER:_eventmap(Events, EventStructure)

- +

Event map.

AI_A2G_DISPATCHER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_A2G_DISPATCHER:_handler(EventName, ...)

- +

Handler.

AI_A2G_DISPATCHER:_isendstate(Current)

- +

Is end state.

AI_A2G_DISPATCHER:_submap(subs, sub, name)

- +

Sub maps.

AI_A2G_DISPATCHER:can(e)

- +

Check if can do an event.

AI_A2G_DISPATCHER:cannot(e)

- +

Check if cannot do an event.

AI_A2G_DISPATCHER.current

- +

Current state name.

@@ -3677,21 +3716,21 @@ of the squadron will be destroyed. This to keep consistency of air operations no -

AI_A2G_DISPATCHER:is(state)

+

AI_A2G_DISPATCHER:is(State, If, state)

- +

Check if FSM is in state.

AI_A2G_DISPATCHER.options

- +

Options.

AI_A2G_DISPATCHER.subs

- +

Subs.

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

+ #string State

-

+ +

The FSM state.

+
@@ -14630,7 +14672,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_A2G_DISPATCHER:GetCurrentState()

- +

Get current state.

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

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -14723,7 +14787,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

- +

Sub processes.

@@ -14735,7 +14799,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

Returns a table with the scores defined.

@@ -14746,6 +14810,18 @@ multiplied by the Overhead and rounded up to the smallest integer.

+

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -14787,7 +14863,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_A2G_DISPATCHER:GetState()

- +

Get current state.

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

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -14840,7 +14938,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

- +

Transitions.

@@ -14852,10 +14950,10 @@ multiplied by the Overhead and rounded up to the smallest integer.

- +

Check if FSM is in state.

@@ -14863,15 +14961,31 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -14885,7 +14999,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_A2G_DISPATCHER:LoadCallBacks(CallBackTable)

- +

Load call backs.

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

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -15028,7 +15145,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_A2G_DISPATCHER:_add_to_map(Map, Event)

- +

Add to map.

@@ -15040,21 +15157,27 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -15068,7 +15191,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

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

- +

Call handler.

@@ -15080,43 +15203,65 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -15128,7 +15273,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_A2G_DISPATCHER:_create_transition(EventName)

- +

Create transition.

@@ -15140,13 +15285,27 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -15158,7 +15317,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_A2G_DISPATCHER:_delayed_transition(EventName)

- +

Delayed transition.

@@ -15170,13 +15329,27 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -15188,7 +15361,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_A2G_DISPATCHER:_eventmap(Events, EventStructure)

- +

Event map.

@@ -15200,21 +15373,27 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -15228,7 +15407,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_A2G_DISPATCHER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -15240,23 +15419,40 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -15268,7 +15464,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_A2G_DISPATCHER:_handler(EventName, ...)

- +

Handler.

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

+ #string EventName

-

+ +

Event name.

+
@@ -15294,7 +15493,9 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

+ +

Arguments.

+
@@ -15308,7 +15509,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_A2G_DISPATCHER:_isendstate(Current)

- +

Is end state.

@@ -15320,13 +15521,35 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -15338,7 +15561,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_A2G_DISPATCHER:_submap(subs, sub, name)

- +

Sub maps.

@@ -15350,31 +15573,40 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -15388,7 +15620,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_A2G_DISPATCHER:can(e)

- +

Check if can do an event.

@@ -15400,13 +15632,35 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -15418,7 +15672,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_A2G_DISPATCHER:cannot(e)

- +

Check if cannot do an event.

@@ -15430,13 +15684,27 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -15445,10 +15713,10 @@ multiplied by the Overhead and rounded up to the smallest integer.

- +

Check if FSM is in state.

@@ -15456,7 +15724,33 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/AI.AI_A2G_SEAD.html b/Documentation/AI.AI_A2G_SEAD.html index 815eb61d1..8505daae5 100644 --- a/Documentation/AI.AI_A2G_SEAD.html +++ b/Documentation/AI.AI_A2G_SEAD.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/AI.AI_AIR_Dispatcher.html b/Documentation/AI.AI_AIR_Dispatcher.html index 828491302..d1f7aff56 100644 --- a/Documentation/AI.AI_AIR_Dispatcher.html +++ b/Documentation/AI.AI_AIR_Dispatcher.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -3259,7 +3292,13 @@ of the squadron will be destroyed. This to keep consistency of air operations no

AI_AIR_DISPATCHER.CallScheduler

- +

Call scheduler.

+ + + +

AI_AIR_DISPATCHER.ClassName

+ +

Name of the class.

@@ -3271,7 +3310,7 @@ of the squadron will be destroyed. This to keep consistency of air operations no

AI_AIR_DISPATCHER:GetCurrentState()

- +

Get current state.

@@ -3293,7 +3332,7 @@ of the squadron will be destroyed. This to keep consistency of air operations no -

AI_AIR_DISPATCHER:GetScores()

+

AI_AIR_DISPATCHER:GetScores(Scores)

Returns a table with the scores defined.

@@ -3307,7 +3346,7 @@ of the squadron will be destroyed. This to keep consistency of air operations no

AI_AIR_DISPATCHER:GetState()

- +

Get current state.

@@ -3323,15 +3362,15 @@ of the squadron will be destroyed. This to keep consistency of air operations no -

AI_AIR_DISPATCHER:Is(State)

+

AI_AIR_DISPATCHER:Is(State, If)

- +

Check if FSM is in state.

AI_AIR_DISPATCHER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -3343,7 +3382,7 @@ of the squadron will be destroyed. This to keep consistency of air operations no

AI_AIR_DISPATCHER.Scores

- +

Scores.

@@ -3397,73 +3436,73 @@ of the squadron will be destroyed. This to keep consistency of air operations no

AI_AIR_DISPATCHER:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_AIR_DISPATCHER:_create_transition(EventName)

- +

Create transition.

AI_AIR_DISPATCHER:_delayed_transition(EventName)

- +

Delayed transition.

AI_AIR_DISPATCHER:_eventmap(Events, EventStructure)

- +

Event map.

AI_AIR_DISPATCHER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_AIR_DISPATCHER:_handler(EventName, ...)

- +

Handler.

AI_AIR_DISPATCHER:_isendstate(Current)

- +

Is end state.

AI_AIR_DISPATCHER:_submap(subs, sub, name)

- +

Sub maps.

AI_AIR_DISPATCHER:can(e)

- +

Check if can do an event.

AI_AIR_DISPATCHER:cannot(e)

- +

Check if cannot do an event.

AI_AIR_DISPATCHER.current

- +

Current state name.

@@ -3473,21 +3512,21 @@ of the squadron will be destroyed. This to keep consistency of air operations no -

AI_AIR_DISPATCHER:is(state)

+

AI_AIR_DISPATCHER:is(State, If, state)

- +

Check if FSM is in state.

AI_AIR_DISPATCHER.options

- +

Options.

AI_AIR_DISPATCHER.subs

- +

Subs.

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

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

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

+ #string State

-

+ +

The FSM state.

+
@@ -11380,7 +11389,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_AIR_DISPATCHER:GetCurrentState()

- +

Get current state.

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

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -11473,7 +11504,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

- +

Sub processes.

@@ -11485,7 +11516,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

Returns a table with the scores defined.

@@ -11496,6 +11527,18 @@ multiplied by the Overhead and rounded up to the smallest integer.

+

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -11537,7 +11580,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_AIR_DISPATCHER:GetState()

- +

Get current state.

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

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -11590,7 +11655,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

- +

Transitions.

@@ -11602,10 +11667,10 @@ multiplied by the Overhead and rounded up to the smallest integer.

- +

Check if FSM is in state.

@@ -11613,15 +11678,31 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -11635,7 +11716,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_AIR_DISPATCHER:LoadCallBacks(CallBackTable)

- +

Load call backs.

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

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -11778,7 +11862,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_AIR_DISPATCHER:_add_to_map(Map, Event)

- +

Add to map.

@@ -11790,21 +11874,27 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -11818,7 +11908,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

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

- +

Call handler.

@@ -11830,43 +11920,65 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -11878,7 +11990,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_AIR_DISPATCHER:_create_transition(EventName)

- +

Create transition.

@@ -11890,13 +12002,27 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -11908,7 +12034,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_AIR_DISPATCHER:_delayed_transition(EventName)

- +

Delayed transition.

@@ -11920,13 +12046,27 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -11938,7 +12078,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_AIR_DISPATCHER:_eventmap(Events, EventStructure)

- +

Event map.

@@ -11950,21 +12090,27 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -11978,7 +12124,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_AIR_DISPATCHER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -11990,23 +12136,40 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -12018,7 +12181,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_AIR_DISPATCHER:_handler(EventName, ...)

- +

Handler.

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

+ #string EventName

-

+ +

Event name.

+
@@ -12044,7 +12210,9 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

+ +

Arguments.

+
@@ -12058,7 +12226,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_AIR_DISPATCHER:_isendstate(Current)

- +

Is end state.

@@ -12070,13 +12238,35 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -12088,7 +12278,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_AIR_DISPATCHER:_submap(subs, sub, name)

- +

Sub maps.

@@ -12100,31 +12290,40 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -12138,7 +12337,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_AIR_DISPATCHER:can(e)

- +

Check if can do an event.

@@ -12150,13 +12349,35 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -12168,7 +12389,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

AI_AIR_DISPATCHER:cannot(e)

- +

Check if cannot do an event.

@@ -12180,13 +12401,27 @@ multiplied by the Overhead and rounded up to the smallest integer.

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -12195,10 +12430,10 @@ multiplied by the Overhead and rounded up to the smallest integer.

- +

Check if FSM is in state.

@@ -12206,7 +12441,33 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

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

The Defender Default Settings over all Squadrons.

-
- -
-
-
diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html index 76ef825cd..17a6549ee 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1940,7 +1973,13 @@ and the resulting state will be the To state.

AI_AIR.CallScheduler

- +

Call scheduler.

+ + + +

AI_AIR.ClassName

+ +

Name of the class.

@@ -1952,7 +1991,7 @@ and the resulting state will be the To state.

AI_AIR:GetCurrentState()

- +

Get current state.

@@ -1974,7 +2013,7 @@ and the resulting state will be the To state.

-

AI_AIR:GetScores()

+

AI_AIR:GetScores(Scores)

Returns a table with the scores defined.

@@ -1988,7 +2027,7 @@ and the resulting state will be the To state.

AI_AIR:GetState()

- +

Get current state.

@@ -2004,15 +2043,15 @@ and the resulting state will be the To state.

-

AI_AIR:Is(State)

+

AI_AIR:Is(State, If)

- +

Check if FSM is in state.

AI_AIR:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2024,7 +2063,7 @@ and the resulting state will be the To state.

AI_AIR.Scores

- +

Scores.

@@ -2078,73 +2117,73 @@ and the resulting state will be the To state.

AI_AIR:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_AIR:_create_transition(EventName)

- +

Create transition.

AI_AIR:_delayed_transition(EventName)

- +

Delayed transition.

AI_AIR:_eventmap(Events, EventStructure)

- +

Event map.

AI_AIR:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_AIR:_handler(EventName, ...)

- +

Handler.

AI_AIR:_isendstate(Current)

- +

Is end state.

AI_AIR:_submap(subs, sub, name)

- +

Sub maps.

AI_AIR:can(e)

- +

Check if can do an event.

AI_AIR:cannot(e)

- +

Check if cannot do an event.

AI_AIR.current

- +

Current state name.

@@ -2154,21 +2193,21 @@ and the resulting state will be the To state.

-

AI_AIR:is(state)

+

AI_AIR:is(State, If, state)

- +

Check if FSM is in state.

AI_AIR.options

- +

Options.

AI_AIR.subs

- +

Subs.

@@ -6331,11 +6370,14 @@ Once the time is finished, the old AI will return to the base.

+ #string State

-

+ +

The FSM state.

+
@@ -6660,7 +6702,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR:GetCurrentState()

- +

Get current state.

@@ -6668,6 +6710,17 @@ Once the time is finished, the old AI will return to the base.

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -6687,6 +6740,17 @@ Once the time is finished, the old AI will return to the base.

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -6753,7 +6817,7 @@ Once the time is finished, the old AI will return to the base.

- +

Sub processes.

@@ -6765,7 +6829,7 @@ Once the time is finished, the old AI will return to the base.

Returns a table with the scores defined.

@@ -6776,6 +6840,18 @@ Once the time is finished, the old AI will return to the base.

+

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -6817,7 +6893,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR:GetState()

- +

Get current state.

@@ -6825,6 +6901,17 @@ Once the time is finished, the old AI will return to the base.

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -6844,6 +6931,17 @@ Once the time is finished, the old AI will return to the base.

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -6870,7 +6968,7 @@ Once the time is finished, the old AI will return to the base.

- +

Transitions.

@@ -6882,10 +6980,10 @@ Once the time is finished, the old AI will return to the base.

- +

Check if FSM is in state.

@@ -6893,15 +6991,31 @@ Once the time is finished, the old AI will return to the base.

-

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -6915,7 +7029,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -6927,11 +7041,14 @@ Once the time is finished, the old AI will return to the base.

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -7058,7 +7175,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR:_add_to_map(Map, Event)

- +

Add to map.

@@ -7070,21 +7187,27 @@ Once the time is finished, the old AI will return to the base.

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -7098,7 +7221,7 @@ Once the time is finished, the old AI will return to the base.

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

- +

Call handler.

@@ -7110,43 +7233,65 @@ Once the time is finished, the old AI will return to the base.

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -7158,7 +7303,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR:_create_transition(EventName)

- +

Create transition.

@@ -7170,13 +7315,27 @@ Once the time is finished, the old AI will return to the base.

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -7188,7 +7347,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR:_delayed_transition(EventName)

- +

Delayed transition.

@@ -7200,13 +7359,27 @@ Once the time is finished, the old AI will return to the base.

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -7218,7 +7391,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR:_eventmap(Events, EventStructure)

- +

Event map.

@@ -7230,21 +7403,27 @@ Once the time is finished, the old AI will return to the base.

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -7258,7 +7437,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -7270,23 +7449,40 @@ Once the time is finished, the old AI will return to the base.

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -7298,7 +7494,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR:_handler(EventName, ...)

- +

Handler.

@@ -7310,11 +7506,14 @@ Once the time is finished, the old AI will return to the base.

+ #string EventName

-

+ +

Event name.

+
@@ -7324,7 +7523,9 @@ Once the time is finished, the old AI will return to the base.

-

+ +

Arguments.

+
@@ -7338,7 +7539,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR:_isendstate(Current)

- +

Is end state.

@@ -7350,13 +7551,35 @@ Once the time is finished, the old AI will return to the base.

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -7368,7 +7591,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR:_submap(subs, sub, name)

- +

Sub maps.

@@ -7380,31 +7603,40 @@ Once the time is finished, the old AI will return to the base.

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -7418,7 +7650,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR:can(e)

- +

Check if can do an event.

@@ -7430,13 +7662,35 @@ Once the time is finished, the old AI will return to the base.

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -7448,7 +7702,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR:cannot(e)

- +

Check if cannot do an event.

@@ -7460,13 +7714,27 @@ Once the time is finished, the old AI will return to the base.

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -7475,10 +7743,10 @@ Once the time is finished, the old AI will return to the base.

- +

Check if FSM is in state.

@@ -7486,7 +7754,33 @@ Once the time is finished, the old AI will return to the base.

-

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/AI.AI_Air_Engage.html b/Documentation/AI.AI_Air_Engage.html index 6f20d060a..ecfb7ca65 100644 --- a/Documentation/AI.AI_Air_Engage.html +++ b/Documentation/AI.AI_Air_Engage.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/AI.AI_Air_Patrol.html b/Documentation/AI.AI_Air_Patrol.html index 85c85e376..b98fdea7d 100644 --- a/Documentation/AI.AI_Air_Patrol.html +++ b/Documentation/AI.AI_Air_Patrol.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2183,7 +2216,13 @@ Use the method AI.AI_Cap

AI_AIR_PATROL.CallScheduler

- +

Call scheduler.

+ + + +

AI_AIR_PATROL.ClassName

+ +

Name of the class.

@@ -2195,7 +2234,7 @@ Use the method AI.AI_Cap

AI_AIR_PATROL:GetCurrentState()

- +

Get current state.

@@ -2217,7 +2256,7 @@ Use the method AI.AI_Cap -

AI_AIR_PATROL:GetScores()

+

AI_AIR_PATROL:GetScores(Scores)

Returns a table with the scores defined.

@@ -2231,7 +2270,7 @@ Use the method AI.AI_Cap

AI_AIR_PATROL:GetState()

- +

Get current state.

@@ -2247,15 +2286,15 @@ Use the method AI.AI_Cap -

AI_AIR_PATROL:Is(State)

+

AI_AIR_PATROL:Is(State, If)

- +

Check if FSM is in state.

AI_AIR_PATROL:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2267,7 +2306,7 @@ Use the method AI.AI_Cap

AI_AIR_PATROL.Scores

- +

Scores.

@@ -2321,73 +2360,73 @@ Use the method AI.AI_Cap

AI_AIR_PATROL:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_AIR_PATROL:_create_transition(EventName)

- +

Create transition.

AI_AIR_PATROL:_delayed_transition(EventName)

- +

Delayed transition.

AI_AIR_PATROL:_eventmap(Events, EventStructure)

- +

Event map.

AI_AIR_PATROL:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_AIR_PATROL:_handler(EventName, ...)

- +

Handler.

AI_AIR_PATROL:_isendstate(Current)

- +

Is end state.

AI_AIR_PATROL:_submap(subs, sub, name)

- +

Sub maps.

AI_AIR_PATROL:can(e)

- +

Check if can do an event.

AI_AIR_PATROL:cannot(e)

- +

Check if cannot do an event.

AI_AIR_PATROL.current

- +

Current state name.

@@ -2397,21 +2436,21 @@ Use the method AI.AI_Cap -

AI_AIR_PATROL:is(state)

+

AI_AIR_PATROL:is(State, If, state)

- +

Check if FSM is in state.

AI_AIR_PATROL.options

- +

Options.

AI_AIR_PATROL.subs

- +

Subs.

@@ -7458,11 +7497,14 @@ Once the time is finished, the old AI will return to the base.

+ #string State

-

+ +

The FSM state.

+
@@ -7787,7 +7829,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR_PATROL:GetCurrentState()

- +

Get current state.

@@ -7795,6 +7837,17 @@ Once the time is finished, the old AI will return to the base.

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -7814,6 +7867,17 @@ Once the time is finished, the old AI will return to the base.

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -7880,7 +7944,7 @@ Once the time is finished, the old AI will return to the base.

- +

Sub processes.

@@ -7892,7 +7956,7 @@ Once the time is finished, the old AI will return to the base.

Returns a table with the scores defined.

@@ -7903,6 +7967,18 @@ Once the time is finished, the old AI will return to the base.

+

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -7944,7 +8020,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR_PATROL:GetState()

- +

Get current state.

@@ -7952,6 +8028,17 @@ Once the time is finished, the old AI will return to the base.

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -7971,6 +8058,17 @@ Once the time is finished, the old AI will return to the base.

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -7997,7 +8095,7 @@ Once the time is finished, the old AI will return to the base.

- +

Transitions.

@@ -8009,10 +8107,10 @@ Once the time is finished, the old AI will return to the base.

- +

Check if FSM is in state.

@@ -8020,15 +8118,31 @@ Once the time is finished, the old AI will return to the base.

-

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -8042,7 +8156,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR_PATROL:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -8054,11 +8168,14 @@ Once the time is finished, the old AI will return to the base.

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -8185,7 +8302,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR_PATROL:_add_to_map(Map, Event)

- +

Add to map.

@@ -8197,21 +8314,27 @@ Once the time is finished, the old AI will return to the base.

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -8225,7 +8348,7 @@ Once the time is finished, the old AI will return to the base.

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

- +

Call handler.

@@ -8237,43 +8360,65 @@ Once the time is finished, the old AI will return to the base.

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -8285,7 +8430,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR_PATROL:_create_transition(EventName)

- +

Create transition.

@@ -8297,13 +8442,27 @@ Once the time is finished, the old AI will return to the base.

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -8315,7 +8474,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR_PATROL:_delayed_transition(EventName)

- +

Delayed transition.

@@ -8327,13 +8486,27 @@ Once the time is finished, the old AI will return to the base.

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -8345,7 +8518,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR_PATROL:_eventmap(Events, EventStructure)

- +

Event map.

@@ -8357,21 +8530,27 @@ Once the time is finished, the old AI will return to the base.

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -8385,7 +8564,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR_PATROL:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -8397,23 +8576,40 @@ Once the time is finished, the old AI will return to the base.

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -8425,7 +8621,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR_PATROL:_handler(EventName, ...)

- +

Handler.

@@ -8437,11 +8633,14 @@ Once the time is finished, the old AI will return to the base.

+ #string EventName

-

+ +

Event name.

+
@@ -8451,7 +8650,9 @@ Once the time is finished, the old AI will return to the base.

-

+ +

Arguments.

+
@@ -8465,7 +8666,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR_PATROL:_isendstate(Current)

- +

Is end state.

@@ -8477,13 +8678,35 @@ Once the time is finished, the old AI will return to the base.

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -8495,7 +8718,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR_PATROL:_submap(subs, sub, name)

- +

Sub maps.

@@ -8507,31 +8730,40 @@ Once the time is finished, the old AI will return to the base.

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -8545,7 +8777,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR_PATROL:can(e)

- +

Check if can do an event.

@@ -8557,13 +8789,35 @@ Once the time is finished, the old AI will return to the base.

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -8575,7 +8829,7 @@ Once the time is finished, the old AI will return to the base.

AI_AIR_PATROL:cannot(e)

- +

Check if cannot do an event.

@@ -8587,13 +8841,27 @@ Once the time is finished, the old AI will return to the base.

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -8602,10 +8870,10 @@ Once the time is finished, the old AI will return to the base.

- +

Check if FSM is in state.

@@ -8613,7 +8881,33 @@ Once the time is finished, the old AI will return to the base.

-

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html index d1fc7631b..de2db24a5 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/AI.AI_Bai.html b/Documentation/AI.AI_Bai.html index b9462abc1..590ece742 100644 --- a/Documentation/AI.AI_Bai.html +++ b/Documentation/AI.AI_Bai.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2398,7 +2431,13 @@ is the point where a map object is to be destroyed (like a bridge).

AI_BAI_ZONE.CallScheduler

- +

Call scheduler.

+ + + +

AI_BAI_ZONE.ClassName

+ +

Name of the class.

@@ -2410,7 +2449,7 @@ is the point where a map object is to be destroyed (like a bridge).

AI_BAI_ZONE:GetCurrentState()

- +

Get current state.

@@ -2432,7 +2471,7 @@ is the point where a map object is to be destroyed (like a bridge).

-

AI_BAI_ZONE:GetScores()

+

AI_BAI_ZONE:GetScores(Scores)

Returns a table with the scores defined.

@@ -2446,7 +2485,7 @@ is the point where a map object is to be destroyed (like a bridge).

AI_BAI_ZONE:GetState()

- +

Get current state.

@@ -2462,15 +2501,15 @@ is the point where a map object is to be destroyed (like a bridge).

-

AI_BAI_ZONE:Is(State)

+

AI_BAI_ZONE:Is(State, If)

- +

Check if FSM is in state.

AI_BAI_ZONE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2482,7 +2521,7 @@ is the point where a map object is to be destroyed (like a bridge).

AI_BAI_ZONE.Scores

- +

Scores.

@@ -2536,73 +2575,73 @@ is the point where a map object is to be destroyed (like a bridge).

AI_BAI_ZONE:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_BAI_ZONE:_create_transition(EventName)

- +

Create transition.

AI_BAI_ZONE:_delayed_transition(EventName)

- +

Delayed transition.

AI_BAI_ZONE:_eventmap(Events, EventStructure)

- +

Event map.

AI_BAI_ZONE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_BAI_ZONE:_handler(EventName, ...)

- +

Handler.

AI_BAI_ZONE:_isendstate(Current)

- +

Is end state.

AI_BAI_ZONE:_submap(subs, sub, name)

- +

Sub maps.

AI_BAI_ZONE:can(e)

- +

Check if can do an event.

AI_BAI_ZONE:cannot(e)

- +

Check if cannot do an event.

AI_BAI_ZONE.current

- +

Current state name.

@@ -2612,21 +2651,21 @@ is the point where a map object is to be destroyed (like a bridge).

-

AI_BAI_ZONE:is(state)

+

AI_BAI_ZONE:is(State, If, state)

- +

Check if FSM is in state.

AI_BAI_ZONE.options

- +

Options.

AI_BAI_ZONE.subs

- +

Subs.

@@ -9328,11 +9367,14 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string State

-

+ +

The FSM state.

+
@@ -9657,7 +9699,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_BAI_ZONE:GetCurrentState()

- +

Get current state.

@@ -9665,6 +9707,17 @@ Note that this method is required, as triggers the next route when patrolling fo +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -9684,6 +9737,17 @@ Note that this method is required, as triggers the next route when patrolling fo

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -9750,7 +9814,7 @@ Note that this method is required, as triggers the next route when patrolling fo
- +

Sub processes.

@@ -9762,7 +9826,7 @@ Note that this method is required, as triggers the next route when patrolling fo

Returns a table with the scores defined.

@@ -9773,6 +9837,18 @@ Note that this method is required, as triggers the next route when patrolling fo +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -9814,7 +9890,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_BAI_ZONE:GetState()

- +

Get current state.

@@ -9822,6 +9898,17 @@ Note that this method is required, as triggers the next route when patrolling fo +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -9841,6 +9928,17 @@ Note that this method is required, as triggers the next route when patrolling fo

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -9867,7 +9965,7 @@ Note that this method is required, as triggers the next route when patrolling fo
- +

Transitions.

@@ -9879,10 +9977,10 @@ Note that this method is required, as triggers the next route when patrolling fo
- +

Check if FSM is in state.

@@ -9890,15 +9988,31 @@ Note that this method is required, as triggers the next route when patrolling fo -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -9912,7 +10026,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_BAI_ZONE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -9924,11 +10038,14 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -10055,7 +10172,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_BAI_ZONE:_add_to_map(Map, Event)

- +

Add to map.

@@ -10067,21 +10184,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -10095,7 +10218,7 @@ Note that this method is required, as triggers the next route when patrolling fo

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

- +

Call handler.

@@ -10107,43 +10230,65 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -10155,7 +10300,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_BAI_ZONE:_create_transition(EventName)

- +

Create transition.

@@ -10167,13 +10312,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -10185,7 +10344,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_BAI_ZONE:_delayed_transition(EventName)

- +

Delayed transition.

@@ -10197,13 +10356,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -10215,7 +10388,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_BAI_ZONE:_eventmap(Events, EventStructure)

- +

Event map.

@@ -10227,21 +10400,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -10255,7 +10434,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_BAI_ZONE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -10267,23 +10446,40 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -10295,7 +10491,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_BAI_ZONE:_handler(EventName, ...)

- +

Handler.

@@ -10307,11 +10503,14 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string EventName

-

+ +

Event name.

+
@@ -10321,7 +10520,9 @@ Note that this method is required, as triggers the next route when patrolling fo

-

+ +

Arguments.

+
@@ -10335,7 +10536,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_BAI_ZONE:_isendstate(Current)

- +

Is end state.

@@ -10347,13 +10548,35 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -10365,7 +10588,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_BAI_ZONE:_submap(subs, sub, name)

- +

Sub maps.

@@ -10377,31 +10600,40 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -10415,7 +10647,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_BAI_ZONE:can(e)

- +

Check if can do an event.

@@ -10427,13 +10659,35 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -10445,7 +10699,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_BAI_ZONE:cannot(e)

- +

Check if cannot do an event.

@@ -10457,13 +10711,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -10472,10 +10740,10 @@ Note that this method is required, as triggers the next route when patrolling fo
- +

Check if FSM is in state.

@@ -10483,7 +10751,33 @@ Note that this method is required, as triggers the next route when patrolling fo -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/AI.AI_Balancer.html b/Documentation/AI.AI_Balancer.html index a6cdc1f9f..9f3a27c62 100644 --- a/Documentation/AI.AI_Balancer.html +++ b/Documentation/AI.AI_Balancer.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1625,7 +1658,13 @@ otherwise the AI_BALANCER will trigger a Destroy event, and the

AI_BALANCER.CallScheduler

- +

Call scheduler.

+ + + +

AI_BALANCER.ClassName

+ +

Name of the class.

@@ -1637,7 +1676,7 @@ otherwise the AI_BALANCER will trigger a Destroy event, and the

AI_BALANCER:GetCurrentState()

- +

Get current state.

@@ -1659,7 +1698,7 @@ otherwise the AI_BALANCER will trigger a Destroy event, and the -

AI_BALANCER:GetScores()

+

AI_BALANCER:GetScores(Scores)

Returns a table with the scores defined.

@@ -1673,7 +1712,7 @@ otherwise the AI_BALANCER will trigger a Destroy event, and the

AI_BALANCER:GetState()

- +

Get current state.

@@ -1689,15 +1728,15 @@ otherwise the AI_BALANCER will trigger a Destroy event, and the -

AI_BALANCER:Is(State)

+

AI_BALANCER:Is(State, If)

- +

Check if FSM is in state.

AI_BALANCER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1709,7 +1748,7 @@ otherwise the AI_BALANCER will trigger a Destroy event, and the

AI_BALANCER.Scores

- +

Scores.

@@ -1763,73 +1802,73 @@ otherwise the AI_BALANCER will trigger a Destroy event, and the

AI_BALANCER:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_BALANCER:_create_transition(EventName)

- +

Create transition.

AI_BALANCER:_delayed_transition(EventName)

- +

Delayed transition.

AI_BALANCER:_eventmap(Events, EventStructure)

- +

Event map.

AI_BALANCER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_BALANCER:_handler(EventName, ...)

- +

Handler.

AI_BALANCER:_isendstate(Current)

- +

Is end state.

AI_BALANCER:_submap(subs, sub, name)

- +

Sub maps.

AI_BALANCER:can(e)

- +

Check if can do an event.

AI_BALANCER:cannot(e)

- +

Check if cannot do an event.

AI_BALANCER.current

- +

Current state name.

@@ -1839,21 +1878,21 @@ otherwise the AI_BALANCER will trigger a Destroy event, and the -

AI_BALANCER:is(state)

+

AI_BALANCER:is(State, If, state)

- +

Check if FSM is in state.

AI_BALANCER.options

- +

Options.

AI_BALANCER.subs

- +

Subs.

@@ -3309,11 +3348,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string State

-

+ +

The FSM state.

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

AI_BALANCER:GetCurrentState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

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

Sub processes.

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

Returns a table with the scores defined.

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

Parameter:

+
+
+

+ #table + Scores +

+
+
+

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

AI_BALANCER:GetState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

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

Transitions.

@@ -3860,10 +3958,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

@@ -3871,15 +3969,31 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

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

AI_BALANCER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -3905,11 +4019,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table CallBackTable

-

+ +

Table of call backs.

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

AI_BALANCER:_add_to_map(Map, Event)

- +

Add to map.

@@ -4048,21 +4165,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

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

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

- +

Call handler.

@@ -4088,43 +4211,65 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

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

AI_BALANCER:_create_transition(EventName)

- +

Create transition.

@@ -4148,13 +4293,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

AI_BALANCER:_delayed_transition(EventName)

- +

Delayed transition.

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

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

AI_BALANCER:_eventmap(Events, EventStructure)

- +

Event map.

@@ -4208,21 +4381,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

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

AI_BALANCER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -4248,23 +4427,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

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

AI_BALANCER:_handler(EventName, ...)

- +

Handler.

@@ -4288,11 +4484,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

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

-

+ +

Arguments.

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

AI_BALANCER:_isendstate(Current)

- +

Is end state.

@@ -4328,13 +4529,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

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

AI_BALANCER:_submap(subs, sub, name)

- +

Sub maps.

@@ -4358,31 +4581,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

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

AI_BALANCER:can(e)

- +

Check if can do an event.

@@ -4408,13 +4640,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

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

AI_BALANCER:cannot(e)

- +

Check if cannot do an event.

@@ -4438,13 +4692,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -4453,10 +4721,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

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

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/AI.AI_Cap.html b/Documentation/AI.AI_Cap.html index 3c19f31da..a06ef2b5b 100644 --- a/Documentation/AI.AI_Cap.html +++ b/Documentation/AI.AI_Cap.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2312,7 +2345,13 @@ Use the method AI.AI_Cap#A

AI_CAP_ZONE.CallScheduler

- +

Call scheduler.

+ + + +

AI_CAP_ZONE.ClassName

+ +

Name of the class.

@@ -2324,7 +2363,7 @@ Use the method AI.AI_Cap#A

AI_CAP_ZONE:GetCurrentState()

- +

Get current state.

@@ -2346,7 +2385,7 @@ Use the method AI.AI_Cap#A -

AI_CAP_ZONE:GetScores()

+

AI_CAP_ZONE:GetScores(Scores)

Returns a table with the scores defined.

@@ -2360,7 +2399,7 @@ Use the method AI.AI_Cap#A

AI_CAP_ZONE:GetState()

- +

Get current state.

@@ -2376,15 +2415,15 @@ Use the method AI.AI_Cap#A -

AI_CAP_ZONE:Is(State)

+

AI_CAP_ZONE:Is(State, If)

- +

Check if FSM is in state.

AI_CAP_ZONE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2396,7 +2435,7 @@ Use the method AI.AI_Cap#A

AI_CAP_ZONE.Scores

- +

Scores.

@@ -2450,73 +2489,73 @@ Use the method AI.AI_Cap#A

AI_CAP_ZONE:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_CAP_ZONE:_create_transition(EventName)

- +

Create transition.

AI_CAP_ZONE:_delayed_transition(EventName)

- +

Delayed transition.

AI_CAP_ZONE:_eventmap(Events, EventStructure)

- +

Event map.

AI_CAP_ZONE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_CAP_ZONE:_handler(EventName, ...)

- +

Handler.

AI_CAP_ZONE:_isendstate(Current)

- +

Is end state.

AI_CAP_ZONE:_submap(subs, sub, name)

- +

Sub maps.

AI_CAP_ZONE:can(e)

- +

Check if can do an event.

AI_CAP_ZONE:cannot(e)

- +

Check if cannot do an event.

AI_CAP_ZONE.current

- +

Current state name.

@@ -2526,21 +2565,21 @@ Use the method AI.AI_Cap#A -

AI_CAP_ZONE:is(state)

+

AI_CAP_ZONE:is(State, If, state)

- +

Check if FSM is in state.

AI_CAP_ZONE.options

- +

Options.

AI_CAP_ZONE.subs

- +

Subs.

@@ -8939,11 +8978,14 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string State

-

+ +

The FSM state.

+
@@ -9268,7 +9310,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAP_ZONE:GetCurrentState()

- +

Get current state.

@@ -9276,6 +9318,17 @@ Note that this method is required, as triggers the next route when patrolling fo +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -9295,6 +9348,17 @@ Note that this method is required, as triggers the next route when patrolling fo

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -9361,7 +9425,7 @@ Note that this method is required, as triggers the next route when patrolling fo
- +

Sub processes.

@@ -9373,7 +9437,7 @@ Note that this method is required, as triggers the next route when patrolling fo

Returns a table with the scores defined.

@@ -9384,6 +9448,18 @@ Note that this method is required, as triggers the next route when patrolling fo +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -9425,7 +9501,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAP_ZONE:GetState()

- +

Get current state.

@@ -9433,6 +9509,17 @@ Note that this method is required, as triggers the next route when patrolling fo +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -9452,6 +9539,17 @@ Note that this method is required, as triggers the next route when patrolling fo

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -9478,7 +9576,7 @@ Note that this method is required, as triggers the next route when patrolling fo
- +

Transitions.

@@ -9490,10 +9588,10 @@ Note that this method is required, as triggers the next route when patrolling fo
- +

Check if FSM is in state.

@@ -9501,15 +9599,31 @@ Note that this method is required, as triggers the next route when patrolling fo -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -9523,7 +9637,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAP_ZONE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -9535,11 +9649,14 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -9666,7 +9783,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAP_ZONE:_add_to_map(Map, Event)

- +

Add to map.

@@ -9678,21 +9795,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -9706,7 +9829,7 @@ Note that this method is required, as triggers the next route when patrolling fo

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

- +

Call handler.

@@ -9718,43 +9841,65 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -9766,7 +9911,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAP_ZONE:_create_transition(EventName)

- +

Create transition.

@@ -9778,13 +9923,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -9796,7 +9955,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAP_ZONE:_delayed_transition(EventName)

- +

Delayed transition.

@@ -9808,13 +9967,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -9826,7 +9999,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAP_ZONE:_eventmap(Events, EventStructure)

- +

Event map.

@@ -9838,21 +10011,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -9866,7 +10045,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAP_ZONE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -9878,23 +10057,40 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -9906,7 +10102,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAP_ZONE:_handler(EventName, ...)

- +

Handler.

@@ -9918,11 +10114,14 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string EventName

-

+ +

Event name.

+
@@ -9932,7 +10131,9 @@ Note that this method is required, as triggers the next route when patrolling fo

-

+ +

Arguments.

+
@@ -9946,7 +10147,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAP_ZONE:_isendstate(Current)

- +

Is end state.

@@ -9958,13 +10159,35 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -9976,7 +10199,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAP_ZONE:_submap(subs, sub, name)

- +

Sub maps.

@@ -9988,31 +10211,40 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -10026,7 +10258,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAP_ZONE:can(e)

- +

Check if can do an event.

@@ -10038,13 +10270,35 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -10056,7 +10310,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAP_ZONE:cannot(e)

- +

Check if cannot do an event.

@@ -10068,13 +10322,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -10083,10 +10351,10 @@ Note that this method is required, as triggers the next route when patrolling fo
- +

Check if FSM is in state.

@@ -10094,7 +10362,33 @@ Note that this method is required, as triggers the next route when patrolling fo -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index 9ce16edaa..25817e95e 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1677,7 +1710,13 @@ Please consult the Cargo.Cargo module for more in

AI_CARGO.CallScheduler

- +

Call scheduler.

+ + + +

AI_CARGO.ClassName

+ +

Name of the class.

@@ -1689,7 +1728,7 @@ Please consult the Cargo.Cargo module for more in

AI_CARGO:GetCurrentState()

- +

Get current state.

@@ -1711,7 +1750,7 @@ Please consult the Cargo.Cargo module for more in -

AI_CARGO:GetScores()

+

AI_CARGO:GetScores(Scores)

Returns a table with the scores defined.

@@ -1725,7 +1764,7 @@ Please consult the Cargo.Cargo module for more in

AI_CARGO:GetState()

- +

Get current state.

@@ -1741,15 +1780,15 @@ Please consult the Cargo.Cargo module for more in -

AI_CARGO:Is(State)

+

AI_CARGO:Is(State, If)

- +

Check if FSM is in state.

AI_CARGO:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1761,7 +1800,7 @@ Please consult the Cargo.Cargo module for more in

AI_CARGO.Scores

- +

Scores.

@@ -1815,73 +1854,73 @@ Please consult the Cargo.Cargo module for more in

AI_CARGO:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_CARGO:_create_transition(EventName)

- +

Create transition.

AI_CARGO:_delayed_transition(EventName)

- +

Delayed transition.

AI_CARGO:_eventmap(Events, EventStructure)

- +

Event map.

AI_CARGO:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_CARGO:_handler(EventName, ...)

- +

Handler.

AI_CARGO:_isendstate(Current)

- +

Is end state.

AI_CARGO:_submap(subs, sub, name)

- +

Sub maps.

AI_CARGO:can(e)

- +

Check if can do an event.

AI_CARGO:cannot(e)

- +

Check if cannot do an event.

AI_CARGO.current

- +

Current state name.

@@ -1891,21 +1930,21 @@ Please consult the Cargo.Cargo module for more in -

AI_CARGO:is(state)

+

AI_CARGO:is(State, If, state)

- +

Check if FSM is in state.

AI_CARGO.options

- +

Options.

AI_CARGO.subs

- +

Subs.

@@ -5135,11 +5174,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string State

-

+ +

The FSM state.

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

AI_CARGO:GetCurrentState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

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

Sub processes.

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

Returns a table with the scores defined.

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

Parameter:

+
+
+

+ #table + Scores +

+
+
+

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

AI_CARGO:GetState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

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

Transitions.

@@ -5686,10 +5784,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

@@ -5697,15 +5795,31 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

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

AI_CARGO:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -5731,11 +5845,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table CallBackTable

-

+ +

Table of call backs.

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

AI_CARGO:_add_to_map(Map, Event)

- +

Add to map.

@@ -5874,21 +5991,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

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

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

- +

Call handler.

@@ -5914,43 +6037,65 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

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

AI_CARGO:_create_transition(EventName)

- +

Create transition.

@@ -5974,13 +6119,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

AI_CARGO:_delayed_transition(EventName)

- +

Delayed transition.

@@ -6004,13 +6163,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

AI_CARGO:_eventmap(Events, EventStructure)

- +

Event map.

@@ -6034,21 +6207,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

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

AI_CARGO:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -6074,23 +6253,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

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

AI_CARGO:_handler(EventName, ...)

- +

Handler.

@@ -6114,11 +6310,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

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

-

+ +

Arguments.

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

AI_CARGO:_isendstate(Current)

- +

Is end state.

@@ -6154,13 +6355,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

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

AI_CARGO:_submap(subs, sub, name)

- +

Sub maps.

@@ -6184,31 +6407,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

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

AI_CARGO:can(e)

- +

Check if can do an event.

@@ -6234,13 +6466,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

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

AI_CARGO:cannot(e)

- +

Check if cannot do an event.

@@ -6264,13 +6518,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -6279,10 +6547,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

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

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/AI.AI_Cargo_APC.html b/Documentation/AI.AI_Cargo_APC.html index cf402280a..3ef6884fe 100644 --- a/Documentation/AI.AI_Cargo_APC.html +++ b/Documentation/AI.AI_Cargo_APC.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1873,7 +1906,13 @@ The APCs will follow nearby roads as much as possible, to ensure fast and clean

AI_CARGO_APC.CallScheduler

- +

Call scheduler.

+ + + +

AI_CARGO_APC.ClassName

+ +

Name of the class.

@@ -1885,7 +1924,7 @@ The APCs will follow nearby roads as much as possible, to ensure fast and clean

AI_CARGO_APC:GetCurrentState()

- +

Get current state.

@@ -1907,7 +1946,7 @@ The APCs will follow nearby roads as much as possible, to ensure fast and clean -

AI_CARGO_APC:GetScores()

+

AI_CARGO_APC:GetScores(Scores)

Returns a table with the scores defined.

@@ -1921,7 +1960,7 @@ The APCs will follow nearby roads as much as possible, to ensure fast and clean

AI_CARGO_APC:GetState()

- +

Get current state.

@@ -1937,15 +1976,15 @@ The APCs will follow nearby roads as much as possible, to ensure fast and clean -

AI_CARGO_APC:Is(State)

+

AI_CARGO_APC:Is(State, If)

- +

Check if FSM is in state.

AI_CARGO_APC:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1957,7 +1996,7 @@ The APCs will follow nearby roads as much as possible, to ensure fast and clean

AI_CARGO_APC.Scores

- +

Scores.

@@ -2011,73 +2050,73 @@ The APCs will follow nearby roads as much as possible, to ensure fast and clean

AI_CARGO_APC:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_CARGO_APC:_create_transition(EventName)

- +

Create transition.

AI_CARGO_APC:_delayed_transition(EventName)

- +

Delayed transition.

AI_CARGO_APC:_eventmap(Events, EventStructure)

- +

Event map.

AI_CARGO_APC:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_CARGO_APC:_handler(EventName, ...)

- +

Handler.

AI_CARGO_APC:_isendstate(Current)

- +

Is end state.

AI_CARGO_APC:_submap(subs, sub, name)

- +

Sub maps.

AI_CARGO_APC:can(e)

- +

Check if can do an event.

AI_CARGO_APC:cannot(e)

- +

Check if cannot do an event.

AI_CARGO_APC.current

- +

Current state name.

@@ -2087,21 +2126,21 @@ The APCs will follow nearby roads as much as possible, to ensure fast and clean -

AI_CARGO_APC:is(state)

+

AI_CARGO_APC:is(State, If, state)

- +

Check if FSM is in state.

AI_CARGO_APC.options

- +

Options.

AI_CARGO_APC.subs

- +

Subs.

@@ -6659,11 +6698,14 @@ AICargoAPC:SetCombatRadius( false )

+ #string State

-

+ +

The FSM state.

+
@@ -6988,7 +7030,7 @@ AICargoAPC:SetCombatRadius( false )

AI_CARGO_APC:GetCurrentState()

- +

Get current state.

@@ -6996,6 +7038,17 @@ AICargoAPC:SetCombatRadius( false ) +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -7015,6 +7068,17 @@ AICargoAPC:SetCombatRadius( false )

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -7081,7 +7145,7 @@ AICargoAPC:SetCombatRadius( false )
- +

Sub processes.

@@ -7093,7 +7157,7 @@ AICargoAPC:SetCombatRadius( false )

Returns a table with the scores defined.

@@ -7104,6 +7168,18 @@ AICargoAPC:SetCombatRadius( false ) +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -7145,7 +7221,7 @@ AICargoAPC:SetCombatRadius( false )

AI_CARGO_APC:GetState()

- +

Get current state.

@@ -7153,6 +7229,17 @@ AICargoAPC:SetCombatRadius( false ) +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -7172,6 +7259,17 @@ AICargoAPC:SetCombatRadius( false )

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -7198,7 +7296,7 @@ AICargoAPC:SetCombatRadius( false )
- +

Transitions.

@@ -7210,10 +7308,10 @@ AICargoAPC:SetCombatRadius( false )
- +

Check if FSM is in state.

@@ -7221,15 +7319,31 @@ AICargoAPC:SetCombatRadius( false ) -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -7243,7 +7357,7 @@ AICargoAPC:SetCombatRadius( false )

AI_CARGO_APC:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -7255,11 +7369,14 @@ AICargoAPC:SetCombatRadius( false )

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -7386,7 +7503,7 @@ AICargoAPC:SetCombatRadius( false )

AI_CARGO_APC:_add_to_map(Map, Event)

- +

Add to map.

@@ -7398,21 +7515,27 @@ AICargoAPC:SetCombatRadius( false )

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -7426,7 +7549,7 @@ AICargoAPC:SetCombatRadius( false )

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

- +

Call handler.

@@ -7438,43 +7561,65 @@ AICargoAPC:SetCombatRadius( false )

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -7486,7 +7631,7 @@ AICargoAPC:SetCombatRadius( false )

AI_CARGO_APC:_create_transition(EventName)

- +

Create transition.

@@ -7498,13 +7643,27 @@ AICargoAPC:SetCombatRadius( false )

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -7516,7 +7675,7 @@ AICargoAPC:SetCombatRadius( false )

AI_CARGO_APC:_delayed_transition(EventName)

- +

Delayed transition.

@@ -7528,13 +7687,27 @@ AICargoAPC:SetCombatRadius( false )

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -7546,7 +7719,7 @@ AICargoAPC:SetCombatRadius( false )

AI_CARGO_APC:_eventmap(Events, EventStructure)

- +

Event map.

@@ -7558,21 +7731,27 @@ AICargoAPC:SetCombatRadius( false )

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -7586,7 +7765,7 @@ AICargoAPC:SetCombatRadius( false )

AI_CARGO_APC:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -7598,23 +7777,40 @@ AICargoAPC:SetCombatRadius( false )

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -7626,7 +7822,7 @@ AICargoAPC:SetCombatRadius( false )

AI_CARGO_APC:_handler(EventName, ...)

- +

Handler.

@@ -7638,11 +7834,14 @@ AICargoAPC:SetCombatRadius( false )

+ #string EventName

-

+ +

Event name.

+
@@ -7652,7 +7851,9 @@ AICargoAPC:SetCombatRadius( false )

-

+ +

Arguments.

+
@@ -7666,7 +7867,7 @@ AICargoAPC:SetCombatRadius( false )

AI_CARGO_APC:_isendstate(Current)

- +

Is end state.

@@ -7678,13 +7879,35 @@ AICargoAPC:SetCombatRadius( false )

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -7696,7 +7919,7 @@ AICargoAPC:SetCombatRadius( false )

AI_CARGO_APC:_submap(subs, sub, name)

- +

Sub maps.

@@ -7708,31 +7931,40 @@ AICargoAPC:SetCombatRadius( false )

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -7746,7 +7978,7 @@ AICargoAPC:SetCombatRadius( false )

AI_CARGO_APC:can(e)

- +

Check if can do an event.

@@ -7758,13 +7990,35 @@ AICargoAPC:SetCombatRadius( false )

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -7776,7 +8030,7 @@ AICargoAPC:SetCombatRadius( false )

AI_CARGO_APC:cannot(e)

- +

Check if cannot do an event.

@@ -7788,13 +8042,27 @@ AICargoAPC:SetCombatRadius( false )

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -7803,10 +8071,10 @@ AICargoAPC:SetCombatRadius( false )
- +

Check if FSM is in state.

@@ -7814,7 +8082,33 @@ AICargoAPC:SetCombatRadius( false ) -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index 736a04973..68a940c9d 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1667,7 +1700,13 @@ time is not so much of an issue ...

AI_CARGO_AIRPLANE.CallScheduler

- +

Call scheduler.

+ + + +

AI_CARGO_AIRPLANE.ClassName

+ +

Name of the class.

@@ -1679,7 +1718,7 @@ time is not so much of an issue ...

AI_CARGO_AIRPLANE:GetCurrentState()

- +

Get current state.

@@ -1701,7 +1740,7 @@ time is not so much of an issue ...

-

AI_CARGO_AIRPLANE:GetScores()

+

AI_CARGO_AIRPLANE:GetScores(Scores)

Returns a table with the scores defined.

@@ -1715,7 +1754,7 @@ time is not so much of an issue ...

AI_CARGO_AIRPLANE:GetState()

- +

Get current state.

@@ -1731,15 +1770,15 @@ time is not so much of an issue ...

-

AI_CARGO_AIRPLANE:Is(State)

+

AI_CARGO_AIRPLANE:Is(State, If)

- +

Check if FSM is in state.

AI_CARGO_AIRPLANE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1751,7 +1790,7 @@ time is not so much of an issue ...

AI_CARGO_AIRPLANE.Scores

- +

Scores.

@@ -1805,73 +1844,73 @@ time is not so much of an issue ...

AI_CARGO_AIRPLANE:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_CARGO_AIRPLANE:_create_transition(EventName)

- +

Create transition.

AI_CARGO_AIRPLANE:_delayed_transition(EventName)

- +

Delayed transition.

AI_CARGO_AIRPLANE:_eventmap(Events, EventStructure)

- +

Event map.

AI_CARGO_AIRPLANE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_CARGO_AIRPLANE:_handler(EventName, ...)

- +

Handler.

AI_CARGO_AIRPLANE:_isendstate(Current)

- +

Is end state.

AI_CARGO_AIRPLANE:_submap(subs, sub, name)

- +

Sub maps.

AI_CARGO_AIRPLANE:can(e)

- +

Check if can do an event.

AI_CARGO_AIRPLANE:cannot(e)

- +

Check if cannot do an event.

AI_CARGO_AIRPLANE.current

- +

Current state name.

@@ -1881,21 +1920,21 @@ time is not so much of an issue ...

-

AI_CARGO_AIRPLANE:is(state)

+

AI_CARGO_AIRPLANE:is(State, If, state)

- +

Check if FSM is in state.

AI_CARGO_AIRPLANE.options

- +

Options.

AI_CARGO_AIRPLANE.subs

- +

Subs.

@@ -4876,11 +4915,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string State

-

+ +

The FSM state.

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

AI_CARGO_AIRPLANE:GetCurrentState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

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

Sub processes.

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

Returns a table with the scores defined.

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

Parameter:

+
+
+

+ #table + Scores +

+
+
+

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

AI_CARGO_AIRPLANE:GetState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

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

Transitions.

@@ -5427,10 +5525,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

@@ -5438,15 +5536,31 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

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

AI_CARGO_AIRPLANE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -5472,11 +5586,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table CallBackTable

-

+ +

Table of call backs.

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

AI_CARGO_AIRPLANE:_add_to_map(Map, Event)

- +

Add to map.

@@ -5615,21 +5732,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

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

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

- +

Call handler.

@@ -5655,43 +5778,65 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

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

AI_CARGO_AIRPLANE:_create_transition(EventName)

- +

Create transition.

@@ -5715,13 +5860,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

AI_CARGO_AIRPLANE:_delayed_transition(EventName)

- +

Delayed transition.

@@ -5745,13 +5904,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

AI_CARGO_AIRPLANE:_eventmap(Events, EventStructure)

- +

Event map.

@@ -5775,21 +5948,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

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

AI_CARGO_AIRPLANE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -5815,23 +5994,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

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

AI_CARGO_AIRPLANE:_handler(EventName, ...)

- +

Handler.

@@ -5855,11 +6051,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

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

-

+ +

Arguments.

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

AI_CARGO_AIRPLANE:_isendstate(Current)

- +

Is end state.

@@ -5895,13 +6096,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

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

AI_CARGO_AIRPLANE:_submap(subs, sub, name)

- +

Sub maps.

@@ -5925,31 +6148,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

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

AI_CARGO_AIRPLANE:can(e)

- +

Check if can do an event.

@@ -5975,13 +6207,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

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

AI_CARGO_AIRPLANE:cannot(e)

- +

Check if cannot do an event.

@@ -6005,13 +6259,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -6020,10 +6288,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

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

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/AI.AI_Cargo_Dispatcher.html b/Documentation/AI.AI_Cargo_Dispatcher.html index 485b80ec8..13924f5d2 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher.html +++ b/Documentation/AI.AI_Cargo_Dispatcher.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2282,7 +2315,13 @@ Use AI_CARGO_DISPATCHER.SetHomeZon

AI_CARGO_DISPATCHER.CallScheduler

- +

Call scheduler.

+ + + +

AI_CARGO_DISPATCHER.ClassName

+ +

Name of the class.

@@ -2294,7 +2333,7 @@ Use AI_CARGO_DISPATCHER.SetHomeZon

AI_CARGO_DISPATCHER:GetCurrentState()

- +

Get current state.

@@ -2316,7 +2355,7 @@ Use AI_CARGO_DISPATCHER.SetHomeZon -

AI_CARGO_DISPATCHER:GetScores()

+

AI_CARGO_DISPATCHER:GetScores(Scores)

Returns a table with the scores defined.

@@ -2330,7 +2369,7 @@ Use AI_CARGO_DISPATCHER.SetHomeZon

AI_CARGO_DISPATCHER:GetState()

- +

Get current state.

@@ -2346,15 +2385,15 @@ Use AI_CARGO_DISPATCHER.SetHomeZon -

AI_CARGO_DISPATCHER:Is(State)

+

AI_CARGO_DISPATCHER:Is(State, If)

- +

Check if FSM is in state.

AI_CARGO_DISPATCHER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2366,7 +2405,7 @@ Use AI_CARGO_DISPATCHER.SetHomeZon

AI_CARGO_DISPATCHER.Scores

- +

Scores.

@@ -2420,73 +2459,73 @@ Use AI_CARGO_DISPATCHER.SetHomeZon

AI_CARGO_DISPATCHER:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_CARGO_DISPATCHER:_create_transition(EventName)

- +

Create transition.

AI_CARGO_DISPATCHER:_delayed_transition(EventName)

- +

Delayed transition.

AI_CARGO_DISPATCHER:_eventmap(Events, EventStructure)

- +

Event map.

AI_CARGO_DISPATCHER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_CARGO_DISPATCHER:_handler(EventName, ...)

- +

Handler.

AI_CARGO_DISPATCHER:_isendstate(Current)

- +

Is end state.

AI_CARGO_DISPATCHER:_submap(subs, sub, name)

- +

Sub maps.

AI_CARGO_DISPATCHER:can(e)

- +

Check if can do an event.

AI_CARGO_DISPATCHER:cannot(e)

- +

Check if cannot do an event.

AI_CARGO_DISPATCHER.current

- +

Current state name.

@@ -2496,21 +2535,21 @@ Use AI_CARGO_DISPATCHER.SetHomeZon -

AI_CARGO_DISPATCHER:is(state)

+

AI_CARGO_DISPATCHER:is(State, If, state)

- +

Check if FSM is in state.

AI_CARGO_DISPATCHER.options

- +

Options.

AI_CARGO_DISPATCHER.subs

- +

Subs.

@@ -5663,11 +5702,14 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string State

-

+ +

The FSM state.

+
@@ -5992,7 +6034,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER:GetCurrentState()

- +

Get current state.

@@ -6000,6 +6042,17 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -6019,6 +6072,17 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -6085,7 +6149,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
- +

Sub processes.

@@ -6097,7 +6161,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

Returns a table with the scores defined.

@@ -6108,6 +6172,18 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -6149,7 +6225,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER:GetState()

- +

Get current state.

@@ -6157,6 +6233,17 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -6176,6 +6263,17 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -6202,7 +6300,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
- +

Transitions.

@@ -6214,10 +6312,10 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
- +

Check if FSM is in state.

@@ -6225,15 +6323,31 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -6247,7 +6361,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -6259,11 +6373,14 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -6390,7 +6507,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER:_add_to_map(Map, Event)

- +

Add to map.

@@ -6402,21 +6519,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -6430,7 +6553,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

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

- +

Call handler.

@@ -6442,43 +6565,65 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -6490,7 +6635,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER:_create_transition(EventName)

- +

Create transition.

@@ -6502,13 +6647,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -6520,7 +6679,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER:_delayed_transition(EventName)

- +

Delayed transition.

@@ -6532,13 +6691,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -6550,7 +6723,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER:_eventmap(Events, EventStructure)

- +

Event map.

@@ -6562,21 +6735,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -6590,7 +6769,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -6602,23 +6781,40 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -6630,7 +6826,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER:_handler(EventName, ...)

- +

Handler.

@@ -6642,11 +6838,14 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string EventName

-

+ +

Event name.

+
@@ -6656,7 +6855,9 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

-

+ +

Arguments.

+
@@ -6670,7 +6871,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER:_isendstate(Current)

- +

Is end state.

@@ -6682,13 +6883,35 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -6700,7 +6923,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER:_submap(subs, sub, name)

- +

Sub maps.

@@ -6712,31 +6935,40 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -6750,7 +6982,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER:can(e)

- +

Check if can do an event.

@@ -6762,13 +6994,35 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -6780,7 +7034,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER:cannot(e)

- +

Check if cannot do an event.

@@ -6792,13 +7046,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -6807,10 +7075,10 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
- +

Check if FSM is in state.

@@ -6818,7 +7086,33 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_APC.html b/Documentation/AI.AI_Cargo_Dispatcher_APC.html index 7943c33aa..497a6e1eb 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_APC.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_APC.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1881,7 +1914,13 @@ Use AI_CARGO_DISPATCHER_APC.Se

AI_CARGO_DISPATCHER_APC.CallScheduler

- +

Call scheduler.

+ + + +

AI_CARGO_DISPATCHER_APC.ClassName

+ +

Name of the class.

@@ -1893,7 +1932,7 @@ Use AI_CARGO_DISPATCHER_APC.Se

AI_CARGO_DISPATCHER_APC:GetCurrentState()

- +

Get current state.

@@ -1915,7 +1954,7 @@ Use AI_CARGO_DISPATCHER_APC.Se -

AI_CARGO_DISPATCHER_APC:GetScores()

+

AI_CARGO_DISPATCHER_APC:GetScores(Scores)

Returns a table with the scores defined.

@@ -1929,7 +1968,7 @@ Use AI_CARGO_DISPATCHER_APC.Se

AI_CARGO_DISPATCHER_APC:GetState()

- +

Get current state.

@@ -1945,15 +1984,15 @@ Use AI_CARGO_DISPATCHER_APC.Se -

AI_CARGO_DISPATCHER_APC:Is(State)

+

AI_CARGO_DISPATCHER_APC:Is(State, If)

- +

Check if FSM is in state.

AI_CARGO_DISPATCHER_APC:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1965,7 +2004,7 @@ Use AI_CARGO_DISPATCHER_APC.Se

AI_CARGO_DISPATCHER_APC.Scores

- +

Scores.

@@ -2019,73 +2058,73 @@ Use AI_CARGO_DISPATCHER_APC.Se

AI_CARGO_DISPATCHER_APC:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_CARGO_DISPATCHER_APC:_create_transition(EventName)

- +

Create transition.

AI_CARGO_DISPATCHER_APC:_delayed_transition(EventName)

- +

Delayed transition.

AI_CARGO_DISPATCHER_APC:_eventmap(Events, EventStructure)

- +

Event map.

AI_CARGO_DISPATCHER_APC:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_CARGO_DISPATCHER_APC:_handler(EventName, ...)

- +

Handler.

AI_CARGO_DISPATCHER_APC:_isendstate(Current)

- +

Is end state.

AI_CARGO_DISPATCHER_APC:_submap(subs, sub, name)

- +

Sub maps.

AI_CARGO_DISPATCHER_APC:can(e)

- +

Check if can do an event.

AI_CARGO_DISPATCHER_APC:cannot(e)

- +

Check if cannot do an event.

AI_CARGO_DISPATCHER_APC.current

- +

Current state name.

@@ -2095,21 +2134,21 @@ Use AI_CARGO_DISPATCHER_APC.Se -

AI_CARGO_DISPATCHER_APC:is(state)

+

AI_CARGO_DISPATCHER_APC:is(State, If, state)

- +

Check if FSM is in state.

AI_CARGO_DISPATCHER_APC.options

- +

Options.

AI_CARGO_DISPATCHER_APC.subs

- +

Subs.

@@ -4967,11 +5006,14 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string State

-

+ +

The FSM state.

+
@@ -5296,7 +5338,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_APC:GetCurrentState()

- +

Get current state.

@@ -5304,6 +5346,17 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -5323,6 +5376,17 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -5389,7 +5453,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
- +

Sub processes.

@@ -5401,7 +5465,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

Returns a table with the scores defined.

@@ -5412,6 +5476,18 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -5453,7 +5529,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_APC:GetState()

- +

Get current state.

@@ -5461,6 +5537,17 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -5480,6 +5567,17 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -5506,7 +5604,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
- +

Transitions.

@@ -5518,10 +5616,10 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
- +

Check if FSM is in state.

@@ -5529,15 +5627,31 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -5551,7 +5665,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_APC:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -5563,11 +5677,14 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -5694,7 +5811,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_APC:_add_to_map(Map, Event)

- +

Add to map.

@@ -5706,21 +5823,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -5734,7 +5857,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

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

- +

Call handler.

@@ -5746,43 +5869,65 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -5794,7 +5939,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_APC:_create_transition(EventName)

- +

Create transition.

@@ -5806,13 +5951,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -5824,7 +5983,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_APC:_delayed_transition(EventName)

- +

Delayed transition.

@@ -5836,13 +5995,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -5854,7 +6027,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_APC:_eventmap(Events, EventStructure)

- +

Event map.

@@ -5866,21 +6039,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -5894,7 +6073,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_APC:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -5906,23 +6085,40 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -5934,7 +6130,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_APC:_handler(EventName, ...)

- +

Handler.

@@ -5946,11 +6142,14 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string EventName

-

+ +

Event name.

+
@@ -5960,7 +6159,9 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

-

+ +

Arguments.

+
@@ -5974,7 +6175,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_APC:_isendstate(Current)

- +

Is end state.

@@ -5986,13 +6187,35 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -6004,7 +6227,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_APC:_submap(subs, sub, name)

- +

Sub maps.

@@ -6016,31 +6239,40 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -6054,7 +6286,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_APC:can(e)

- +

Check if can do an event.

@@ -6066,13 +6298,35 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -6084,7 +6338,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_APC:cannot(e)

- +

Check if cannot do an event.

@@ -6096,13 +6350,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -6111,10 +6379,10 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
- +

Check if FSM is in state.

@@ -6122,7 +6390,33 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html b/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html index 9c88dc043..60b170a31 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1834,7 +1867,13 @@ Check out the AI.AI

AI_CARGO_DISPATCHER_AIRPLANE.CallScheduler

- +

Call scheduler.

+ + + +

AI_CARGO_DISPATCHER_AIRPLANE.ClassName

+ +

Name of the class.

@@ -1846,7 +1885,7 @@ Check out the AI.AI

AI_CARGO_DISPATCHER_AIRPLANE:GetCurrentState()

- +

Get current state.

@@ -1868,7 +1907,7 @@ Check out the AI.AI -

AI_CARGO_DISPATCHER_AIRPLANE:GetScores()

+

AI_CARGO_DISPATCHER_AIRPLANE:GetScores(Scores)

Returns a table with the scores defined.

@@ -1882,7 +1921,7 @@ Check out the AI.AI

AI_CARGO_DISPATCHER_AIRPLANE:GetState()

- +

Get current state.

@@ -1898,15 +1937,15 @@ Check out the AI.AI -

AI_CARGO_DISPATCHER_AIRPLANE:Is(State)

+

AI_CARGO_DISPATCHER_AIRPLANE:Is(State, If)

- +

Check if FSM is in state.

AI_CARGO_DISPATCHER_AIRPLANE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1918,7 +1957,7 @@ Check out the AI.AI

AI_CARGO_DISPATCHER_AIRPLANE.Scores

- +

Scores.

@@ -1972,73 +2011,73 @@ Check out the AI.AI

AI_CARGO_DISPATCHER_AIRPLANE:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_CARGO_DISPATCHER_AIRPLANE:_create_transition(EventName)

- +

Create transition.

AI_CARGO_DISPATCHER_AIRPLANE:_delayed_transition(EventName)

- +

Delayed transition.

AI_CARGO_DISPATCHER_AIRPLANE:_eventmap(Events, EventStructure)

- +

Event map.

AI_CARGO_DISPATCHER_AIRPLANE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_CARGO_DISPATCHER_AIRPLANE:_handler(EventName, ...)

- +

Handler.

AI_CARGO_DISPATCHER_AIRPLANE:_isendstate(Current)

- +

Is end state.

AI_CARGO_DISPATCHER_AIRPLANE:_submap(subs, sub, name)

- +

Sub maps.

AI_CARGO_DISPATCHER_AIRPLANE:can(e)

- +

Check if can do an event.

AI_CARGO_DISPATCHER_AIRPLANE:cannot(e)

- +

Check if cannot do an event.

AI_CARGO_DISPATCHER_AIRPLANE.current

- +

Current state name.

@@ -2048,21 +2087,21 @@ Check out the AI.AI -

AI_CARGO_DISPATCHER_AIRPLANE:is(state)

+

AI_CARGO_DISPATCHER_AIRPLANE:is(State, If, state)

- +

Check if FSM is in state.

AI_CARGO_DISPATCHER_AIRPLANE.options

- +

Options.

AI_CARGO_DISPATCHER_AIRPLANE.subs

- +

Subs.

@@ -4857,11 +4896,14 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string State

-

+ +

The FSM state.

+
@@ -5186,7 +5228,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_AIRPLANE:GetCurrentState()

- +

Get current state.

@@ -5194,6 +5236,17 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -5213,6 +5266,17 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -5279,7 +5343,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
- +

Sub processes.

@@ -5291,7 +5355,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

Returns a table with the scores defined.

@@ -5302,6 +5366,18 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -5343,7 +5419,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_AIRPLANE:GetState()

- +

Get current state.

@@ -5351,6 +5427,17 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -5370,6 +5457,17 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -5396,7 +5494,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
- +

Transitions.

@@ -5408,10 +5506,10 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
- +

Check if FSM is in state.

@@ -5419,15 +5517,31 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -5441,7 +5555,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_AIRPLANE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -5453,11 +5567,14 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -5584,7 +5701,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_AIRPLANE:_add_to_map(Map, Event)

- +

Add to map.

@@ -5596,21 +5713,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -5624,7 +5747,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

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

- +

Call handler.

@@ -5636,43 +5759,65 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -5684,7 +5829,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_AIRPLANE:_create_transition(EventName)

- +

Create transition.

@@ -5696,13 +5841,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -5714,7 +5873,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_AIRPLANE:_delayed_transition(EventName)

- +

Delayed transition.

@@ -5726,13 +5885,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -5744,7 +5917,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_AIRPLANE:_eventmap(Events, EventStructure)

- +

Event map.

@@ -5756,21 +5929,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -5784,7 +5963,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_AIRPLANE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -5796,23 +5975,40 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -5824,7 +6020,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_AIRPLANE:_handler(EventName, ...)

- +

Handler.

@@ -5836,11 +6032,14 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string EventName

-

+ +

Event name.

+
@@ -5850,7 +6049,9 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

-

+ +

Arguments.

+
@@ -5864,7 +6065,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_AIRPLANE:_isendstate(Current)

- +

Is end state.

@@ -5876,13 +6077,35 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -5894,7 +6117,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_AIRPLANE:_submap(subs, sub, name)

- +

Sub maps.

@@ -5906,31 +6129,40 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -5944,7 +6176,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_AIRPLANE:can(e)

- +

Check if can do an event.

@@ -5956,13 +6188,35 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -5974,7 +6228,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_AIRPLANE:cannot(e)

- +

Check if cannot do an event.

@@ -5986,13 +6240,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -6001,10 +6269,10 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
- +

Check if FSM is in state.

@@ -6012,7 +6280,33 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html b/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html index f23ba86dd..7e73dae88 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1872,7 +1905,13 @@ Use AI_CARGO_DISPATCHER

AI_CARGO_DISPATCHER_HELICOPTER.CallScheduler

- +

Call scheduler.

+ + + +

AI_CARGO_DISPATCHER_HELICOPTER.ClassName

+ +

Name of the class.

@@ -1884,7 +1923,7 @@ Use AI_CARGO_DISPATCHER

AI_CARGO_DISPATCHER_HELICOPTER:GetCurrentState()

- +

Get current state.

@@ -1906,7 +1945,7 @@ Use AI_CARGO_DISPATCHER -

AI_CARGO_DISPATCHER_HELICOPTER:GetScores()

+

AI_CARGO_DISPATCHER_HELICOPTER:GetScores(Scores)

Returns a table with the scores defined.

@@ -1920,7 +1959,7 @@ Use AI_CARGO_DISPATCHER

AI_CARGO_DISPATCHER_HELICOPTER:GetState()

- +

Get current state.

@@ -1936,15 +1975,15 @@ Use AI_CARGO_DISPATCHER -

AI_CARGO_DISPATCHER_HELICOPTER:Is(State)

+

AI_CARGO_DISPATCHER_HELICOPTER:Is(State, If)

- +

Check if FSM is in state.

AI_CARGO_DISPATCHER_HELICOPTER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1956,7 +1995,7 @@ Use AI_CARGO_DISPATCHER

AI_CARGO_DISPATCHER_HELICOPTER.Scores

- +

Scores.

@@ -2010,73 +2049,73 @@ Use AI_CARGO_DISPATCHER

AI_CARGO_DISPATCHER_HELICOPTER:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_CARGO_DISPATCHER_HELICOPTER:_create_transition(EventName)

- +

Create transition.

AI_CARGO_DISPATCHER_HELICOPTER:_delayed_transition(EventName)

- +

Delayed transition.

AI_CARGO_DISPATCHER_HELICOPTER:_eventmap(Events, EventStructure)

- +

Event map.

AI_CARGO_DISPATCHER_HELICOPTER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_CARGO_DISPATCHER_HELICOPTER:_handler(EventName, ...)

- +

Handler.

AI_CARGO_DISPATCHER_HELICOPTER:_isendstate(Current)

- +

Is end state.

AI_CARGO_DISPATCHER_HELICOPTER:_submap(subs, sub, name)

- +

Sub maps.

AI_CARGO_DISPATCHER_HELICOPTER:can(e)

- +

Check if can do an event.

AI_CARGO_DISPATCHER_HELICOPTER:cannot(e)

- +

Check if cannot do an event.

AI_CARGO_DISPATCHER_HELICOPTER.current

- +

Current state name.

@@ -2086,21 +2125,21 @@ Use AI_CARGO_DISPATCHER -

AI_CARGO_DISPATCHER_HELICOPTER:is(state)

+

AI_CARGO_DISPATCHER_HELICOPTER:is(State, If, state)

- +

Check if FSM is in state.

AI_CARGO_DISPATCHER_HELICOPTER.options

- +

Options.

AI_CARGO_DISPATCHER_HELICOPTER.subs

- +

Subs.

@@ -4889,11 +4928,14 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string State

-

+ +

The FSM state.

+
@@ -5218,7 +5260,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_HELICOPTER:GetCurrentState()

- +

Get current state.

@@ -5226,6 +5268,17 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -5245,6 +5298,17 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -5311,7 +5375,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
- +

Sub processes.

@@ -5323,7 +5387,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

Returns a table with the scores defined.

@@ -5334,6 +5398,18 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -5375,7 +5451,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_HELICOPTER:GetState()

- +

Get current state.

@@ -5383,6 +5459,17 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -5402,6 +5489,17 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -5428,7 +5526,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
- +

Transitions.

@@ -5440,10 +5538,10 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
- +

Check if FSM is in state.

@@ -5451,15 +5549,31 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -5473,7 +5587,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_HELICOPTER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -5485,11 +5599,14 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -5616,7 +5733,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_HELICOPTER:_add_to_map(Map, Event)

- +

Add to map.

@@ -5628,21 +5745,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -5656,7 +5779,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

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

- +

Call handler.

@@ -5668,43 +5791,65 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -5716,7 +5861,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_HELICOPTER:_create_transition(EventName)

- +

Create transition.

@@ -5728,13 +5873,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -5746,7 +5905,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_HELICOPTER:_delayed_transition(EventName)

- +

Delayed transition.

@@ -5758,13 +5917,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -5776,7 +5949,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_HELICOPTER:_eventmap(Events, EventStructure)

- +

Event map.

@@ -5788,21 +5961,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -5816,7 +5995,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_HELICOPTER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -5828,23 +6007,40 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -5856,7 +6052,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_HELICOPTER:_handler(EventName, ...)

- +

Handler.

@@ -5868,11 +6064,14 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string EventName

-

+ +

Event name.

+
@@ -5882,7 +6081,9 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

-

+ +

Arguments.

+
@@ -5896,7 +6097,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_HELICOPTER:_isendstate(Current)

- +

Is end state.

@@ -5908,13 +6109,35 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -5926,7 +6149,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_HELICOPTER:_submap(subs, sub, name)

- +

Sub maps.

@@ -5938,31 +6161,40 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -5976,7 +6208,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_HELICOPTER:can(e)

- +

Check if can do an event.

@@ -5988,13 +6220,35 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -6006,7 +6260,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

AI_CARGO_DISPATCHER_HELICOPTER:cannot(e)

- +

Check if cannot do an event.

@@ -6018,13 +6272,27 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -6033,10 +6301,10 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
- +

Check if FSM is in state.

@@ -6044,7 +6312,33 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 ) -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/AI.AI_Cargo_Helicopter.html b/Documentation/AI.AI_Cargo_Helicopter.html index 21e14331c..21f8ae4aa 100644 --- a/Documentation/AI.AI_Cargo_Helicopter.html +++ b/Documentation/AI.AI_Cargo_Helicopter.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1690,7 +1723,13 @@ time is not so much of an issue ...

AI_CARGO_HELICOPTER.CallScheduler

- +

Call scheduler.

+ + + +

AI_CARGO_HELICOPTER.ClassName

+ +

Name of the class.

@@ -1702,7 +1741,7 @@ time is not so much of an issue ...

AI_CARGO_HELICOPTER:GetCurrentState()

- +

Get current state.

@@ -1724,7 +1763,7 @@ time is not so much of an issue ...

-

AI_CARGO_HELICOPTER:GetScores()

+

AI_CARGO_HELICOPTER:GetScores(Scores)

Returns a table with the scores defined.

@@ -1738,7 +1777,7 @@ time is not so much of an issue ...

AI_CARGO_HELICOPTER:GetState()

- +

Get current state.

@@ -1754,15 +1793,15 @@ time is not so much of an issue ...

-

AI_CARGO_HELICOPTER:Is(State)

+

AI_CARGO_HELICOPTER:Is(State, If)

- +

Check if FSM is in state.

AI_CARGO_HELICOPTER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1774,7 +1813,7 @@ time is not so much of an issue ...

AI_CARGO_HELICOPTER.Scores

- +

Scores.

@@ -1828,73 +1867,73 @@ time is not so much of an issue ...

AI_CARGO_HELICOPTER:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_CARGO_HELICOPTER:_create_transition(EventName)

- +

Create transition.

AI_CARGO_HELICOPTER:_delayed_transition(EventName)

- +

Delayed transition.

AI_CARGO_HELICOPTER:_eventmap(Events, EventStructure)

- +

Event map.

AI_CARGO_HELICOPTER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_CARGO_HELICOPTER:_handler(EventName, ...)

- +

Handler.

AI_CARGO_HELICOPTER:_isendstate(Current)

- +

Is end state.

AI_CARGO_HELICOPTER:_submap(subs, sub, name)

- +

Sub maps.

AI_CARGO_HELICOPTER:can(e)

- +

Check if can do an event.

AI_CARGO_HELICOPTER:cannot(e)

- +

Check if cannot do an event.

AI_CARGO_HELICOPTER.current

- +

Current state name.

@@ -1904,21 +1943,21 @@ time is not so much of an issue ...

-

AI_CARGO_HELICOPTER:is(state)

+

AI_CARGO_HELICOPTER:is(State, If, state)

- +

Check if FSM is in state.

AI_CARGO_HELICOPTER.options

- +

Options.

AI_CARGO_HELICOPTER.subs

- +

Subs.

@@ -4657,11 +4696,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string State

-

+ +

The FSM state.

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

AI_CARGO_HELICOPTER:GetCurrentState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

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

Sub processes.

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

Returns a table with the scores defined.

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

Parameter:

+
+
+

+ #table + Scores +

+
+
+

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

AI_CARGO_HELICOPTER:GetState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

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

Transitions.

@@ -5208,10 +5306,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

@@ -5219,15 +5317,31 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

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

AI_CARGO_HELICOPTER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -5253,11 +5367,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table CallBackTable

-

+ +

Table of call backs.

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

AI_CARGO_HELICOPTER:_add_to_map(Map, Event)

- +

Add to map.

@@ -5396,21 +5513,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

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

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

- +

Call handler.

@@ -5436,43 +5559,65 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

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

AI_CARGO_HELICOPTER:_create_transition(EventName)

- +

Create transition.

@@ -5496,13 +5641,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

AI_CARGO_HELICOPTER:_delayed_transition(EventName)

- +

Delayed transition.

@@ -5526,13 +5685,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

AI_CARGO_HELICOPTER:_eventmap(Events, EventStructure)

- +

Event map.

@@ -5556,21 +5729,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

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

AI_CARGO_HELICOPTER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -5596,23 +5775,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

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

AI_CARGO_HELICOPTER:_handler(EventName, ...)

- +

Handler.

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

+ #string EventName

-

+ +

Event name.

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

-

+ +

Arguments.

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

AI_CARGO_HELICOPTER:_isendstate(Current)

- +

Is end state.

@@ -5676,13 +5877,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

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

AI_CARGO_HELICOPTER:_submap(subs, sub, name)

- +

Sub maps.

@@ -5706,31 +5929,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

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

AI_CARGO_HELICOPTER:can(e)

- +

Check if can do an event.

@@ -5756,13 +5988,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

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

AI_CARGO_HELICOPTER:cannot(e)

- +

Check if cannot do an event.

@@ -5786,13 +6040,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -5801,10 +6069,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

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

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/AI.AI_Cas.html b/Documentation/AI.AI_Cas.html index b2b605ae3..f1cfe8a4e 100644 --- a/Documentation/AI.AI_Cas.html +++ b/Documentation/AI.AI_Cas.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2329,7 +2362,13 @@ It can be notified to go RTB through the RTB event.

AI_CAS_ZONE.CallScheduler

- +

Call scheduler.

+ + + +

AI_CAS_ZONE.ClassName

+ +

Name of the class.

@@ -2341,7 +2380,7 @@ It can be notified to go RTB through the RTB event.

AI_CAS_ZONE:GetCurrentState()

- +

Get current state.

@@ -2363,7 +2402,7 @@ It can be notified to go RTB through the RTB event.

-

AI_CAS_ZONE:GetScores()

+

AI_CAS_ZONE:GetScores(Scores)

Returns a table with the scores defined.

@@ -2377,7 +2416,7 @@ It can be notified to go RTB through the RTB event.

AI_CAS_ZONE:GetState()

- +

Get current state.

@@ -2393,15 +2432,15 @@ It can be notified to go RTB through the RTB event.

-

AI_CAS_ZONE:Is(State)

+

AI_CAS_ZONE:Is(State, If)

- +

Check if FSM is in state.

AI_CAS_ZONE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2413,7 +2452,7 @@ It can be notified to go RTB through the RTB event.

AI_CAS_ZONE.Scores

- +

Scores.

@@ -2467,73 +2506,73 @@ It can be notified to go RTB through the RTB event.

AI_CAS_ZONE:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_CAS_ZONE:_create_transition(EventName)

- +

Create transition.

AI_CAS_ZONE:_delayed_transition(EventName)

- +

Delayed transition.

AI_CAS_ZONE:_eventmap(Events, EventStructure)

- +

Event map.

AI_CAS_ZONE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_CAS_ZONE:_handler(EventName, ...)

- +

Handler.

AI_CAS_ZONE:_isendstate(Current)

- +

Is end state.

AI_CAS_ZONE:_submap(subs, sub, name)

- +

Sub maps.

AI_CAS_ZONE:can(e)

- +

Check if can do an event.

AI_CAS_ZONE:cannot(e)

- +

Check if cannot do an event.

AI_CAS_ZONE.current

- +

Current state name.

@@ -2543,21 +2582,21 @@ It can be notified to go RTB through the RTB event.

-

AI_CAS_ZONE:is(state)

+

AI_CAS_ZONE:is(State, If, state)

- +

Check if FSM is in state.

AI_CAS_ZONE.options

- +

Options.

AI_CAS_ZONE.subs

- +

Subs.

@@ -9164,11 +9203,14 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string State

-

+ +

The FSM state.

+
@@ -9493,7 +9535,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAS_ZONE:GetCurrentState()

- +

Get current state.

@@ -9501,6 +9543,17 @@ Note that this method is required, as triggers the next route when patrolling fo +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -9520,6 +9573,17 @@ Note that this method is required, as triggers the next route when patrolling fo

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -9586,7 +9650,7 @@ Note that this method is required, as triggers the next route when patrolling fo
- +

Sub processes.

@@ -9598,7 +9662,7 @@ Note that this method is required, as triggers the next route when patrolling fo

Returns a table with the scores defined.

@@ -9609,6 +9673,18 @@ Note that this method is required, as triggers the next route when patrolling fo +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -9650,7 +9726,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAS_ZONE:GetState()

- +

Get current state.

@@ -9658,6 +9734,17 @@ Note that this method is required, as triggers the next route when patrolling fo +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -9677,6 +9764,17 @@ Note that this method is required, as triggers the next route when patrolling fo

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -9703,7 +9801,7 @@ Note that this method is required, as triggers the next route when patrolling fo
- +

Transitions.

@@ -9715,10 +9813,10 @@ Note that this method is required, as triggers the next route when patrolling fo
- +

Check if FSM is in state.

@@ -9726,15 +9824,31 @@ Note that this method is required, as triggers the next route when patrolling fo -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -9748,7 +9862,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAS_ZONE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -9760,11 +9874,14 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -9891,7 +10008,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAS_ZONE:_add_to_map(Map, Event)

- +

Add to map.

@@ -9903,21 +10020,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -9931,7 +10054,7 @@ Note that this method is required, as triggers the next route when patrolling fo

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

- +

Call handler.

@@ -9943,43 +10066,65 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -9991,7 +10136,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAS_ZONE:_create_transition(EventName)

- +

Create transition.

@@ -10003,13 +10148,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -10021,7 +10180,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAS_ZONE:_delayed_transition(EventName)

- +

Delayed transition.

@@ -10033,13 +10192,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -10051,7 +10224,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAS_ZONE:_eventmap(Events, EventStructure)

- +

Event map.

@@ -10063,21 +10236,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -10091,7 +10270,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAS_ZONE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -10103,23 +10282,40 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -10131,7 +10327,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAS_ZONE:_handler(EventName, ...)

- +

Handler.

@@ -10143,11 +10339,14 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string EventName

-

+ +

Event name.

+
@@ -10157,7 +10356,9 @@ Note that this method is required, as triggers the next route when patrolling fo

-

+ +

Arguments.

+
@@ -10171,7 +10372,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAS_ZONE:_isendstate(Current)

- +

Is end state.

@@ -10183,13 +10384,35 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -10201,7 +10424,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAS_ZONE:_submap(subs, sub, name)

- +

Sub maps.

@@ -10213,31 +10436,40 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -10251,7 +10483,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAS_ZONE:can(e)

- +

Check if can do an event.

@@ -10263,13 +10495,35 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -10281,7 +10535,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_CAS_ZONE:cannot(e)

- +

Check if cannot do an event.

@@ -10293,13 +10547,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -10308,10 +10576,10 @@ Note that this method is required, as triggers the next route when patrolling fo
- +

Check if FSM is in state.

@@ -10319,7 +10587,33 @@ Note that this method is required, as triggers the next route when patrolling fo -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/AI.AI_ESCORT_DISPATCHER_REQUEST.html b/Documentation/AI.AI_ESCORT_DISPATCHER_REQUEST.html index 9dd602e59..29b88ce84 100644 --- a/Documentation/AI.AI_ESCORT_DISPATCHER_REQUEST.html +++ b/Documentation/AI.AI_ESCORT_DISPATCHER_REQUEST.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1502,7 +1535,13 @@

AI_ESCORT_DISPATCHER_REQUEST.CallScheduler

- +

Call scheduler.

+ + + +

AI_ESCORT_DISPATCHER_REQUEST.ClassName

+ +

Name of the class.

@@ -1514,7 +1553,7 @@

AI_ESCORT_DISPATCHER_REQUEST:GetCurrentState()

- +

Get current state.

@@ -1536,7 +1575,7 @@ -

AI_ESCORT_DISPATCHER_REQUEST:GetScores()

+

AI_ESCORT_DISPATCHER_REQUEST:GetScores(Scores)

Returns a table with the scores defined.

@@ -1550,7 +1589,7 @@

AI_ESCORT_DISPATCHER_REQUEST:GetState()

- +

Get current state.

@@ -1566,15 +1605,15 @@ -

AI_ESCORT_DISPATCHER_REQUEST:Is(State)

+

AI_ESCORT_DISPATCHER_REQUEST:Is(State, If)

- +

Check if FSM is in state.

AI_ESCORT_DISPATCHER_REQUEST:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1586,7 +1625,7 @@

AI_ESCORT_DISPATCHER_REQUEST.Scores

- +

Scores.

@@ -1640,73 +1679,73 @@

AI_ESCORT_DISPATCHER_REQUEST:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_ESCORT_DISPATCHER_REQUEST:_create_transition(EventName)

- +

Create transition.

AI_ESCORT_DISPATCHER_REQUEST:_delayed_transition(EventName)

- +

Delayed transition.

AI_ESCORT_DISPATCHER_REQUEST:_eventmap(Events, EventStructure)

- +

Event map.

AI_ESCORT_DISPATCHER_REQUEST:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_ESCORT_DISPATCHER_REQUEST:_handler(EventName, ...)

- +

Handler.

AI_ESCORT_DISPATCHER_REQUEST:_isendstate(Current)

- +

Is end state.

AI_ESCORT_DISPATCHER_REQUEST:_submap(subs, sub, name)

- +

Sub maps.

AI_ESCORT_DISPATCHER_REQUEST:can(e)

- +

Check if can do an event.

AI_ESCORT_DISPATCHER_REQUEST:cannot(e)

- +

Check if cannot do an event.

AI_ESCORT_DISPATCHER_REQUEST.current

- +

Current state name.

@@ -1716,21 +1755,21 @@ -

AI_ESCORT_DISPATCHER_REQUEST:is(state)

+

AI_ESCORT_DISPATCHER_REQUEST:is(State, If, state)

- +

Check if FSM is in state.

AI_ESCORT_DISPATCHER_REQUEST.options

- +

Options.

AI_ESCORT_DISPATCHER_REQUEST.subs

- +

Subs.

@@ -2702,11 +2741,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string State

-

+ +

The FSM state.

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

AI_ESCORT_DISPATCHER_REQUEST:GetCurrentState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

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

Sub processes.

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

Returns a table with the scores defined.

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

Parameter:

+
+
+

+ #table + Scores +

+
+
+

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

AI_ESCORT_DISPATCHER_REQUEST:GetState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

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

Transitions.

@@ -3253,10 +3351,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

@@ -3264,15 +3362,31 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

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

AI_ESCORT_DISPATCHER_REQUEST:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -3298,11 +3412,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table CallBackTable

-

+ +

Table of call backs.

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

AI_ESCORT_DISPATCHER_REQUEST:_add_to_map(Map, Event)

- +

Add to map.

@@ -3441,21 +3558,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

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

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

- +

Call handler.

@@ -3481,43 +3604,65 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

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

AI_ESCORT_DISPATCHER_REQUEST:_create_transition(EventName)

- +

Create transition.

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

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

AI_ESCORT_DISPATCHER_REQUEST:_delayed_transition(EventName)

- +

Delayed transition.

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

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

AI_ESCORT_DISPATCHER_REQUEST:_eventmap(Events, EventStructure)

- +

Event map.

@@ -3601,21 +3774,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

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

AI_ESCORT_DISPATCHER_REQUEST:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -3641,23 +3820,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

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

AI_ESCORT_DISPATCHER_REQUEST:_handler(EventName, ...)

- +

Handler.

@@ -3681,11 +3877,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

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

-

+ +

Arguments.

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

AI_ESCORT_DISPATCHER_REQUEST:_isendstate(Current)

- +

Is end state.

@@ -3721,13 +3922,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

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

AI_ESCORT_DISPATCHER_REQUEST:_submap(subs, sub, name)

- +

Sub maps.

@@ -3751,31 +3974,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

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

AI_ESCORT_DISPATCHER_REQUEST:can(e)

- +

Check if can do an event.

@@ -3801,13 +4033,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

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

AI_ESCORT_DISPATCHER_REQUEST:cannot(e)

- +

Check if cannot do an event.

@@ -3831,13 +4085,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -3846,10 +4114,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

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

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/AI.AI_Escort.html b/Documentation/AI.AI_Escort.html index 185da5719..8ee9ad120 100644 --- a/Documentation/AI.AI_Escort.html +++ b/Documentation/AI.AI_Escort.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/AI.AI_Escort_Dispatcher.html b/Documentation/AI.AI_Escort_Dispatcher.html index 966d70f5b..b5d82fcb3 100644 --- a/Documentation/AI.AI_Escort_Dispatcher.html +++ b/Documentation/AI.AI_Escort_Dispatcher.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1500,7 +1533,13 @@

AI_ESCORT_DISPATCHER.CallScheduler

- +

Call scheduler.

+ + + +

AI_ESCORT_DISPATCHER.ClassName

+ +

Name of the class.

@@ -1512,7 +1551,7 @@

AI_ESCORT_DISPATCHER:GetCurrentState()

- +

Get current state.

@@ -1534,7 +1573,7 @@ -

AI_ESCORT_DISPATCHER:GetScores()

+

AI_ESCORT_DISPATCHER:GetScores(Scores)

Returns a table with the scores defined.

@@ -1548,7 +1587,7 @@

AI_ESCORT_DISPATCHER:GetState()

- +

Get current state.

@@ -1564,15 +1603,15 @@ -

AI_ESCORT_DISPATCHER:Is(State)

+

AI_ESCORT_DISPATCHER:Is(State, If)

- +

Check if FSM is in state.

AI_ESCORT_DISPATCHER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1584,7 +1623,7 @@

AI_ESCORT_DISPATCHER.Scores

- +

Scores.

@@ -1638,73 +1677,73 @@

AI_ESCORT_DISPATCHER:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_ESCORT_DISPATCHER:_create_transition(EventName)

- +

Create transition.

AI_ESCORT_DISPATCHER:_delayed_transition(EventName)

- +

Delayed transition.

AI_ESCORT_DISPATCHER:_eventmap(Events, EventStructure)

- +

Event map.

AI_ESCORT_DISPATCHER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_ESCORT_DISPATCHER:_handler(EventName, ...)

- +

Handler.

AI_ESCORT_DISPATCHER:_isendstate(Current)

- +

Is end state.

AI_ESCORT_DISPATCHER:_submap(subs, sub, name)

- +

Sub maps.

AI_ESCORT_DISPATCHER:can(e)

- +

Check if can do an event.

AI_ESCORT_DISPATCHER:cannot(e)

- +

Check if cannot do an event.

AI_ESCORT_DISPATCHER.current

- +

Current state name.

@@ -1714,21 +1753,21 @@ -

AI_ESCORT_DISPATCHER:is(state)

+

AI_ESCORT_DISPATCHER:is(State, If, state)

- +

Check if FSM is in state.

AI_ESCORT_DISPATCHER.options

- +

Options.

AI_ESCORT_DISPATCHER.subs

- +

Subs.

@@ -2723,11 +2762,14 @@ Red_SU25T_EscortDispatcher:Start()

+ #string State

-

+ +

The FSM state.

+
@@ -3052,7 +3094,7 @@ Red_SU25T_EscortDispatcher:Start()

AI_ESCORT_DISPATCHER:GetCurrentState()

- +

Get current state.

@@ -3060,6 +3102,17 @@ Red_SU25T_EscortDispatcher:Start() +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -3079,6 +3132,17 @@ Red_SU25T_EscortDispatcher:Start()

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -3145,7 +3209,7 @@ Red_SU25T_EscortDispatcher:Start()
- +

Sub processes.

@@ -3157,7 +3221,7 @@ Red_SU25T_EscortDispatcher:Start()

Returns a table with the scores defined.

@@ -3168,6 +3232,18 @@ Red_SU25T_EscortDispatcher:Start() +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -3209,7 +3285,7 @@ Red_SU25T_EscortDispatcher:Start()

AI_ESCORT_DISPATCHER:GetState()

- +

Get current state.

@@ -3217,6 +3293,17 @@ Red_SU25T_EscortDispatcher:Start() +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -3236,6 +3323,17 @@ Red_SU25T_EscortDispatcher:Start()

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -3262,7 +3360,7 @@ Red_SU25T_EscortDispatcher:Start()
- +

Transitions.

@@ -3274,10 +3372,10 @@ Red_SU25T_EscortDispatcher:Start()
- +

Check if FSM is in state.

@@ -3285,15 +3383,31 @@ Red_SU25T_EscortDispatcher:Start() -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -3307,7 +3421,7 @@ Red_SU25T_EscortDispatcher:Start()

AI_ESCORT_DISPATCHER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -3319,11 +3433,14 @@ Red_SU25T_EscortDispatcher:Start()

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -3450,7 +3567,7 @@ Red_SU25T_EscortDispatcher:Start()

AI_ESCORT_DISPATCHER:_add_to_map(Map, Event)

- +

Add to map.

@@ -3462,21 +3579,27 @@ Red_SU25T_EscortDispatcher:Start()

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -3490,7 +3613,7 @@ Red_SU25T_EscortDispatcher:Start()

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

- +

Call handler.

@@ -3502,43 +3625,65 @@ Red_SU25T_EscortDispatcher:Start()

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -3550,7 +3695,7 @@ Red_SU25T_EscortDispatcher:Start()

AI_ESCORT_DISPATCHER:_create_transition(EventName)

- +

Create transition.

@@ -3562,13 +3707,27 @@ Red_SU25T_EscortDispatcher:Start()

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -3580,7 +3739,7 @@ Red_SU25T_EscortDispatcher:Start()

AI_ESCORT_DISPATCHER:_delayed_transition(EventName)

- +

Delayed transition.

@@ -3592,13 +3751,27 @@ Red_SU25T_EscortDispatcher:Start()

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -3610,7 +3783,7 @@ Red_SU25T_EscortDispatcher:Start()

AI_ESCORT_DISPATCHER:_eventmap(Events, EventStructure)

- +

Event map.

@@ -3622,21 +3795,27 @@ Red_SU25T_EscortDispatcher:Start()

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -3650,7 +3829,7 @@ Red_SU25T_EscortDispatcher:Start()

AI_ESCORT_DISPATCHER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -3662,23 +3841,40 @@ Red_SU25T_EscortDispatcher:Start()

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -3690,7 +3886,7 @@ Red_SU25T_EscortDispatcher:Start()

AI_ESCORT_DISPATCHER:_handler(EventName, ...)

- +

Handler.

@@ -3702,11 +3898,14 @@ Red_SU25T_EscortDispatcher:Start()

+ #string EventName

-

+ +

Event name.

+
@@ -3716,7 +3915,9 @@ Red_SU25T_EscortDispatcher:Start()

-

+ +

Arguments.

+
@@ -3730,7 +3931,7 @@ Red_SU25T_EscortDispatcher:Start()

AI_ESCORT_DISPATCHER:_isendstate(Current)

- +

Is end state.

@@ -3742,13 +3943,35 @@ Red_SU25T_EscortDispatcher:Start()

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -3760,7 +3983,7 @@ Red_SU25T_EscortDispatcher:Start()

AI_ESCORT_DISPATCHER:_submap(subs, sub, name)

- +

Sub maps.

@@ -3772,31 +3995,40 @@ Red_SU25T_EscortDispatcher:Start()

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -3810,7 +4042,7 @@ Red_SU25T_EscortDispatcher:Start()

AI_ESCORT_DISPATCHER:can(e)

- +

Check if can do an event.

@@ -3822,13 +4054,35 @@ Red_SU25T_EscortDispatcher:Start()

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -3840,7 +4094,7 @@ Red_SU25T_EscortDispatcher:Start()

AI_ESCORT_DISPATCHER:cannot(e)

- +

Check if cannot do an event.

@@ -3852,13 +4106,27 @@ Red_SU25T_EscortDispatcher:Start()

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -3867,10 +4135,10 @@ Red_SU25T_EscortDispatcher:Start()
- +

Check if FSM is in state.

@@ -3878,7 +4146,33 @@ Red_SU25T_EscortDispatcher:Start() -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/AI.AI_Formation.html b/Documentation/AI.AI_Formation.html index 63bdea773..5c2dad90a 100644 --- a/Documentation/AI.AI_Formation.html +++ b/Documentation/AI.AI_Formation.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1465,6 +1498,12 @@ LargeFormation:__Start( 1 )

AI_FORMATION.FollowGroupSet

+ + + +

AI_FORMATION:FollowMe(FollowGroup, ClientUnit, CT1, CV1, CT2, CV2)

+ +

Follow me.

@@ -1882,9 +1921,9 @@ LargeFormation:__Start( 1 ) -

AI_FORMATION:onenterFollowing(FollowGroupSet)

+

AI_FORMATION:onenterFollowing(FollowGroupSet, From, Event, To)

- +

Enter following state.

@@ -1960,7 +1999,13 @@ LargeFormation:__Start( 1 )

AI_FORMATION.CallScheduler

- +

Call scheduler.

+ + + +

AI_FORMATION.ClassName

+ +

Name of the class.

@@ -1972,7 +2017,7 @@ LargeFormation:__Start( 1 )

AI_FORMATION:GetCurrentState()

- +

Get current state.

@@ -1994,7 +2039,7 @@ LargeFormation:__Start( 1 ) -

AI_FORMATION:GetScores()

+

AI_FORMATION:GetScores(Scores)

Returns a table with the scores defined.

@@ -2008,7 +2053,7 @@ LargeFormation:__Start( 1 )

AI_FORMATION:GetState()

- +

Get current state.

@@ -2024,15 +2069,15 @@ LargeFormation:__Start( 1 ) -

AI_FORMATION:Is(State)

+

AI_FORMATION:Is(State, If)

- +

Check if FSM is in state.

AI_FORMATION:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2044,7 +2089,7 @@ LargeFormation:__Start( 1 )

AI_FORMATION.Scores

- +

Scores.

@@ -2098,73 +2143,73 @@ LargeFormation:__Start( 1 )

AI_FORMATION:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_FORMATION:_create_transition(EventName)

- +

Create transition.

AI_FORMATION:_delayed_transition(EventName)

- +

Delayed transition.

AI_FORMATION:_eventmap(Events, EventStructure)

- +

Event map.

AI_FORMATION:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_FORMATION:_handler(EventName, ...)

- +

Handler.

AI_FORMATION:_isendstate(Current)

- +

Is end state.

AI_FORMATION:_submap(subs, sub, name)

- +

Sub maps.

AI_FORMATION:can(e)

- +

Check if can do an event.

AI_FORMATION:cannot(e)

- +

Check if cannot do an event.

AI_FORMATION.current

- +

Current state name.

@@ -2174,21 +2219,21 @@ LargeFormation:__Start( 1 ) -

AI_FORMATION:is(state)

+

AI_FORMATION:is(State, If, state)

- +

Check if FSM is in state.

AI_FORMATION.options

- +

Options.

AI_FORMATION.subs

- +

Subs.

@@ -3012,6 +3057,104 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+ + +

Follow me.

+ +
+
+

Defined in:

+
+

AI_FORMATION

+
+

Parameters:

+
+
+

+ Wrapper.Group#GROUP + FollowGroup +

+
+
+ +

Follow group.

+ +
+
+
+
+

+ Wrapper.Unit#UNIT + ClientUnit +

+
+
+ +

Client Unit.

+ +
+
+
+
+

+ DCS#Time + CT1 +

+
+
+ +

Time

+ +
+
+
+
+

+ DCS#Vec3 + CV1 +

+
+
+ +

Vec3

+ +
+
+
+
+

+ DCS#Time + CT2 +

+
+
+ +

Time

+ +
+
+
+
+

+ DCS#Vec3 + CV2 +

+
+
+ +

Vec3

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number YSpace

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number YStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number YSpace

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number YStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number YSpace

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number YStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number YSpace

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number YStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number YSpace

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

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

- #nubmer + #number YStart

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

- #nubmer + #number YStart

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

- #nubmer + #number YStart

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

- #nubmer + #number ZStart

@@ -9270,11 +9413,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string To

-

+ +

The to state.

+
@@ -9342,11 +9488,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string To

-

+ +

The to state.

+
@@ -9357,10 +9506,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Enter following state.

@@ -9368,15 +9517,57 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

AI_FORMATION

-

Parameter:

+

Parameters:

+ Core.Set#SET_GROUP FollowGroupSet

-

+ +

The following set of groups.

+ +
+
+
+
+

+ #string + From +

+
+
+ +

From state.

+ +
+
+
+
+

+ #string + Event +

+
+
+ +

Event.

+ +
+
+
+
+

+ #string + To +

+
+
+ +

The to state.

+
@@ -9812,11 +10003,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string State

-

+ +

The FSM state.

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

AI_FORMATION:GetCurrentState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Return value:

+
+
+

#table:

+
+
+ +

End states.

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

Sub processes.

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

Returns a table with the scores defined.

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

Parameter:

+
+
+

+ #table + Scores +

+
+
+

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

AI_FORMATION:GetState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

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

Transitions.

@@ -10363,10 +10613,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

@@ -10374,15 +10624,31 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

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

AI_FORMATION:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -10408,11 +10674,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table CallBackTable

-

+ +

Table of call backs.

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

AI_FORMATION:_add_to_map(Map, Event)

- +

Add to map.

@@ -10551,21 +10820,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

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

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

- +

Call handler.

@@ -10591,43 +10866,65 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

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

AI_FORMATION:_create_transition(EventName)

- +

Create transition.

@@ -10651,13 +10948,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

AI_FORMATION:_delayed_transition(EventName)

- +

Delayed transition.

@@ -10681,13 +10992,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

AI_FORMATION:_eventmap(Events, EventStructure)

- +

Event map.

@@ -10711,21 +11036,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

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

AI_FORMATION:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -10751,23 +11082,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

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

AI_FORMATION:_handler(EventName, ...)

- +

Handler.

@@ -10791,11 +11139,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

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

-

+ +

Arguments.

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

AI_FORMATION:_isendstate(Current)

- +

Is end state.

@@ -10831,13 +11184,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

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

AI_FORMATION:_submap(subs, sub, name)

- +

Sub maps.

@@ -10861,31 +11236,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

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

AI_FORMATION:can(e)

- +

Check if can do an event.

@@ -10911,13 +11295,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

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

AI_FORMATION:cannot(e)

- +

Check if cannot do an event.

@@ -10941,13 +11347,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -10956,10 +11376,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

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

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

@@ -14358,7 +14804,7 @@ BASE:TraceOnOff( false )

- #Distance + #number MENUPARAM.ParamDistance diff --git a/Documentation/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html index e84b5961b..ec8219985 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+
+
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+
+
+
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2095,7 +2128,13 @@ Use the method AI_PATROL_ZONE.ManageDa

AI_PATROL_ZONE.CallScheduler

- +

Call scheduler.

+ + + +

AI_PATROL_ZONE.ClassName

+ +

Name of the class.

@@ -2107,7 +2146,7 @@ Use the method AI_PATROL_ZONE.ManageDa

AI_PATROL_ZONE:GetCurrentState()

- +

Get current state.

@@ -2129,7 +2168,7 @@ Use the method AI_PATROL_ZONE.ManageDa -

AI_PATROL_ZONE:GetScores()

+

AI_PATROL_ZONE:GetScores(Scores)

Returns a table with the scores defined.

@@ -2143,7 +2182,7 @@ Use the method AI_PATROL_ZONE.ManageDa

AI_PATROL_ZONE:GetState()

- +

Get current state.

@@ -2159,15 +2198,15 @@ Use the method AI_PATROL_ZONE.ManageDa -

AI_PATROL_ZONE:Is(State)

+

AI_PATROL_ZONE:Is(State, If)

- +

Check if FSM is in state.

AI_PATROL_ZONE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2179,7 +2218,7 @@ Use the method AI_PATROL_ZONE.ManageDa

AI_PATROL_ZONE.Scores

- +

Scores.

@@ -2233,73 +2272,73 @@ Use the method AI_PATROL_ZONE.ManageDa

AI_PATROL_ZONE:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

AI_PATROL_ZONE:_create_transition(EventName)

- +

Create transition.

AI_PATROL_ZONE:_delayed_transition(EventName)

- +

Delayed transition.

AI_PATROL_ZONE:_eventmap(Events, EventStructure)

- +

Event map.

AI_PATROL_ZONE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AI_PATROL_ZONE:_handler(EventName, ...)

- +

Handler.

AI_PATROL_ZONE:_isendstate(Current)

- +

Is end state.

AI_PATROL_ZONE:_submap(subs, sub, name)

- +

Sub maps.

AI_PATROL_ZONE:can(e)

- +

Check if can do an event.

AI_PATROL_ZONE:cannot(e)

- +

Check if cannot do an event.

AI_PATROL_ZONE.current

- +

Current state name.

@@ -2309,21 +2348,21 @@ Use the method AI_PATROL_ZONE.ManageDa -

AI_PATROL_ZONE:is(state)

+

AI_PATROL_ZONE:is(State, If, state)

- +

Check if FSM is in state.

AI_PATROL_ZONE.options

- +

Options.

AI_PATROL_ZONE.subs

- +

Subs.

@@ -7039,11 +7078,14 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string State

-

+ +

The FSM state.

+
@@ -7368,7 +7410,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_PATROL_ZONE:GetCurrentState()

- +

Get current state.

@@ -7376,6 +7418,17 @@ Note that this method is required, as triggers the next route when patrolling fo +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -7395,6 +7448,17 @@ Note that this method is required, as triggers the next route when patrolling fo +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -7461,7 +7525,7 @@ Note that this method is required, as triggers the next route when patrolling fo
- +

Sub processes.

@@ -7473,7 +7537,7 @@ Note that this method is required, as triggers the next route when patrolling fo

Returns a table with the scores defined.

@@ -7484,6 +7548,18 @@ Note that this method is required, as triggers the next route when patrolling fo +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -7525,7 +7601,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_PATROL_ZONE:GetState()

- +

Get current state.

@@ -7533,6 +7609,17 @@ Note that this method is required, as triggers the next route when patrolling fo +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -7552,6 +7639,17 @@ Note that this method is required, as triggers the next route when patrolling fo +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -7578,7 +7676,7 @@ Note that this method is required, as triggers the next route when patrolling fo
- +

Transitions.

@@ -7590,10 +7688,10 @@ Note that this method is required, as triggers the next route when patrolling fo
- +

Check if FSM is in state.

@@ -7601,15 +7699,31 @@ Note that this method is required, as triggers the next route when patrolling fo -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -7623,7 +7737,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_PATROL_ZONE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -7635,11 +7749,14 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -7766,7 +7883,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_PATROL_ZONE:_add_to_map(Map, Event)

- +

Add to map.

@@ -7778,21 +7895,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -7806,7 +7929,7 @@ Note that this method is required, as triggers the next route when patrolling fo

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

- +

Call handler.

@@ -7818,43 +7941,65 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -7866,7 +8011,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_PATROL_ZONE:_create_transition(EventName)

- +

Create transition.

@@ -7878,13 +8023,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -7896,7 +8055,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_PATROL_ZONE:_delayed_transition(EventName)

- +

Delayed transition.

@@ -7908,13 +8067,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -7926,7 +8099,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_PATROL_ZONE:_eventmap(Events, EventStructure)

- +

Event map.

@@ -7938,21 +8111,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -7966,7 +8145,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_PATROL_ZONE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -7978,23 +8157,40 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -8006,7 +8202,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_PATROL_ZONE:_handler(EventName, ...)

- +

Handler.

@@ -8018,11 +8214,14 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string EventName

-

+ +

Event name.

+
@@ -8032,7 +8231,9 @@ Note that this method is required, as triggers the next route when patrolling fo

-

+ +

Arguments.

+
@@ -8046,7 +8247,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_PATROL_ZONE:_isendstate(Current)

- +

Is end state.

@@ -8058,13 +8259,35 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -8076,7 +8299,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_PATROL_ZONE:_submap(subs, sub, name)

- +

Sub maps.

@@ -8088,31 +8311,40 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -8126,7 +8358,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_PATROL_ZONE:can(e)

- +

Check if can do an event.

@@ -8138,13 +8370,35 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -8156,7 +8410,7 @@ Note that this method is required, as triggers the next route when patrolling fo

AI_PATROL_ZONE:cannot(e)

- +

Check if cannot do an event.

@@ -8168,13 +8422,27 @@ Note that this method is required, as triggers the next route when patrolling fo

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -8183,10 +8451,10 @@ Note that this method is required, as triggers the next route when patrolling fo
- +

Check if FSM is in state.

@@ -8194,7 +8462,33 @@ Note that this method is required, as triggers the next route when patrolling fo -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Actions.Account.html b/Documentation/Actions.Account.html index 0036e4832..b669f8cfe 100644 --- a/Documentation/Actions.Account.html +++ b/Documentation/Actions.Account.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+
+
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+
+
+
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1635,7 +1668,13 @@

ACT_ACCOUNT.CallScheduler

- +

Call scheduler.

+ + + +

ACT_ACCOUNT.ClassName

+ +

Name of the class.

@@ -1647,7 +1686,7 @@

ACT_ACCOUNT:GetCurrentState()

- +

Get current state.

@@ -1669,7 +1708,7 @@ -

ACT_ACCOUNT:GetScores()

+

ACT_ACCOUNT:GetScores(Scores)

Returns a table with the scores defined.

@@ -1683,7 +1722,7 @@

ACT_ACCOUNT:GetState()

- +

Get current state.

@@ -1699,15 +1738,15 @@ -

ACT_ACCOUNT:Is(State)

+

ACT_ACCOUNT:Is(State, If)

- +

Check if FSM is in state.

ACT_ACCOUNT:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1719,7 +1758,7 @@

ACT_ACCOUNT.Scores

- +

Scores.

@@ -1773,73 +1812,73 @@

ACT_ACCOUNT:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

ACT_ACCOUNT:_create_transition(EventName)

- +

Create transition.

ACT_ACCOUNT:_delayed_transition(EventName)

- +

Delayed transition.

ACT_ACCOUNT:_eventmap(Events, EventStructure)

- +

Event map.

ACT_ACCOUNT:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

ACT_ACCOUNT:_handler(EventName, ...)

- +

Handler.

ACT_ACCOUNT:_isendstate(Current)

- +

Is end state.

ACT_ACCOUNT:_submap(subs, sub, name)

- +

Sub maps.

ACT_ACCOUNT:can(e)

- +

Check if can do an event.

ACT_ACCOUNT:cannot(e)

- +

Check if cannot do an event.

ACT_ACCOUNT.current

- +

Current state name.

@@ -1849,21 +1888,21 @@ -

ACT_ACCOUNT:is(state)

+

ACT_ACCOUNT:is(State, If, state)

- +

Check if FSM is in state.

ACT_ACCOUNT.options

- +

Options.

ACT_ACCOUNT.subs

- +

Subs.

@@ -4063,11 +4102,14 @@ There are 2 moments when state transition methods will be called by the state ma

+ #string State

-

+ +

The FSM state.

+
@@ -4392,7 +4434,7 @@ There are 2 moments when state transition methods will be called by the state ma

ACT_ACCOUNT:GetCurrentState()

- +

Get current state.

@@ -4400,6 +4442,17 @@ There are 2 moments when state transition methods will be called by the state ma +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -4419,6 +4472,17 @@ There are 2 moments when state transition methods will be called by the state ma +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -4485,7 +4549,7 @@ There are 2 moments when state transition methods will be called by the state ma
- +

Sub processes.

@@ -4497,7 +4561,7 @@ There are 2 moments when state transition methods will be called by the state ma

Returns a table with the scores defined.

@@ -4508,6 +4572,18 @@ There are 2 moments when state transition methods will be called by the state ma +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -4549,7 +4625,7 @@ There are 2 moments when state transition methods will be called by the state ma

ACT_ACCOUNT:GetState()

- +

Get current state.

@@ -4557,6 +4633,17 @@ There are 2 moments when state transition methods will be called by the state ma +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -4576,6 +4663,17 @@ There are 2 moments when state transition methods will be called by the state ma +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -4602,7 +4700,7 @@ There are 2 moments when state transition methods will be called by the state ma
- +

Transitions.

@@ -4614,10 +4712,10 @@ There are 2 moments when state transition methods will be called by the state ma
- +

Check if FSM is in state.

@@ -4625,15 +4723,31 @@ There are 2 moments when state transition methods will be called by the state ma -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -4647,7 +4761,7 @@ There are 2 moments when state transition methods will be called by the state ma

ACT_ACCOUNT:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -4659,11 +4773,14 @@ There are 2 moments when state transition methods will be called by the state ma

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -4790,7 +4907,7 @@ There are 2 moments when state transition methods will be called by the state ma

ACT_ACCOUNT:_add_to_map(Map, Event)

- +

Add to map.

@@ -4802,21 +4919,27 @@ There are 2 moments when state transition methods will be called by the state ma

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -4830,7 +4953,7 @@ There are 2 moments when state transition methods will be called by the state ma

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

- +

Call handler.

@@ -4842,43 +4965,65 @@ There are 2 moments when state transition methods will be called by the state ma

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -4890,7 +5035,7 @@ There are 2 moments when state transition methods will be called by the state ma

ACT_ACCOUNT:_create_transition(EventName)

- +

Create transition.

@@ -4902,13 +5047,27 @@ There are 2 moments when state transition methods will be called by the state ma

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -4920,7 +5079,7 @@ There are 2 moments when state transition methods will be called by the state ma

ACT_ACCOUNT:_delayed_transition(EventName)

- +

Delayed transition.

@@ -4932,13 +5091,27 @@ There are 2 moments when state transition methods will be called by the state ma

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -4950,7 +5123,7 @@ There are 2 moments when state transition methods will be called by the state ma

ACT_ACCOUNT:_eventmap(Events, EventStructure)

- +

Event map.

@@ -4962,21 +5135,27 @@ There are 2 moments when state transition methods will be called by the state ma

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -4990,7 +5169,7 @@ There are 2 moments when state transition methods will be called by the state ma

ACT_ACCOUNT:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -5002,23 +5181,40 @@ There are 2 moments when state transition methods will be called by the state ma

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -5030,7 +5226,7 @@ There are 2 moments when state transition methods will be called by the state ma

ACT_ACCOUNT:_handler(EventName, ...)

- +

Handler.

@@ -5042,11 +5238,14 @@ There are 2 moments when state transition methods will be called by the state ma

+ #string EventName

-

+ +

Event name.

+
@@ -5056,7 +5255,9 @@ There are 2 moments when state transition methods will be called by the state ma

-

+ +

Arguments.

+
@@ -5070,7 +5271,7 @@ There are 2 moments when state transition methods will be called by the state ma

ACT_ACCOUNT:_isendstate(Current)

- +

Is end state.

@@ -5082,13 +5283,35 @@ There are 2 moments when state transition methods will be called by the state ma

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -5100,7 +5323,7 @@ There are 2 moments when state transition methods will be called by the state ma

ACT_ACCOUNT:_submap(subs, sub, name)

- +

Sub maps.

@@ -5112,31 +5335,40 @@ There are 2 moments when state transition methods will be called by the state ma

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -5150,7 +5382,7 @@ There are 2 moments when state transition methods will be called by the state ma

ACT_ACCOUNT:can(e)

- +

Check if can do an event.

@@ -5162,13 +5394,35 @@ There are 2 moments when state transition methods will be called by the state ma

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -5180,7 +5434,7 @@ There are 2 moments when state transition methods will be called by the state ma

ACT_ACCOUNT:cannot(e)

- +

Check if cannot do an event.

@@ -5192,13 +5446,27 @@ There are 2 moments when state transition methods will be called by the state ma

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -5207,10 +5475,10 @@ There are 2 moments when state transition methods will be called by the state ma
- +

Check if FSM is in state.

@@ -5218,7 +5486,33 @@ There are 2 moments when state transition methods will be called by the state ma -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Actions.Assign.html b/Documentation/Actions.Assign.html index 1794228c0..a9c455e4c 100644 --- a/Documentation/Actions.Assign.html +++ b/Documentation/Actions.Assign.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+
+
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+
+
+
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1728,7 +1761,13 @@ The assignment type also allows to reject the task.

ACT_ASSIGN.CallScheduler

- +

Call scheduler.

+ + + +

ACT_ASSIGN.ClassName

+ +

Name of the class.

@@ -1740,7 +1779,7 @@ The assignment type also allows to reject the task.

ACT_ASSIGN:GetCurrentState()

- +

Get current state.

@@ -1762,7 +1801,7 @@ The assignment type also allows to reject the task.

-

ACT_ASSIGN:GetScores()

+

ACT_ASSIGN:GetScores(Scores)

Returns a table with the scores defined.

@@ -1776,7 +1815,7 @@ The assignment type also allows to reject the task.

ACT_ASSIGN:GetState()

- +

Get current state.

@@ -1792,15 +1831,15 @@ The assignment type also allows to reject the task.

-

ACT_ASSIGN:Is(State)

+

ACT_ASSIGN:Is(State, If)

- +

Check if FSM is in state.

ACT_ASSIGN:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1812,7 +1851,7 @@ The assignment type also allows to reject the task.

ACT_ASSIGN.Scores

- +

Scores.

@@ -1866,73 +1905,73 @@ The assignment type also allows to reject the task.

ACT_ASSIGN:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

ACT_ASSIGN:_create_transition(EventName)

- +

Create transition.

ACT_ASSIGN:_delayed_transition(EventName)

- +

Delayed transition.

ACT_ASSIGN:_eventmap(Events, EventStructure)

- +

Event map.

ACT_ASSIGN:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

ACT_ASSIGN:_handler(EventName, ...)

- +

Handler.

ACT_ASSIGN:_isendstate(Current)

- +

Is end state.

ACT_ASSIGN:_submap(subs, sub, name)

- +

Sub maps.

ACT_ASSIGN:can(e)

- +

Check if can do an event.

ACT_ASSIGN:cannot(e)

- +

Check if cannot do an event.

ACT_ASSIGN.current

- +

Current state name.

@@ -1942,21 +1981,21 @@ The assignment type also allows to reject the task.

-

ACT_ASSIGN:is(state)

+

ACT_ASSIGN:is(State, If, state)

- +

Check if FSM is in state.

ACT_ASSIGN.options

- +

Options.

ACT_ASSIGN.subs

- +

Subs.

@@ -4022,11 +4061,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string State

-

+ +

The FSM state.

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

ACT_ASSIGN:GetCurrentState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Return value:

+
+
+

#table:

+
+
+ +

End states.

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

Sub processes.

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

Returns a table with the scores defined.

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

Parameter:

+
+
+

+ #table + Scores +

+
+
+

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

ACT_ASSIGN:GetState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

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

Transitions.

@@ -4573,10 +4671,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

@@ -4584,15 +4682,31 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

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

ACT_ASSIGN:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -4618,11 +4732,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table CallBackTable

-

+ +

Table of call backs.

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

ACT_ASSIGN:_add_to_map(Map, Event)

- +

Add to map.

@@ -4761,21 +4878,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

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

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

- +

Call handler.

@@ -4801,43 +4924,65 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

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

ACT_ASSIGN:_create_transition(EventName)

- +

Create transition.

@@ -4861,13 +5006,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

ACT_ASSIGN:_delayed_transition(EventName)

- +

Delayed transition.

@@ -4891,13 +5050,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

ACT_ASSIGN:_eventmap(Events, EventStructure)

- +

Event map.

@@ -4921,21 +5094,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

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

ACT_ASSIGN:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -4961,23 +5140,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

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

ACT_ASSIGN:_handler(EventName, ...)

- +

Handler.

@@ -5001,11 +5197,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

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

-

+ +

Arguments.

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

ACT_ASSIGN:_isendstate(Current)

- +

Is end state.

@@ -5041,13 +5242,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

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

ACT_ASSIGN:_submap(subs, sub, name)

- +

Sub maps.

@@ -5071,31 +5294,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

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

ACT_ASSIGN:can(e)

- +

Check if can do an event.

@@ -5121,13 +5353,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

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

ACT_ASSIGN:cannot(e)

- +

Check if cannot do an event.

@@ -5151,13 +5405,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -5166,10 +5434,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

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

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Actions.Assist.html b/Documentation/Actions.Assist.html index 36e751e65..033a130db 100644 --- a/Documentation/Actions.Assist.html +++ b/Documentation/Actions.Assist.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+
+
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+
+
+
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1730,7 +1763,13 @@ At random intervals, a new target is smoked.

ACT_ASSIST.CallScheduler

- +

Call scheduler.

+ + + +

ACT_ASSIST.ClassName

+ +

Name of the class.

@@ -1742,7 +1781,7 @@ At random intervals, a new target is smoked.

ACT_ASSIST:GetCurrentState()

- +

Get current state.

@@ -1764,7 +1803,7 @@ At random intervals, a new target is smoked.

-

ACT_ASSIST:GetScores()

+

ACT_ASSIST:GetScores(Scores)

Returns a table with the scores defined.

@@ -1778,7 +1817,7 @@ At random intervals, a new target is smoked.

ACT_ASSIST:GetState()

- +

Get current state.

@@ -1794,15 +1833,15 @@ At random intervals, a new target is smoked.

-

ACT_ASSIST:Is(State)

+

ACT_ASSIST:Is(State, If)

- +

Check if FSM is in state.

ACT_ASSIST:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1814,7 +1853,7 @@ At random intervals, a new target is smoked.

ACT_ASSIST.Scores

- +

Scores.

@@ -1868,73 +1907,73 @@ At random intervals, a new target is smoked.

ACT_ASSIST:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

ACT_ASSIST:_create_transition(EventName)

- +

Create transition.

ACT_ASSIST:_delayed_transition(EventName)

- +

Delayed transition.

ACT_ASSIST:_eventmap(Events, EventStructure)

- +

Event map.

ACT_ASSIST:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

ACT_ASSIST:_handler(EventName, ...)

- +

Handler.

ACT_ASSIST:_isendstate(Current)

- +

Is end state.

ACT_ASSIST:_submap(subs, sub, name)

- +

Sub maps.

ACT_ASSIST:can(e)

- +

Check if can do an event.

ACT_ASSIST:cannot(e)

- +

Check if cannot do an event.

ACT_ASSIST.current

- +

Current state name.

@@ -1944,21 +1983,21 @@ At random intervals, a new target is smoked.

-

ACT_ASSIST:is(state)

+

ACT_ASSIST:is(State, If, state)

- +

Check if FSM is in state.

ACT_ASSIST.options

- +

Options.

ACT_ASSIST.subs

- +

Subs.

@@ -4244,11 +4283,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string State

-

+ +

The FSM state.

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

ACT_ASSIST:GetCurrentState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Return value:

+
+
+

#table:

+
+
+ +

End states.

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

Sub processes.

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

Returns a table with the scores defined.

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

Parameter:

+
+
+

+ #table + Scores +

+
+
+

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

ACT_ASSIST:GetState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

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

Transitions.

@@ -4795,10 +4893,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

@@ -4806,15 +4904,31 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

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

ACT_ASSIST:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -4840,11 +4954,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table CallBackTable

-

+ +

Table of call backs.

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

ACT_ASSIST:_add_to_map(Map, Event)

- +

Add to map.

@@ -4983,21 +5100,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

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

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

- +

Call handler.

@@ -5023,43 +5146,65 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

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

ACT_ASSIST:_create_transition(EventName)

- +

Create transition.

@@ -5083,13 +5228,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

ACT_ASSIST:_delayed_transition(EventName)

- +

Delayed transition.

@@ -5113,13 +5272,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

ACT_ASSIST:_eventmap(Events, EventStructure)

- +

Event map.

@@ -5143,21 +5316,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

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

ACT_ASSIST:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -5183,23 +5362,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

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

ACT_ASSIST:_handler(EventName, ...)

- +

Handler.

@@ -5223,11 +5419,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

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

-

+ +

Arguments.

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

ACT_ASSIST:_isendstate(Current)

- +

Is end state.

@@ -5263,13 +5464,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

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

ACT_ASSIST:_submap(subs, sub, name)

- +

Sub maps.

@@ -5293,31 +5516,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

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

ACT_ASSIST:can(e)

- +

Check if can do an event.

@@ -5343,13 +5575,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

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

ACT_ASSIST:cannot(e)

- +

Check if cannot do an event.

@@ -5373,13 +5627,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -5388,10 +5656,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

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

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Actions.Route.html b/Documentation/Actions.Route.html index a99e52df5..25c82addf 100644 --- a/Documentation/Actions.Route.html +++ b/Documentation/Actions.Route.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1787,7 +1820,13 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil

ACT_ROUTE.CallScheduler

- +

Call scheduler.

+ + + +

ACT_ROUTE.ClassName

+ +

Name of the class.

@@ -1799,7 +1838,7 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil

ACT_ROUTE:GetCurrentState()

- +

Get current state.

@@ -1821,7 +1860,7 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil -

ACT_ROUTE:GetScores()

+

ACT_ROUTE:GetScores(Scores)

Returns a table with the scores defined.

@@ -1835,7 +1874,7 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil

ACT_ROUTE:GetState()

- +

Get current state.

@@ -1851,15 +1890,15 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil -

ACT_ROUTE:Is(State)

+

ACT_ROUTE:Is(State, If)

- +

Check if FSM is in state.

ACT_ROUTE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1871,7 +1910,7 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil

ACT_ROUTE.Scores

- +

Scores.

@@ -1925,73 +1964,73 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil

ACT_ROUTE:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

ACT_ROUTE:_create_transition(EventName)

- +

Create transition.

ACT_ROUTE:_delayed_transition(EventName)

- +

Delayed transition.

ACT_ROUTE:_eventmap(Events, EventStructure)

- +

Event map.

ACT_ROUTE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

ACT_ROUTE:_handler(EventName, ...)

- +

Handler.

ACT_ROUTE:_isendstate(Current)

- +

Is end state.

ACT_ROUTE:_submap(subs, sub, name)

- +

Sub maps.

ACT_ROUTE:can(e)

- +

Check if can do an event.

ACT_ROUTE:cannot(e)

- +

Check if cannot do an event.

ACT_ROUTE.current

- +

Current state name.

@@ -2001,21 +2040,21 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil -

ACT_ROUTE:is(state)

+

ACT_ROUTE:is(State, If, state)

- +

Check if FSM is in state.

ACT_ROUTE.options

- +

Options.

ACT_ROUTE.subs

- +

Subs.

@@ -4664,11 +4703,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string State

-

+ +

The FSM state.

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

ACT_ROUTE:GetCurrentState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

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

Sub processes.

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

Returns a table with the scores defined.

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

Parameter:

+
+
+

+ #table + Scores +

+
+
+

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

ACT_ROUTE:GetState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

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

Transitions.

@@ -5215,10 +5313,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

@@ -5226,15 +5324,31 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

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

ACT_ROUTE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -5260,11 +5374,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table CallBackTable

-

+ +

Table of call backs.

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

ACT_ROUTE:_add_to_map(Map, Event)

- +

Add to map.

@@ -5403,21 +5520,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

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

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

- +

Call handler.

@@ -5443,43 +5566,65 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

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

ACT_ROUTE:_create_transition(EventName)

- +

Create transition.

@@ -5503,13 +5648,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

ACT_ROUTE:_delayed_transition(EventName)

- +

Delayed transition.

@@ -5533,13 +5692,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

ACT_ROUTE:_eventmap(Events, EventStructure)

- +

Event map.

@@ -5563,21 +5736,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

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

ACT_ROUTE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -5603,23 +5782,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

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

ACT_ROUTE:_handler(EventName, ...)

- +

Handler.

@@ -5643,11 +5839,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

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

-

+ +

Arguments.

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

ACT_ROUTE:_isendstate(Current)

- +

Is end state.

@@ -5683,13 +5884,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

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

ACT_ROUTE:_submap(subs, sub, name)

- +

Sub maps.

@@ -5713,31 +5936,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

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

ACT_ROUTE:can(e)

- +

Check if can do an event.

@@ -5763,13 +5995,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

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

ACT_ROUTE:cannot(e)

- +

Check if cannot do an event.

@@ -5793,13 +6047,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -5808,10 +6076,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

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

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Cargo.Cargo.html b/Documentation/Cargo.Cargo.html index e490b6301..6bd49e296 100644 --- a/Documentation/Cargo.Cargo.html +++ b/Documentation/Cargo.Cargo.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2512,7 +2545,13 @@ All derived classes from CARGO follow the same state machine, expose the same ca

CARGO.CallScheduler

- +

Call scheduler.

+ + + +

CARGO.ClassName

+ +

Name of the class.

@@ -2524,7 +2563,7 @@ All derived classes from CARGO follow the same state machine, expose the same ca

CARGO:GetCurrentState()

- +

Get current state.

@@ -2546,7 +2585,7 @@ All derived classes from CARGO follow the same state machine, expose the same ca -

CARGO:GetScores()

+

CARGO:GetScores(Scores)

Returns a table with the scores defined.

@@ -2560,7 +2599,7 @@ All derived classes from CARGO follow the same state machine, expose the same ca

CARGO:GetState()

- +

Get current state.

@@ -2576,15 +2615,15 @@ All derived classes from CARGO follow the same state machine, expose the same ca -

CARGO:Is(State)

+

CARGO:Is(State, If)

- +

Check if FSM is in state.

CARGO:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2596,7 +2635,7 @@ All derived classes from CARGO follow the same state machine, expose the same ca

CARGO.Scores

- +

Scores.

@@ -2650,73 +2689,73 @@ All derived classes from CARGO follow the same state machine, expose the same ca

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.

@@ -2726,21 +2765,21 @@ All derived classes from CARGO follow the same state machine, expose the same ca -

CARGO:is(state)

+

CARGO:is(State, If, state)

- +

Check if FSM is in state.

CARGO.options

- +

Options.

CARGO.subs

- +

Subs.

@@ -7905,11 +7944,14 @@ The cargo must be in the Loaded state.

+ #string State

-

+ +

The FSM state.

+
@@ -8234,7 +8276,7 @@ The cargo must be in the Loaded state.

CARGO:GetCurrentState()

- +

Get current state.

@@ -8242,6 +8284,17 @@ The cargo must be in the Loaded state.

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -8261,6 +8314,17 @@ The cargo must be in the Loaded state.

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -8327,7 +8391,7 @@ The cargo must be in the Loaded state.

- +

Sub processes.

@@ -8339,7 +8403,7 @@ The cargo must be in the Loaded state.

Returns a table with the scores defined.

@@ -8350,6 +8414,18 @@ The cargo must be in the Loaded state.

+

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -8391,7 +8467,7 @@ The cargo must be in the Loaded state.

CARGO:GetState()

- +

Get current state.

@@ -8399,6 +8475,17 @@ The cargo must be in the Loaded state.

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -8418,6 +8505,17 @@ The cargo must be in the Loaded state.

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -8444,7 +8542,7 @@ The cargo must be in the Loaded state.

- +

Transitions.

@@ -8456,10 +8554,10 @@ The cargo must be in the Loaded state.

- +

Check if FSM is in state.

@@ -8467,15 +8565,31 @@ The cargo must be in the Loaded state.

-

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -8489,7 +8603,7 @@ The cargo must be in the Loaded state.

CARGO:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -8501,11 +8615,14 @@ The cargo must be in the Loaded state.

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -8632,7 +8749,7 @@ The cargo must be in the Loaded state.

CARGO:_add_to_map(Map, Event)

- +

Add to map.

@@ -8644,21 +8761,27 @@ The cargo must be in the Loaded state.

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -8672,7 +8795,7 @@ The cargo must be in the Loaded state.

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

- +

Call handler.

@@ -8684,43 +8807,65 @@ The cargo must be in the Loaded state.

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -8732,7 +8877,7 @@ The cargo must be in the Loaded state.

CARGO:_create_transition(EventName)

- +

Create transition.

@@ -8744,13 +8889,27 @@ The cargo must be in the Loaded state.

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -8762,7 +8921,7 @@ The cargo must be in the Loaded state.

CARGO:_delayed_transition(EventName)

- +

Delayed transition.

@@ -8774,13 +8933,27 @@ The cargo must be in the Loaded state.

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -8792,7 +8965,7 @@ The cargo must be in the Loaded state.

CARGO:_eventmap(Events, EventStructure)

- +

Event map.

@@ -8804,21 +8977,27 @@ The cargo must be in the Loaded state.

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -8832,7 +9011,7 @@ The cargo must be in the Loaded state.

CARGO:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -8844,23 +9023,40 @@ The cargo must be in the Loaded state.

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -8872,7 +9068,7 @@ The cargo must be in the Loaded state.

CARGO:_handler(EventName, ...)

- +

Handler.

@@ -8884,11 +9080,14 @@ The cargo must be in the Loaded state.

+ #string EventName

-

+ +

Event name.

+
@@ -8898,7 +9097,9 @@ The cargo must be in the Loaded state.

-

+ +

Arguments.

+
@@ -8912,7 +9113,7 @@ The cargo must be in the Loaded state.

CARGO:_isendstate(Current)

- +

Is end state.

@@ -8924,13 +9125,35 @@ The cargo must be in the Loaded state.

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -8942,7 +9165,7 @@ The cargo must be in the Loaded state.

CARGO:_submap(subs, sub, name)

- +

Sub maps.

@@ -8954,31 +9177,40 @@ The cargo must be in the Loaded state.

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -8992,7 +9224,7 @@ The cargo must be in the Loaded state.

CARGO:can(e)

- +

Check if can do an event.

@@ -9004,13 +9236,35 @@ The cargo must be in the Loaded state.

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -9022,7 +9276,7 @@ The cargo must be in the Loaded state.

CARGO:cannot(e)

- +

Check if cannot do an event.

@@ -9034,13 +9288,27 @@ The cargo must be in the Loaded state.

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -9049,10 +9317,10 @@ The cargo must be in the Loaded state.

- +

Check if FSM is in state.

@@ -9060,7 +9328,33 @@ The cargo must be in the Loaded state.

-

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Cargo.CargoCrate.html b/Documentation/Cargo.CargoCrate.html index 66e485def..3017bfc4b 100644 --- a/Documentation/Cargo.CargoCrate.html +++ b/Documentation/Cargo.CargoCrate.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index a752ca1d4..0130ddc71 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1647,20 +1680,6 @@
-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- - -
-
- - CARGO_GROUP.CargoGroup @@ -2993,20 +3012,6 @@ This works for ground only groups.

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- -
-
-
- - CARGO_GROUP.CargoGroup diff --git a/Documentation/Cargo.CargoSlingload.html b/Documentation/Cargo.CargoSlingload.html index b301b9fac..da0d2bb61 100644 --- a/Documentation/Cargo.CargoSlingload.html +++ b/Documentation/Cargo.CargoSlingload.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index 02a0c94ed..dcbb04c6c 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1525,6 +1558,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
+CARGO_UNIT.CargoCarrier + + + +
+ + +
+
+ + CARGO_UNIT.CargoInAir @@ -2226,6 +2270,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles + +
+
+
+ + CARGO_UNIT.CargoInAir diff --git a/Documentation/Core.Base.html b/Documentation/Core.Base.html index 87f15519f..668a7bf1f 100644 --- a/Documentation/Core.Base.html +++ b/Documentation/Core.Base.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Core.Database.html b/Documentation/Core.Database.html index b6ec6f369..36e1dda31 100644 --- a/Documentation/Core.Database.html +++ b/Documentation/Core.Database.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1439,6 +1472,18 @@ Moose refers to _DATABASE within the framework extensively, but

DATABASE:AddClient(ClientName)

Adds a CLIENT based on the ClientName in the DATABASE.

+ + + +

DATABASE:AddFlightControl(flightcontrol)

+ +

Add a flight control to the data base.

+ + + +

DATABASE:AddFlightGroup(flightgroup)

+ +

Add a flight group to the data base.

@@ -1649,6 +1694,18 @@ Moose refers to _DATABASE within the framework extensively, but

DATABASE:GetCountryFromClientTemplate(ClientName)

+ + + +

DATABASE:GetFlightControl(airbasename)

+ +

Get a flight control object from the data base.

+ + + +

DATABASE:GetFlightGroup(groupname)

+ +

Get a flight group from the data base.

@@ -1810,7 +1867,7 @@ Moose refers to _DATABASE within the framework extensively, but

DATABASE:_RegisterAirbases()

- +

Register all world airbases.

@@ -2581,6 +2638,68 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+ + + +

Add a flight control to the data base.

+ +
+
+

Defined in:

+
+

DATABASE

+
+

Parameter:

+
+
+

+ Ops.FlightControl#FLIGHTCONTROL + flightcontrol +

+
+
+

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

Add a flight group to the data base.

+ +
+
+

Defined in:

+
+

DATABASE

+
+

Parameter:

+
+
+

+ Ops.FlightGroup#FLIGHTGROUP + flightgroup +

+
+
+

+
+
+
+
@@ -4091,6 +4210,94 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+ + + +

Get a flight control object from the data base.

+ +
+
+

Defined in:

+
+

DATABASE

+
+

Parameter:

+
+
+

+ #string + airbasename +

+
+
+ +

Name of the associated airbase.

+ +
+
+

Return value:

+
+ +
+ +

The FLIGHTCONTROL object.s

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

Get a flight group from the data base.

+ +
+
+

Defined in:

+
+

DATABASE

+
+

Parameter:

+
+
+

+ #string + groupname +

+
+
+ +

Group name of the flight group. Can also be passed as GROUP object.

+ +
+
+

Return value:

+
+ +
+ +

Flight group object.

+ +
+
+
+
@@ -4875,7 +5082,7 @@ This method is used by the SPAWN class.

DATABASE:_RegisterAirbases()

- +

Register all world airbases.

@@ -4883,6 +5090,17 @@ This method is used by the SPAWN class.

DATABASE

+

Return value:

+
+
+

#DATABASE:

+
+
+ +

self

+ +
+
diff --git a/Documentation/Core.Event.html b/Documentation/Core.Event.html index be929bd86..616119ec3 100644 --- a/Documentation/Core.Event.html +++ b/Documentation/Core.Event.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index 0a1d75a42..151944256 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1403,7 +1436,7 @@ Additionally, I've added extendability and created an API that allows seamless F

Author: FlightControl

-

Contributions:

+

Contributions: funkyfranky


@@ -1864,7 +1897,13 @@ for multiple objects or the position of the state machine in the process.

FSM.CallScheduler

- +

Call scheduler.

+ + + +

FSM.ClassName

+ +

Name of the class.

@@ -1876,7 +1915,7 @@ for multiple objects or the position of the state machine in the process.

FSM:GetCurrentState()

- +

Get current state.

@@ -1898,7 +1937,7 @@ for multiple objects or the position of the state machine in the process.

-

FSM:GetScores()

+

FSM:GetScores(Scores)

Returns a table with the scores defined.

@@ -1912,7 +1951,7 @@ for multiple objects or the position of the state machine in the process.

FSM:GetState()

- +

Get current state.

@@ -1928,15 +1967,15 @@ for multiple objects or the position of the state machine in the process.

-

FSM:Is(State)

+

FSM:Is(State, If)

- +

Check if FSM is in state.

FSM:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1948,7 +1987,7 @@ for multiple objects or the position of the state machine in the process.

FSM.Scores

- +

Scores.

@@ -2002,73 +2041,73 @@ for multiple objects or the position of the state machine in the process.

FSM:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

FSM:_create_transition(EventName)

- +

Create transition.

FSM:_delayed_transition(EventName)

- +

Delayed transition.

FSM:_eventmap(Events, EventStructure)

- +

Event map.

FSM:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

FSM:_handler(EventName, ...)

- +

Handler.

FSM:_isendstate(Current)

- +

Is end state.

FSM:_submap(subs, sub, name)

- +

Sub maps.

FSM:can(e)

- +

Check if can do an event.

FSM:cannot(e)

- +

Check if cannot do an event.

FSM.current

- +

Current state name.

@@ -2078,21 +2117,21 @@ for multiple objects or the position of the state machine in the process.

-

FSM:is(state)

+

FSM:is(State, If, state)

- +

Check if FSM is in state.

FSM.options

- +

Options.

FSM.subs

- +

Subs.

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

FSM_CONTROLLABLE.CallScheduler

- +

Call scheduler.

+ + + +

FSM_CONTROLLABLE.ClassName

+ +

Name of the class.

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

FSM_CONTROLLABLE:GetCurrentState()

- +

Get current state.

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

FSM_CONTROLLABLE:GetScores()

+

FSM_CONTROLLABLE:GetScores(Scores)

Returns a table with the scores defined.

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

FSM_CONTROLLABLE:GetState()

- +

Get current state.

@@ -2768,15 +2813,15 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

FSM_CONTROLLABLE:Is(State)

+

FSM_CONTROLLABLE:Is(State, If)

- +

Check if FSM is in state.

FSM_CONTROLLABLE:LoadCallBacks(CallBackTable)

- +

Load call backs.

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

FSM_CONTROLLABLE.Scores

- +

Scores.

@@ -2842,73 +2887,73 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

FSM_CONTROLLABLE:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

FSM_CONTROLLABLE:_create_transition(EventName)

- +

Create transition.

FSM_CONTROLLABLE:_delayed_transition(EventName)

- +

Delayed transition.

FSM_CONTROLLABLE:_eventmap(Events, EventStructure)

- +

Event map.

FSM_CONTROLLABLE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

FSM_CONTROLLABLE:_handler(EventName, ...)

- +

Handler.

FSM_CONTROLLABLE:_isendstate(Current)

- +

Is end state.

FSM_CONTROLLABLE:_submap(subs, sub, name)

- +

Sub maps.

FSM_CONTROLLABLE:can(e)

- +

Check if can do an event.

FSM_CONTROLLABLE:cannot(e)

- +

Check if cannot do an event.

FSM_CONTROLLABLE.current

- +

Current state name.

@@ -2918,21 +2963,21 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

FSM_CONTROLLABLE:is(state)

+

FSM_CONTROLLABLE:is(State, If, state)

- +

Check if FSM is in state.

FSM_CONTROLLABLE.options

- +

Options.

FSM_CONTROLLABLE.subs

- +

Subs.

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

FSM_PROCESS.CallScheduler

- +

Call scheduler.

+ + + +

FSM_PROCESS.ClassName

+ +

Name of the class.

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

FSM_PROCESS:GetCurrentState()

- +

Get current state.

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

FSM_PROCESS:GetScores()

+

FSM_PROCESS:GetScores(Scores)

Returns a table with the scores defined.

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

FSM_PROCESS:GetState()

- +

Get current state.

@@ -3701,15 +3752,15 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

FSM_PROCESS:Is(State)

+

FSM_PROCESS:Is(State, If)

- +

Check if FSM is in state.

FSM_PROCESS:LoadCallBacks(CallBackTable)

- +

Load call backs.

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

FSM_PROCESS.Scores

- +

Scores.

@@ -3775,73 +3826,73 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

FSM_PROCESS:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

FSM_PROCESS:_create_transition(EventName)

- +

Create transition.

FSM_PROCESS:_delayed_transition(EventName)

- +

Delayed transition.

FSM_PROCESS:_eventmap(Events, EventStructure)

- +

Event map.

FSM_PROCESS:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

FSM_PROCESS:_handler(EventName, ...)

- +

Handler.

FSM_PROCESS:_isendstate(Current)

- +

Is end state.

FSM_PROCESS:_submap(subs, sub, name)

- +

Sub maps.

FSM_PROCESS:can(e)

- +

Check if can do an event.

FSM_PROCESS:cannot(e)

- +

Check if cannot do an event.

FSM_PROCESS.current

- +

Current state name.

@@ -3851,21 +3902,21 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

FSM_PROCESS:is(state)

+

FSM_PROCESS:is(State, If, state)

- +

Check if FSM is in state.

FSM_PROCESS.options

- +

Options.

FSM_PROCESS.subs

- +

Subs.

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

FSM_SET.CallScheduler

- +

Call scheduler.

+ + + +

FSM_SET.ClassName

+ +

Name of the class.

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

FSM_SET:GetCurrentState()

- +

Get current state.

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

FSM_SET:GetScores()

+

FSM_SET:GetScores(Scores)

Returns a table with the scores defined.

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

FSM_SET:GetState()

- +

Get current state.

@@ -4499,15 +4556,15 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

FSM_SET:Is(State)

+

FSM_SET:Is(State, If)

- +

Check if FSM is in state.

FSM_SET:LoadCallBacks(CallBackTable)

- +

Load call backs.

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

FSM_SET.Scores

- +

Scores.

@@ -4573,73 +4630,73 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

FSM_SET:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

FSM_SET:_create_transition(EventName)

- +

Create transition.

FSM_SET:_delayed_transition(EventName)

- +

Delayed transition.

FSM_SET:_eventmap(Events, EventStructure)

- +

Event map.

FSM_SET:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

FSM_SET:_handler(EventName, ...)

- +

Handler.

FSM_SET:_isendstate(Current)

- +

Is end state.

FSM_SET:_submap(subs, sub, name)

- +

Sub maps.

FSM_SET:can(e)

- +

Check if can do an event.

FSM_SET:cannot(e)

- +

Check if cannot do an event.

FSM_SET.current

- +

Current state name.

@@ -4649,21 +4706,21 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

FSM_SET:is(state)

+

FSM_SET:is(State, If, state)

- +

Check if FSM is in state.

FSM_SET.options

- +

Options.

FSM_SET.subs

- +

Subs.

@@ -5203,10 +5260,21 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+ +
+
+
+ + #string +FSM.ClassName + +

Name of the class.

@@ -5228,7 +5296,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #table FSM.Scores - +

Scores.

@@ -5302,10 +5370,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM.current - +

Current state name.

@@ -5318,6 +5386,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ + +
+
+ + #table +FSM.options + +

Options.

+
@@ -5327,7 +5406,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #table FSM.subs - +

Subs.

@@ -5353,11 +5432,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string State

-

+ +

The FSM state.

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

FSM:GetCurrentState()

- +

Get current state.

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

FSM

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

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

Sub processes.

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

Returns a table with the scores defined.

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

FSM

+

Parameter:

+
+
+

+ #table + Scores +

+
+
+

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

FSM:GetState()

- +

Get current state.

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

FSM

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

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

Transitions.

@@ -5904,10 +6042,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

@@ -5915,15 +6053,31 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

FSM

-

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

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

FSM:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -5949,11 +6103,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table CallBackTable

-

+ +

Table of call backs.

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

FSM:_add_to_map(Map, Event)

- +

Add to map.

@@ -6092,21 +6249,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

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

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

- +

Call handler.

@@ -6132,43 +6295,65 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

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

FSM:_create_transition(EventName)

- +

Create transition.

@@ -6192,13 +6377,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

FSM:_delayed_transition(EventName)

- +

Delayed transition.

@@ -6222,13 +6421,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

FSM:_eventmap(Events, EventStructure)

- +

Event map.

@@ -6252,21 +6465,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

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

FSM:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -6292,23 +6511,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

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

FSM:_handler(EventName, ...)

- +

Handler.

@@ -6332,11 +6568,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

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

-

+ +

Arguments.

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

FSM:_isendstate(Current)

- +

Is end state.

@@ -6372,13 +6613,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

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

FSM:_submap(subs, sub, name)

- +

Sub maps.

@@ -6402,31 +6665,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

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

FSM:can(e)

- +

Check if can do an event.

@@ -6452,13 +6724,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

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

FSM:cannot(e)

- +

Check if cannot do an event.

@@ -6482,13 +6776,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -6497,10 +6805,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

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

FSM

-

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

@@ -6530,10 +6864,21 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ +
+
+
+ + #string +FSM.ClassName + +

Name of the class.

@@ -6555,7 +6900,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #table FSM.Scores - +

Scores.

@@ -6629,10 +6974,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM.current - +

Current state name.

@@ -6645,6 +6990,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #table +FSM.options + +

Options.

+
@@ -6654,7 +7010,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #table FSM.subs - +

Subs.

@@ -10259,11 +10615,14 @@ BASE:TraceOnOff( false )

+ #string State

-

+ +

The FSM state.

+
@@ -10588,7 +10947,7 @@ BASE:TraceOnOff( false )

FSM_CONTROLLABLE:GetCurrentState()

- +

Get current state.

@@ -10596,6 +10955,17 @@ BASE:TraceOnOff( false ) +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -10615,6 +10985,17 @@ BASE:TraceOnOff( false ) +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -10681,7 +11062,7 @@ BASE:TraceOnOff( false )
- +

Sub processes.

@@ -10693,7 +11074,7 @@ BASE:TraceOnOff( false )

Returns a table with the scores defined.

@@ -10704,6 +11085,18 @@ BASE:TraceOnOff( false ) +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -10745,7 +11138,7 @@ BASE:TraceOnOff( false )

FSM_CONTROLLABLE:GetState()

- +

Get current state.

@@ -10753,6 +11146,17 @@ BASE:TraceOnOff( false ) +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -10772,6 +11176,17 @@ BASE:TraceOnOff( false )

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -10798,7 +11213,7 @@ BASE:TraceOnOff( false )
- +

Transitions.

@@ -10810,10 +11225,10 @@ BASE:TraceOnOff( false )
- +

Check if FSM is in state.

@@ -10821,15 +11236,31 @@ BASE:TraceOnOff( false ) -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -10843,7 +11274,7 @@ BASE:TraceOnOff( false )

FSM_CONTROLLABLE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -10855,11 +11286,14 @@ BASE:TraceOnOff( false )

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -10986,7 +11420,7 @@ BASE:TraceOnOff( false )

FSM_CONTROLLABLE:_add_to_map(Map, Event)

- +

Add to map.

@@ -10998,21 +11432,27 @@ BASE:TraceOnOff( false )

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -11026,7 +11466,7 @@ BASE:TraceOnOff( false )

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

- +

Call handler.

@@ -11038,43 +11478,65 @@ BASE:TraceOnOff( false )

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -11086,7 +11548,7 @@ BASE:TraceOnOff( false )

FSM_CONTROLLABLE:_create_transition(EventName)

- +

Create transition.

@@ -11098,13 +11560,27 @@ BASE:TraceOnOff( false )

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -11116,7 +11592,7 @@ BASE:TraceOnOff( false )

FSM_CONTROLLABLE:_delayed_transition(EventName)

- +

Delayed transition.

@@ -11128,13 +11604,27 @@ BASE:TraceOnOff( false )

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -11146,7 +11636,7 @@ BASE:TraceOnOff( false )

FSM_CONTROLLABLE:_eventmap(Events, EventStructure)

- +

Event map.

@@ -11158,21 +11648,27 @@ BASE:TraceOnOff( false )

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -11186,7 +11682,7 @@ BASE:TraceOnOff( false )

FSM_CONTROLLABLE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -11198,23 +11694,40 @@ BASE:TraceOnOff( false )

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -11226,7 +11739,7 @@ BASE:TraceOnOff( false )

FSM_CONTROLLABLE:_handler(EventName, ...)

- +

Handler.

@@ -11238,11 +11751,14 @@ BASE:TraceOnOff( false )

+ #string EventName

-

+ +

Event name.

+
@@ -11252,7 +11768,9 @@ BASE:TraceOnOff( false )

-

+ +

Arguments.

+
@@ -11266,7 +11784,7 @@ BASE:TraceOnOff( false )

FSM_CONTROLLABLE:_isendstate(Current)

- +

Is end state.

@@ -11278,13 +11796,35 @@ BASE:TraceOnOff( false )

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -11296,7 +11836,7 @@ BASE:TraceOnOff( false )

FSM_CONTROLLABLE:_submap(subs, sub, name)

- +

Sub maps.

@@ -11308,31 +11848,40 @@ BASE:TraceOnOff( false )

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -11346,7 +11895,7 @@ BASE:TraceOnOff( false )

FSM_CONTROLLABLE:can(e)

- +

Check if can do an event.

@@ -11358,13 +11907,35 @@ BASE:TraceOnOff( false )

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -11376,7 +11947,7 @@ BASE:TraceOnOff( false )

FSM_CONTROLLABLE:cannot(e)

- +

Check if cannot do an event.

@@ -11388,13 +11959,27 @@ BASE:TraceOnOff( false )

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -11403,10 +11988,10 @@ BASE:TraceOnOff( false )
- +

Check if FSM is in state.

@@ -11414,7 +11999,33 @@ BASE:TraceOnOff( false ) -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

@@ -15642,11 +16253,14 @@ BASE:TraceOnOff( false )

+ #string State

-

+ +

The FSM state.

+
@@ -15971,7 +16585,7 @@ BASE:TraceOnOff( false )

FSM_PROCESS:GetCurrentState()

- +

Get current state.

@@ -15979,6 +16593,17 @@ BASE:TraceOnOff( false ) +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -15998,6 +16623,17 @@ BASE:TraceOnOff( false ) +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -16064,7 +16700,7 @@ BASE:TraceOnOff( false )
- +

Sub processes.

@@ -16076,7 +16712,7 @@ BASE:TraceOnOff( false )

Returns a table with the scores defined.

@@ -16087,6 +16723,18 @@ BASE:TraceOnOff( false ) +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -16128,7 +16776,7 @@ BASE:TraceOnOff( false )

FSM_PROCESS:GetState()

- +

Get current state.

@@ -16136,6 +16784,17 @@ BASE:TraceOnOff( false ) +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -16155,6 +16814,17 @@ BASE:TraceOnOff( false )

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -16181,7 +16851,7 @@ BASE:TraceOnOff( false )
- +

Transitions.

@@ -16193,10 +16863,10 @@ BASE:TraceOnOff( false )
- +

Check if FSM is in state.

@@ -16204,15 +16874,31 @@ BASE:TraceOnOff( false ) -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -16226,7 +16912,7 @@ BASE:TraceOnOff( false )

FSM_PROCESS:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -16238,11 +16924,14 @@ BASE:TraceOnOff( false )

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -16369,7 +17058,7 @@ BASE:TraceOnOff( false )

FSM_PROCESS:_add_to_map(Map, Event)

- +

Add to map.

@@ -16381,21 +17070,27 @@ BASE:TraceOnOff( false )

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -16409,7 +17104,7 @@ BASE:TraceOnOff( false )

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

- +

Call handler.

@@ -16421,43 +17116,65 @@ BASE:TraceOnOff( false )

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -16469,7 +17186,7 @@ BASE:TraceOnOff( false )

FSM_PROCESS:_create_transition(EventName)

- +

Create transition.

@@ -16481,13 +17198,27 @@ BASE:TraceOnOff( false )

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -16499,7 +17230,7 @@ BASE:TraceOnOff( false )

FSM_PROCESS:_delayed_transition(EventName)

- +

Delayed transition.

@@ -16511,13 +17242,27 @@ BASE:TraceOnOff( false )

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -16529,7 +17274,7 @@ BASE:TraceOnOff( false )

FSM_PROCESS:_eventmap(Events, EventStructure)

- +

Event map.

@@ -16541,21 +17286,27 @@ BASE:TraceOnOff( false )

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -16569,7 +17320,7 @@ BASE:TraceOnOff( false )

FSM_PROCESS:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -16581,23 +17332,40 @@ BASE:TraceOnOff( false )

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -16609,7 +17377,7 @@ BASE:TraceOnOff( false )

FSM_PROCESS:_handler(EventName, ...)

- +

Handler.

@@ -16621,11 +17389,14 @@ BASE:TraceOnOff( false )

+ #string EventName

-

+ +

Event name.

+
@@ -16635,7 +17406,9 @@ BASE:TraceOnOff( false )

-

+ +

Arguments.

+
@@ -16649,7 +17422,7 @@ BASE:TraceOnOff( false )

FSM_PROCESS:_isendstate(Current)

- +

Is end state.

@@ -16661,13 +17434,35 @@ BASE:TraceOnOff( false )

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -16679,7 +17474,7 @@ BASE:TraceOnOff( false )

FSM_PROCESS:_submap(subs, sub, name)

- +

Sub maps.

@@ -16691,31 +17486,40 @@ BASE:TraceOnOff( false )

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -16729,7 +17533,7 @@ BASE:TraceOnOff( false )

FSM_PROCESS:can(e)

- +

Check if can do an event.

@@ -16741,13 +17545,35 @@ BASE:TraceOnOff( false )

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -16759,7 +17585,7 @@ BASE:TraceOnOff( false )

FSM_PROCESS:cannot(e)

- +

Check if cannot do an event.

@@ -16771,13 +17597,27 @@ BASE:TraceOnOff( false )

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -16786,10 +17626,10 @@ BASE:TraceOnOff( false )
- +

Check if FSM is in state.

@@ -16797,7 +17637,33 @@ BASE:TraceOnOff( false ) -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

@@ -20035,11 +20901,14 @@ BASE:TraceOnOff( false )

+ #string State

-

+ +

The FSM state.

+
@@ -20364,7 +21233,7 @@ BASE:TraceOnOff( false )

FSM_SET:GetCurrentState()

- +

Get current state.

@@ -20372,6 +21241,17 @@ BASE:TraceOnOff( false ) +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -20391,6 +21271,17 @@ BASE:TraceOnOff( false ) +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -20457,7 +21348,7 @@ BASE:TraceOnOff( false )
- +

Sub processes.

@@ -20469,7 +21360,7 @@ BASE:TraceOnOff( false )

Returns a table with the scores defined.

@@ -20480,6 +21371,18 @@ BASE:TraceOnOff( false ) +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -20521,7 +21424,7 @@ BASE:TraceOnOff( false )

FSM_SET:GetState()

- +

Get current state.

@@ -20529,6 +21432,17 @@ BASE:TraceOnOff( false ) +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -20548,6 +21462,17 @@ BASE:TraceOnOff( false )

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -20574,7 +21499,7 @@ BASE:TraceOnOff( false )
- +

Transitions.

@@ -20586,10 +21511,10 @@ BASE:TraceOnOff( false )
- +

Check if FSM is in state.

@@ -20597,15 +21522,31 @@ BASE:TraceOnOff( false ) -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -20619,7 +21560,7 @@ BASE:TraceOnOff( false )

FSM_SET:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -20631,11 +21572,14 @@ BASE:TraceOnOff( false )

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -20762,7 +21706,7 @@ BASE:TraceOnOff( false )

FSM_SET:_add_to_map(Map, Event)

- +

Add to map.

@@ -20774,21 +21718,27 @@ BASE:TraceOnOff( false )

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -20802,7 +21752,7 @@ BASE:TraceOnOff( false )

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

- +

Call handler.

@@ -20814,43 +21764,65 @@ BASE:TraceOnOff( false )

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -20862,7 +21834,7 @@ BASE:TraceOnOff( false )

FSM_SET:_create_transition(EventName)

- +

Create transition.

@@ -20874,13 +21846,27 @@ BASE:TraceOnOff( false )

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -20892,7 +21878,7 @@ BASE:TraceOnOff( false )

FSM_SET:_delayed_transition(EventName)

- +

Delayed transition.

@@ -20904,13 +21890,27 @@ BASE:TraceOnOff( false )

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -20922,7 +21922,7 @@ BASE:TraceOnOff( false )

FSM_SET:_eventmap(Events, EventStructure)

- +

Event map.

@@ -20934,21 +21934,27 @@ BASE:TraceOnOff( false )

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -20962,7 +21968,7 @@ BASE:TraceOnOff( false )

FSM_SET:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -20974,23 +21980,40 @@ BASE:TraceOnOff( false )

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -21002,7 +22025,7 @@ BASE:TraceOnOff( false )

FSM_SET:_handler(EventName, ...)

- +

Handler.

@@ -21014,11 +22037,14 @@ BASE:TraceOnOff( false )

+ #string EventName

-

+ +

Event name.

+
@@ -21028,7 +22054,9 @@ BASE:TraceOnOff( false )

-

+ +

Arguments.

+
@@ -21042,7 +22070,7 @@ BASE:TraceOnOff( false )

FSM_SET:_isendstate(Current)

- +

Is end state.

@@ -21054,13 +22082,35 @@ BASE:TraceOnOff( false )

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -21072,7 +22122,7 @@ BASE:TraceOnOff( false )

FSM_SET:_submap(subs, sub, name)

- +

Sub maps.

@@ -21084,31 +22134,40 @@ BASE:TraceOnOff( false )

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -21122,7 +22181,7 @@ BASE:TraceOnOff( false )

FSM_SET:can(e)

- +

Check if can do an event.

@@ -21134,13 +22193,35 @@ BASE:TraceOnOff( false )

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -21152,7 +22233,7 @@ BASE:TraceOnOff( false )

FSM_SET:cannot(e)

- +

Check if cannot do an event.

@@ -21164,13 +22245,27 @@ BASE:TraceOnOff( false )

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -21179,10 +22274,10 @@ BASE:TraceOnOff( false )
- +

Check if FSM is in state.

@@ -21190,7 +22285,33 @@ BASE:TraceOnOff( false ) -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Core.Goal.html b/Documentation/Core.Goal.html index 091567c8a..551b8006a 100644 --- a/Documentation/Core.Goal.html +++ b/Documentation/Core.Goal.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1553,7 +1586,13 @@ You can use this method to check asynchronously if a goal has been achieved, for

GOAL.CallScheduler

- +

Call scheduler.

+ + + +

GOAL.ClassName

+ +

Name of the class.

@@ -1565,7 +1604,7 @@ You can use this method to check asynchronously if a goal has been achieved, for

GOAL:GetCurrentState()

- +

Get current state.

@@ -1587,7 +1626,7 @@ You can use this method to check asynchronously if a goal has been achieved, for -

GOAL:GetScores()

+

GOAL:GetScores(Scores)

Returns a table with the scores defined.

@@ -1601,7 +1640,7 @@ You can use this method to check asynchronously if a goal has been achieved, for

GOAL:GetState()

- +

Get current state.

@@ -1617,15 +1656,15 @@ You can use this method to check asynchronously if a goal has been achieved, for -

GOAL:Is(State)

+

GOAL:Is(State, If)

- +

Check if FSM is in state.

GOAL:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1637,7 +1676,7 @@ You can use this method to check asynchronously if a goal has been achieved, for

GOAL.Scores

- +

Scores.

@@ -1691,73 +1730,73 @@ You can use this method to check asynchronously if a goal has been achieved, for

GOAL:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

GOAL:_create_transition(EventName)

- +

Create transition.

GOAL:_delayed_transition(EventName)

- +

Delayed transition.

GOAL:_eventmap(Events, EventStructure)

- +

Event map.

GOAL:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

GOAL:_handler(EventName, ...)

- +

Handler.

GOAL:_isendstate(Current)

- +

Is end state.

GOAL:_submap(subs, sub, name)

- +

Sub maps.

GOAL:can(e)

- +

Check if can do an event.

GOAL:cannot(e)

- +

Check if cannot do an event.

GOAL.current

- +

Current state name.

@@ -1767,21 +1806,21 @@ You can use this method to check asynchronously if a goal has been achieved, for -

GOAL:is(state)

+

GOAL:is(State, If, state)

- +

Check if FSM is in state.

GOAL.options

- +

Options.

GOAL.subs

- +

Subs.

@@ -2820,11 +2859,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string State

-

+ +

The FSM state.

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

GOAL:GetCurrentState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

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

Sub processes.

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

Returns a table with the scores defined.

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

Parameter:

+
+
+

+ #table + Scores +

+
+
+

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

GOAL:GetState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Core.Fsm#FSM

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

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

Transitions.

@@ -3371,10 +3469,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

@@ -3382,15 +3480,31 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

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

GOAL:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -3416,11 +3530,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table CallBackTable

-

+ +

Table of call backs.

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

GOAL:_add_to_map(Map, Event)

- +

Add to map.

@@ -3559,21 +3676,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

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

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

- +

Call handler.

@@ -3599,43 +3722,65 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

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

GOAL:_create_transition(EventName)

- +

Create transition.

@@ -3659,13 +3804,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

GOAL:_delayed_transition(EventName)

- +

Delayed transition.

@@ -3689,13 +3848,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

GOAL:_eventmap(Events, EventStructure)

- +

Event map.

@@ -3719,21 +3892,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

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

GOAL:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -3759,23 +3938,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

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

GOAL:_handler(EventName, ...)

- +

Handler.

@@ -3799,11 +3995,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

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

-

+ +

Arguments.

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

GOAL:_isendstate(Current)

- +

Is end state.

@@ -3839,13 +4040,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

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

GOAL:_submap(subs, sub, name)

- +

Sub maps.

@@ -3869,31 +4092,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

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

GOAL:can(e)

- +

Check if can do an event.

@@ -3919,13 +4151,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

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

GOAL:cannot(e)

- +

Check if cannot do an event.

@@ -3949,13 +4203,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -3964,10 +4232,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

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

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Core.Menu.html b/Documentation/Core.Menu.html index 58e371ec1..b12eebd2f 100644 --- a/Documentation/Core.Menu.html +++ b/Documentation/Core.Menu.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Core.Message.html b/Documentation/Core.Message.html index dd9867e60..a47f1f5cf 100644 --- a/Documentation/Core.Message.html +++ b/Documentation/Core.Message.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index 3174d8d56..045cce283 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1540,10 +1573,6 @@ the closest point on the nearest road.

In order to use the most optimal road system to transport vehicles, the method COORDINATE.GetPathOnRoad() will calculate the most optimal path following the road between two coordinates.

- - - -

8) Metric or imperial system

-

+

Add or Remove AIRBASEs from SET_AIRBASE

-

AIRBASEs can be added and removed using the Core.Set#SET_AIRBASE.AddAirbasesByName and Core.Set#SET_AIRBASE.RemoveAirbasesByName respectively. +

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

SET_AIRBASE filter criteria

@@ -1537,10 +1570,10 @@ You can set the "yield interval", and the "time interva -

+

Add or Remove CARGOs from SET_CARGO

-

CARGOs can be added and removed using the Core.Set#SET_CARGO.AddCargosByName and Core.Set#SET_CARGO.RemoveCargosByName respectively. +

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

SET_CARGO filter criteria

@@ -1610,7 +1643,7 @@ The following iterator methods are currently available within the SET_CARGO:

-

+

1) SET_CLIENT constructor

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

@@ -1621,7 +1654,7 @@ The following iterator methods are currently available within the SET_CARGO:

2) Add or Remove CLIENT(s) from SET_CLIENT

-

CLIENTs can be added and removed using the Core.Set#SET_CLIENT.AddClientsByName and Core.Set#SET_CLIENT.RemoveClientsByName respectively. +

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

3) SET_CLIENT filter criteria

@@ -1699,7 +1732,7 @@ The following iterator methods are currently available within the SET_CLIENT:

-

+

SET_GROUP constructor

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

@@ -1710,7 +1743,7 @@ The following iterator methods are currently available within the SET_CLIENT:

Add or Remove GROUP(s) from SET_GROUP -

GROUPS can be added and removed using the Core.Set#SET_GROUP.AddGroupsByName and Core.Set#SET_GROUP.RemoveGroupsByName respectively. +

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

SET_GROUP filter criteria

@@ -1770,7 +1803,7 @@ The following iterator methods are currently available within the SET_GROUP:

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

-

You can handle the event using the OnBefore and OnAfter event handlers. +

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

@@ -1851,7 +1884,7 @@ See the modified example:

-

+

SET_PLAYER filter criteria

You can set filter criteria to define the set of clients within the SET_PLAYER. @@ -1927,7 +1960,7 @@ The following iterator methods are currently available within the SET_PLAYER:

-

+

SET_STATIC constructor

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

@@ -1938,7 +1971,7 @@ The following iterator methods are currently available within the SET_PLAYER:

Add or Remove STATIC(s) from SET_STATIC -

STATICs can be added and removed using the Core.Set#SET_STATIC.AddStaticsByName and Core.Set#SET_STATIC.RemoveStaticsByName respectively. +

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

SET_STATIC filter criteria

@@ -2034,7 +2067,7 @@ The following iterator methods are currently available within the SET_STATIC:

-

+

1) SET_UNIT constructor

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

@@ -2045,7 +2078,7 @@ The following iterator methods are currently available within the SET_STATIC:

2) Add or Remove UNIT(s) from SET_UNIT -

UNITs can be added and removed using the Core.Set#SET_UNIT.AddUnitsByName and Core.Set#SET_UNIT.RemoveUnitsByName respectively. +

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

3) SET_UNIT filter criteria

@@ -2109,7 +2142,7 @@ The following iterator methods are currently available within the SET_UNIT:

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

-

You can handle the event using the OnBefore and OnAfter event handlers. +

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

@@ -2183,7 +2216,7 @@ See the modified example:

Add or Remove ZONEs from SET_ZONE

-

ZONEs can be added and removed using the Core.Set#SET_ZONE.AddZonesByName and Core.Set#SET_ZONE.RemoveZonesByName respectively. +

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

SET_ZONE filter criteria

@@ -2246,7 +2279,7 @@ The following iterator methods are currently available within the SET_ZONE:

Add or Remove ZONEs from SET_ZONE_GOAL

-

ZONEs can be added and removed using the Core.Set#SET_ZONE_GOAL.AddZonesByName and Core.Set#SET_ZONE_GOAL.RemoveZonesByName respectively. +

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

SET_ZONE_GOAL filter criteria

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

SET_AIRBASE:Clear()

Clear the Objects in the Set.

+ + + +

SET_AIRBASE:CompareSets(SetA, SetB)

+ +

Compare two sets.

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

SET_AIRBASE.Filter

- +

Table of filters.

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

SET_AIRBASE:GetSet()

Gets the Set.

+ + + +

SET_AIRBASE:GetSetComplement(SetB)

+ +

Get the complement of two sets.

+ + + +

SET_AIRBASE:GetSetIntersection(SetB)

+ +

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

@@ -2532,24 +2583,42 @@ The following iterator methods are currently available within the SET_ZONE_GOAL:

SET_AIRBASE:GetSetObjects()

Gets a list of the Objects in the Set.

+ + + +

SET_AIRBASE:GetSetUnion(SetB)

+ +

Get the union of two sets.

SET_AIRBASE:GetSomeIteratorLimit()

Get the SET iterator "limit".

+ + + +

SET_AIRBASE.Index

+ +

Table of indicies.

+ + + +

SET_AIRBASE:IsInSet(Object, ObjectName)

+ +

Decides whether to include the Object.

SET_AIRBASE:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

SET_AIRBASE.List

- +

Unused table.

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

SET_AIRBASE.Set

- +

Table of objects.

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

SET_BASE:Clear()

Clear the Objects in the Set.

+ + + +

SET_BASE:CompareSets(SetA, SetB)

+ +

Compare two sets.

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

SET_BASE.Filter

- +

Table of filters.

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

SET_BASE:GetSet()

Gets the Set.

+ + + +

SET_BASE:GetSetComplement(SetB)

+ +

Get the complement of two sets.

+ + + +

SET_BASE:GetSetIntersection(SetB)

+ +

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

@@ -3279,24 +3366,42 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_BASE:GetSetObjects()

Gets a list of the Objects in the Set.

+ + + +

SET_BASE:GetSetUnion(SetB)

+ +

Get the union of two sets.

SET_BASE:GetSomeIteratorLimit()

Get the SET iterator "limit".

+ + + +

SET_BASE.Index

+ +

Table of indicies.

+ + + +

SET_BASE:IsInSet(Object, ObjectName)

+ +

Decides whether to include the Object.

SET_BASE:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

SET_BASE.List

- +

Unused table.

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

SET_BASE.Set

- +

Table of objects.

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

SET_CARGO:IsIncludeObject(MCargo)

-

(R2.1)

+

(R2.1)

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

SET_CARGO:Clear()

Clear the Objects in the Set.

+ + + +

SET_CARGO:CompareSets(SetA, SetB)

+ +

Compare two sets.

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

SET_CARGO.Filter

- +

Table of filters.

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

SET_CARGO:GetSet()

Gets the Set.

+ + + +

SET_CARGO:GetSetComplement(SetB)

+ +

Get the complement of two sets.

+ + + +

SET_CARGO:GetSetIntersection(SetB)

+ +

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

@@ -4179,24 +4302,42 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_CARGO:GetSetObjects()

Gets a list of the Objects in the Set.

+ + + +

SET_CARGO:GetSetUnion(SetB)

+ +

Get the union of two sets.

SET_CARGO:GetSomeIteratorLimit()

Get the SET iterator "limit".

+ + + +

SET_CARGO.Index

+ +

Table of indicies.

+ + + +

SET_CARGO:IsInSet(Object, ObjectName)

+ +

Decides whether to include the Object.

SET_CARGO:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

SET_CARGO.List

- +

Unused table.

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

SET_CARGO.Set

- +

Table of objects.

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

SET_CLIENT:Clear()

Clear the Objects in the Set.

+ + + +

SET_CLIENT:CompareSets(SetA, SetB)

+ +

Compare two sets.

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

SET_CLIENT.Filter

- +

Table of filters.

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

SET_CLIENT:GetSet()

Gets the Set.

+ + + +

SET_CLIENT:GetSetComplement(SetB)

+ +

Get the complement of two sets.

+ + + +

SET_CLIENT:GetSetIntersection(SetB)

+ +

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

@@ -5037,24 +5196,42 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_CLIENT:GetSetObjects()

Gets a list of the Objects in the Set.

+ + + +

SET_CLIENT:GetSetUnion(SetB)

+ +

Get the union of two sets.

SET_CLIENT:GetSomeIteratorLimit()

Get the SET iterator "limit".

+ + + +

SET_CLIENT.Index

+ +

Table of indicies.

+ + + +

SET_CLIENT:IsInSet(Object, ObjectName)

+ +

Decides whether to include the Object.

SET_CLIENT:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

SET_CLIENT.List

- +

Unused table.

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

SET_CLIENT.Set

- +

Table of objects.

@@ -5871,7 +6048,7 @@ provides an easy to use shortcut...

SET_GROUP:NoneInZone(ZoneObject, Zone)

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

@@ -5923,6 +6100,12 @@ mission designer to add a dedicated method

SET_GROUP:Clear()

Clear the Objects in the Set.

+ + + +

SET_GROUP:CompareSets(SetA, SetB)

+ +

Compare two sets.

@@ -5940,7 +6123,7 @@ mission designer to add a dedicated method

SET_GROUP.Filter

- +

Table of filters.

@@ -6025,6 +6208,18 @@ mission designer to add a dedicated method

SET_GROUP:GetSet()

Gets the Set.

+ + + +

SET_GROUP:GetSetComplement(SetB)

+ +

Get the complement of two sets.

+ + + +

SET_GROUP:GetSetIntersection(SetB)

+ +

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

@@ -6037,24 +6232,42 @@ mission designer to add a dedicated method

SET_GROUP:GetSetObjects()

Gets a list of the Objects in the Set.

+ + + +

SET_GROUP:GetSetUnion(SetB)

+ +

Get the union of two sets.

SET_GROUP:GetSomeIteratorLimit()

Get the SET iterator "limit".

+ + + +

SET_GROUP.Index

+ +

Table of indicies.

+ + + +

SET_GROUP:IsInSet(Object, ObjectName)

+ +

Decides whether to include the Object.

SET_GROUP:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

SET_GROUP.List

- +

Unused table.

@@ -6084,7 +6297,7 @@ mission designer to add a dedicated method

SET_GROUP.Set

- +

Table of objects.

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

SET_PLAYER:Clear()

Clear the Objects in the Set.

+ + + +

SET_PLAYER:CompareSets(SetA, SetB)

+ +

Compare two sets.

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

SET_PLAYER.Filter

- +

Table of filters.

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

SET_PLAYER:GetSet()

Gets the Set.

+ + + +

SET_PLAYER:GetSetComplement(SetB)

+ +

Get the complement of two sets.

+ + + +

SET_PLAYER:GetSetIntersection(SetB)

+ +

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

@@ -6889,24 +7120,42 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_PLAYER:GetSetObjects()

Gets a list of the Objects in the Set.

+ + + +

SET_PLAYER:GetSetUnion(SetB)

+ +

Get the union of two sets.

SET_PLAYER:GetSomeIteratorLimit()

Get the SET iterator "limit".

+ + + +

SET_PLAYER.Index

+ +

Table of indicies.

+ + + +

SET_PLAYER:IsInSet(Object, ObjectName)

+ +

Decides whether to include the Object.

SET_PLAYER:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

SET_PLAYER.List

- +

Unused table.

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

SET_PLAYER.Set

- +

Table of objects.

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

SET_STATIC:CalculateThreatLevelA2G()

Calculate the maxium A2G threat level of the SET_STATIC.

+ + + +

SET_STATIC:CountAlive()

+ +

Iterate the SET_STATIC and count how many STATICSs are alive.

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

SET_STATIC:Clear()

Clear the Objects in the Set.

+ + + +

SET_STATIC:CompareSets(SetA, SetB)

+ +

Compare two sets.

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

SET_STATIC.Filter

- +

Table of filters.

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

SET_STATIC:GetSet()

Gets the Set.

+ + + +

SET_STATIC:GetSetComplement(SetB)

+ +

Get the complement of two sets.

+ + + +

SET_STATIC:GetSetIntersection(SetB)

+ +

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

@@ -7813,24 +8086,42 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_STATIC:GetSetObjects()

Gets a list of the Objects in the Set.

+ + + +

SET_STATIC:GetSetUnion(SetB)

+ +

Get the union of two sets.

SET_STATIC:GetSomeIteratorLimit()

Get the SET iterator "limit".

+ + + +

SET_STATIC.Index

+ +

Table of indicies.

+ + + +

SET_STATIC:IsInSet(Object, ObjectName)

+ +

Decides whether to include the Object.

SET_STATIC:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

SET_STATIC.List

- +

Unused table.

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

SET_STATIC.Set

- +

Table of objects.

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

SET_UNIT:CalculateThreatLevelA2G()

Calculate the maxium A2G threat level of the SET_UNIT.

+ + + +

SET_UNIT:CountAlive()

+ +

Iterate the SET_UNIT and count how many UNITs are alive.

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

SET_UNIT:Clear()

Clear the Objects in the Set.

+ + + +

SET_UNIT:CompareSets(SetA, SetB)

+ +

Compare two sets.

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

SET_UNIT.Filter

- +

Table of filters.

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

SET_UNIT:GetSet()

Gets the Set.

+ + + +

SET_UNIT:GetSetComplement(SetB)

+ +

Get the complement of two sets.

+ + + +

SET_UNIT:GetSetIntersection(SetB)

+ +

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

@@ -8805,24 +9120,42 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_UNIT:GetSetObjects()

Gets a list of the Objects in the Set.

+ + + +

SET_UNIT:GetSetUnion(SetB)

+ +

Get the union of two sets.

SET_UNIT:GetSomeIteratorLimit()

Get the SET iterator "limit".

+ + + +

SET_UNIT.Index

+ +

Table of indicies.

+ + + +

SET_UNIT:IsInSet(Object, ObjectName)

+ +

Decides whether to include the Object.

SET_UNIT:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

SET_UNIT.List

- +

Unused table.

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

SET_UNIT.Set

- +

Table of objects.

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

SET_ZONE:Clear()

Clear the Objects in the Set.

+ + + +

SET_ZONE:CompareSets(SetA, SetB)

+ +

Compare two sets.

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

SET_ZONE.Filter

- +

Table of filters.

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

SET_ZONE:GetSet()

Gets the Set.

+ + + +

SET_ZONE:GetSetComplement(SetB)

+ +

Get the complement of two sets.

+ + + +

SET_ZONE:GetSetIntersection(SetB)

+ +

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

@@ -9663,24 +10014,42 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_ZONE:GetSetObjects()

Gets a list of the Objects in the Set.

+ + + +

SET_ZONE:GetSetUnion(SetB)

+ +

Get the union of two sets.

SET_ZONE:GetSomeIteratorLimit()

Get the SET iterator "limit".

+ + + +

SET_ZONE.Index

+ +

Table of indicies.

+ + + +

SET_ZONE:IsInSet(Object, ObjectName)

+ +

Decides whether to include the Object.

SET_ZONE:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

SET_ZONE.List

- +

Unused table.

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

SET_ZONE.Set

- +

Table of objects.

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

SET_ZONE_GOAL:Clear()

Clear the Objects in the Set.

+ + + +

SET_ZONE_GOAL:CompareSets(SetA, SetB)

+ +

Compare two sets.

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

SET_ZONE_GOAL.Filter

- +

Table of filters.

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

SET_ZONE_GOAL:GetSet()

Gets the Set.

+ + + +

SET_ZONE_GOAL:GetSetComplement(SetB)

+ +

Get the complement of two sets.

+ + + +

SET_ZONE_GOAL:GetSetIntersection(SetB)

+ +

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

@@ -10515,24 +10902,42 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_ZONE_GOAL:GetSetObjects()

Gets a list of the Objects in the Set.

+ + + +

SET_ZONE_GOAL:GetSetUnion(SetB)

+ +

Get the union of two sets.

SET_ZONE_GOAL:GetSomeIteratorLimit()

Get the SET iterator "limit".

+ + + +

SET_ZONE_GOAL.Index

+ +

Table of indicies.

+ + + +

SET_ZONE_GOAL:IsInSet(Object, ObjectName)

+ +

Decides whether to include the Object.

SET_ZONE_GOAL:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

SET_ZONE_GOAL.List

- +

Unused table.

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

SET_ZONE_GOAL.Set

- +

Table of objects.

@@ -11859,7 +12264,9 @@ DatabaseSet = SET_AIRBASE:New()

-

+ +

The name of the object.

+
@@ -11870,7 +12277,9 @@ DatabaseSet = SET_AIRBASE:New()

-

+ +

The object itself.

+

Return value:

@@ -11958,6 +12367,63 @@ DatabaseSet = SET_AIRBASE:New() + + + +
+ + + +

Compare two sets.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Core.Set#SET_BASE + SetA +

+
+
+ +

First set.

+ +
+
+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set to be merged into first set.

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -12571,6 +13037,94 @@ DatabaseSet = SET_AIRBASE:New() + + + +
+ + + +

Get the complement of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

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

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -12631,6 +13185,50 @@ DatabaseSet = SET_AIRBASE:New() + + + +
+ + + +

Get the union of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -12661,6 +13259,58 @@ DatabaseSet = SET_AIRBASE:New() + + + +
+ + + +

Decides whether to include the Object.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #table + Object +

+
+
+

+
+
+
+
+

+ ObjectName +

+
+
+

+
+
+

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

+ +
+
+
+
@@ -12670,7 +13320,7 @@ DatabaseSet = SET_AIRBASE:New()

SET_AIRBASE:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

@@ -16261,7 +16911,18 @@ BASE:TraceOnOff( false ) #table SET_BASE.Filter +

Table of filters.

+
+ +
+
+
+ + #table +SET_BASE.Index + +

Table of indicies.

@@ -16272,7 +16933,7 @@ BASE:TraceOnOff( false ) #table SET_BASE.List - +

Unused table.

@@ -16283,7 +16944,7 @@ BASE:TraceOnOff( false ) #table SET_BASE.Set - +

Table of objects.

@@ -16336,7 +16997,9 @@ BASE:TraceOnOff( false )

-

+ +

The name of the object.

+
@@ -16347,7 +17010,9 @@ BASE:TraceOnOff( false )

-

+ +

The object itself.

+

Return value:

@@ -16435,6 +17100,63 @@ BASE:TraceOnOff( false ) + + + +
+ + + +

Compare two sets.

+ +
+
+

Defined in:

+
+

SET_BASE

+
+

Parameters:

+
+
+

+ Core.Set#SET_BASE + SetA +

+
+
+ +

First set.

+ +
+
+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set to be merged into first set.

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -17048,6 +17770,94 @@ BASE:TraceOnOff( false ) + + + +
+ + + +

Get the complement of two sets.

+ +
+
+

Defined in:

+
+

SET_BASE

+
+

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

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

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

+ +
+
+

Defined in:

+
+

SET_BASE

+
+

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -17108,6 +17918,50 @@ BASE:TraceOnOff( false ) + + + +
+ + + +

Get the union of two sets.

+ +
+
+

Defined in:

+
+

SET_BASE

+
+

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -17138,6 +17992,58 @@ BASE:TraceOnOff( false ) + + + +
+ + + +

Decides whether to include the Object.

+ +
+
+

Defined in:

+
+

SET_BASE

+
+

Parameters:

+
+
+

+ #table + Object +

+
+
+

+
+
+
+
+

+ ObjectName +

+
+
+

+
+
+

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

+ +
+
+
+
@@ -17147,7 +18053,7 @@ BASE:TraceOnOff( false )

SET_BASE:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

@@ -17738,7 +18644,18 @@ DBObject = SET_BASE:New() #table SET_BASE.Filter +

Table of filters.

+
+ +
+
+
+ + #table +SET_BASE.Index + +

Table of indicies.

@@ -17749,7 +18666,7 @@ DBObject = SET_BASE:New() #table SET_BASE.List - +

Unused table.

@@ -17760,7 +18677,7 @@ DBObject = SET_BASE:New() #table SET_BASE.Set - +

Table of objects.

@@ -21556,7 +22473,7 @@ BASE:TraceOnOff( false )

SET_CARGO:IsIncludeObject(MCargo)

-

(R2.1)

+

(R2.1)

@@ -21760,7 +22677,9 @@ DatabaseSet = SET_CARGO:New()

-

+ +

The name of the object.

+
@@ -21771,7 +22690,9 @@ DatabaseSet = SET_CARGO:New()

-

+ +

The object itself.

+

Return value:

@@ -21859,6 +22780,63 @@ DatabaseSet = SET_CARGO:New() + + + +
+ + + +

Compare two sets.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Core.Set#SET_BASE + SetA +

+
+
+ +

First set.

+ +
+
+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set to be merged into first set.

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -22472,6 +23450,94 @@ DatabaseSet = SET_CARGO:New() + + + +
+ + + +

Get the complement of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

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

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -22532,6 +23598,50 @@ DatabaseSet = SET_CARGO:New() + + + +
+ + + +

Get the union of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -22562,6 +23672,58 @@ DatabaseSet = SET_CARGO:New() + + + +
+ + + +

Decides whether to include the Object.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #table + Object +

+
+
+

+
+
+
+
+

+ ObjectName +

+
+
+

+
+
+

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

+ +
+
+
+
@@ -22571,7 +23733,7 @@ DatabaseSet = SET_CARGO:New()

SET_CARGO:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

@@ -26989,7 +28151,9 @@ DBObject = SET_CLIENT:New()

-

+ +

The name of the object.

+
@@ -27000,7 +28164,9 @@ DBObject = SET_CLIENT:New()

-

+ +

The object itself.

+

Return value:

@@ -27088,6 +28254,63 @@ DBObject = SET_CLIENT:New() + + + +
+ + + +

Compare two sets.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Core.Set#SET_BASE + SetA +

+
+
+ +

First set.

+ +
+
+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set to be merged into first set.

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -27701,6 +28924,94 @@ DBObject = SET_CLIENT:New() + + + +
+ + + +

Get the complement of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

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

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -27761,6 +29072,50 @@ DBObject = SET_CLIENT:New() + + + +
+ + + +

Get the union of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -27791,6 +29146,58 @@ DBObject = SET_CLIENT:New() + + + +
+ + + +

Decides whether to include the Object.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #table + Object +

+
+
+

+
+
+
+
+

+ ObjectName +

+
+
+

+
+
+

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

+ +
+
+
+
@@ -27800,7 +29207,7 @@ DBObject = SET_CLIENT:New()

SET_CLIENT:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

@@ -31397,6 +32804,7 @@ BASE:TraceOnOff( false )

Return value:

@@ -31440,6 +32848,7 @@ BASE:TraceOnOff( false )

Return value:

@@ -33129,7 +34538,7 @@ DBObject = SET_GROUP:New()

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

@@ -33220,6 +34629,7 @@ end

Return value:

@@ -33322,7 +34732,9 @@ MySetGroup:SetCargoBayWeightLimit()

-

+ +

The name of the object.

+
@@ -33333,7 +34745,9 @@ MySetGroup:SetCargoBayWeightLimit()

-

+ +

The object itself.

+

Return value:

@@ -33421,6 +34835,63 @@ MySetGroup:SetCargoBayWeightLimit()
+
+
+ +
+ + + +

Compare two sets.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Core.Set#SET_BASE + SetA +

+
+
+ +

First set.

+ +
+
+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set to be merged into first set.

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -34034,6 +35505,94 @@ MySetGroup:SetCargoBayWeightLimit()
+ + + +
+ + + +

Get the complement of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

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

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -34094,6 +35653,50 @@ MySetGroup:SetCargoBayWeightLimit() + + + +
+ + + +

Get the union of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -34124,6 +35727,58 @@ MySetGroup:SetCargoBayWeightLimit() + + + +
+ + + +

Decides whether to include the Object.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #table + Object +

+
+
+

+
+
+
+
+

+ ObjectName +

+
+
+

+
+
+

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

+ +
+
+
+
@@ -34133,7 +35788,7 @@ MySetGroup:SetCargoBayWeightLimit()

SET_GROUP:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

@@ -38488,7 +40143,9 @@ DBObject = SET_PLAYER:New()

-

+ +

The name of the object.

+
@@ -38499,7 +40156,9 @@ DBObject = SET_PLAYER:New()

-

+ +

The object itself.

+

Return value:

@@ -38587,6 +40246,63 @@ DBObject = SET_PLAYER:New() + + + +
+ + + +

Compare two sets.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Core.Set#SET_BASE + SetA +

+
+
+ +

First set.

+ +
+
+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set to be merged into first set.

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -39200,6 +40916,94 @@ DBObject = SET_PLAYER:New() + + + +
+ + + +

Get the complement of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

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

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -39260,6 +41064,50 @@ DBObject = SET_PLAYER:New() + + + +
+ + + +

Get the union of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -39290,6 +41138,58 @@ DBObject = SET_PLAYER:New() + + + +
+ + + +

Decides whether to include the Object.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #table + Object +

+
+
+

+
+
+
+
+

+ ObjectName +

+
+
+

+
+
+

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

+ +
+
+
+
@@ -39299,7 +41199,7 @@ DBObject = SET_PLAYER:New()

SET_PLAYER:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

@@ -43030,6 +44930,36 @@ BASE:TraceOnOff( false )
+ + + +
+ + + +

Iterate the SET_STATIC and count how many STATICSs are alive.

+ +
+
+

Defined in:

+
+

SET_STATIC

+
+

Return value:

+
+
+

#number:

+
+
+ +

The number of UNITs alive.

+ +
+
+
+
@@ -44105,7 +46035,9 @@ DBObject = SET_STATIC:New()

-

+ +

The name of the object.

+
@@ -44116,7 +46048,9 @@ DBObject = SET_STATIC:New()

-

+ +

The object itself.

+

Return value:

@@ -44204,6 +46138,63 @@ DBObject = SET_STATIC:New() + + + +
+ + + +

Compare two sets.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Core.Set#SET_BASE + SetA +

+
+
+ +

First set.

+ +
+
+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set to be merged into first set.

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -44817,6 +46808,94 @@ DBObject = SET_STATIC:New() + + + +
+ + + +

Get the complement of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

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

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -44877,6 +46956,50 @@ DBObject = SET_STATIC:New() + + + +
+ + + +

Get the union of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -44907,6 +47030,58 @@ DBObject = SET_STATIC:New() + + + +
+ + + +

Decides whether to include the Object.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #table + Object +

+
+
+

+
+
+
+
+

+ ObjectName +

+
+
+

+
+
+

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

+ +
+
+
+
@@ -44916,7 +47091,7 @@ DBObject = SET_STATIC:New()

SET_STATIC:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

@@ -48647,6 +50822,36 @@ BASE:TraceOnOff( false )
+ + + +
+ + + +

Iterate the SET_UNIT and count how many UNITs are alive.

+ +
+
+

Defined in:

+
+

SET_UNIT

+
+

Return value:

+
+
+

#number:

+
+
+ +

The number of UNITs alive.

+ +
+
+
+
@@ -50110,7 +52315,7 @@ DBObject = SET_UNIT:New()

- Wrapper.Unit#UNIT + #table RemoveUnitNames

@@ -50123,6 +52328,7 @@ DBObject = SET_UNIT:New()

Return value:

@@ -50188,7 +52394,9 @@ MySetUnit:SetCargoBayWeightLimit()

-

+ +

The name of the object.

+
@@ -50199,7 +52407,9 @@ MySetUnit:SetCargoBayWeightLimit()

-

+ +

The object itself.

+

Return value:

@@ -50287,6 +52497,63 @@ MySetUnit:SetCargoBayWeightLimit() + + + +
+ + + +

Compare two sets.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Core.Set#SET_BASE + SetA +

+
+
+ +

First set.

+ +
+
+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set to be merged into first set.

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -50900,6 +53167,94 @@ MySetUnit:SetCargoBayWeightLimit() + + + +
+ + + +

Get the complement of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

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

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -50960,6 +53315,50 @@ MySetUnit:SetCargoBayWeightLimit() + + + +
+ + + +

Get the union of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -50990,6 +53389,58 @@ MySetUnit:SetCargoBayWeightLimit() + + + +
+ + + +

Decides whether to include the Object.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #table + Object +

+
+
+

+
+
+
+
+

+ ObjectName +

+
+
+

+
+
+

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

+ +
+
+
+
@@ -50999,7 +53450,7 @@ MySetUnit:SetCargoBayWeightLimit()

SET_UNIT:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

@@ -55304,7 +57755,9 @@ DatabaseSet = SET_ZONE:New()

-

+ +

The name of the object.

+
@@ -55315,7 +57768,9 @@ DatabaseSet = SET_ZONE:New()

-

+ +

The object itself.

+

Return value:

@@ -55403,6 +57858,63 @@ DatabaseSet = SET_ZONE:New() + + + +
+ + + +

Compare two sets.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Core.Set#SET_BASE + SetA +

+
+
+ +

First set.

+ +
+
+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set to be merged into first set.

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -56016,6 +58528,94 @@ DatabaseSet = SET_ZONE:New() + + + +
+ + + +

Get the complement of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

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

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -56076,6 +58676,50 @@ DatabaseSet = SET_ZONE:New() + + + +
+ + + +

Get the union of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -56106,6 +58750,58 @@ DatabaseSet = SET_ZONE:New() + + + +
+ + + +

Decides whether to include the Object.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #table + Object +

+
+
+

+
+
+
+
+

+ ObjectName +

+
+
+

+
+
+

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

+ +
+
+
+
@@ -56115,7 +58811,7 @@ DatabaseSet = SET_ZONE:New()

SET_ZONE:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

@@ -60377,7 +63073,9 @@ DatabaseSet = SET_ZONE_GOAL:New()

-

+ +

The name of the object.

+
@@ -60388,7 +63086,9 @@ DatabaseSet = SET_ZONE_GOAL:New()

-

+ +

The object itself.

+

Return value:

@@ -60476,6 +63176,63 @@ DatabaseSet = SET_ZONE_GOAL:New() + + + +
+ + + +

Compare two sets.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Core.Set#SET_BASE + SetA +

+
+
+ +

First set.

+ +
+
+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set to be merged into first set.

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -61089,6 +63846,94 @@ DatabaseSet = SET_ZONE_GOAL:New() + + + +
+ + + +

Get the complement of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

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

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -61149,6 +63994,50 @@ DatabaseSet = SET_ZONE_GOAL:New() + + + +
+ + + +

Get the union of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set B .

+ +
+
+

Return value:

+
+ +
+ +

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

+ +
+
+
+
@@ -61179,6 +64068,58 @@ DatabaseSet = SET_ZONE_GOAL:New() + + + +
+ + + +

Decides whether to include the Object.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #table + Object +

+
+
+

+
+
+
+
+

+ ObjectName +

+
+
+

+
+
+

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

+ +
+
+
+
@@ -61188,7 +64129,7 @@ DatabaseSet = SET_ZONE_GOAL:New()

SET_ZONE_GOAL:IsIncludeObject(Object)

-

Decides whether to include the Object

+

Decides whether to include the Object.

diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index 15e6ad7ae..aeda73e1d 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+ +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2511,7 +2544,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2GSystem @@ -2555,7 +2588,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SETTINGS.Metric @@ -4613,7 +4646,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2GSystem @@ -4657,7 +4690,7 @@ It is advised to use this method at the start of the mission.

- + #boolean SETTINGS.Metric diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index 7c9f7dd46..1f526689a 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+
+
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+
+ +
+
+ +

+

Wrapper - Markers On the F10 map.

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

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

+ + + +

SPAWN.communication

+ + + + + +

SPAWN.frequency

+ + + + + +

SPAWN.livery_id

+ + + + + +

SPAWN.modulation

+ + + + + +

SPAWN.skill

+ + + + + +

SPAWN.uncontrolled

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

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

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

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

-
@@ -3288,6 +3340,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
@@ -3321,17 +3384,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPAWN.SpawnInitFreq - - -
@@ -3394,26 +3446,31 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -SPAWN.SpawnInitKeepUnitNames +SPAWN.SpawnInitLimit - -

Overwrite unit names by default with group name.

-
+ +
+
+
+ + #string +SPAWN.SpawnInitSkill -

By default, no InitLimit

+
@@ -3446,7 +3503,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxGroups @@ -3460,7 +3517,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxUnitsAlive @@ -3681,6 +3738,72 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

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

+
+ +
+
+
+ + +SPAWN.communication + + + +
+ +
+
+
+ + +SPAWN.frequency + + + +
+ +
+
+
+ + +SPAWN.livery_id + + + +
+ +
+
+
+ + +SPAWN.modulation + + + +
+ +
+
+
+ + +SPAWN.skill + + + +
+ +
+
+
+ + +SPAWN.uncontrolled + + +
@@ -8500,9 +8623,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

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

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

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

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

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

- - -
-
- - -SPAWN.SpawnInitFreq - - -
@@ -8747,26 +8853,31 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

#boolean -SPAWN.SpawnInitKeepUnitNames +SPAWN.SpawnInitLimit - -

Overwrite unit names by default with group name.

-
+ +
+
+
+ + #string +SPAWN.SpawnInitSkill -

By default, no InitLimit

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

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

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

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

+
+ +
+
+
+ + +SPAWN.communication + + + +
+ +
+
+
+ + +SPAWN.frequency + + + +
+ +
+
+
+ + +SPAWN.livery_id + + + +
+ +
+
+
+ + +SPAWN.modulation + + + +
+ +
+
+
+ + +SPAWN.skill + + + +
+ +
+
+
+ + +SPAWN.uncontrolled + + +
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index a26837f71..8e7ebba2b 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index 47ef74a88..f78ed7397 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1675,7 +1708,13 @@

SPOT.CallScheduler

- +

Call scheduler.

+ + + +

SPOT.ClassName

+ +

Name of the class.

@@ -1687,7 +1726,7 @@

SPOT:GetCurrentState()

- +

Get current state.

@@ -1709,7 +1748,7 @@ -

SPOT:GetScores()

+

SPOT:GetScores(Scores)

Returns a table with the scores defined.

@@ -1723,7 +1762,7 @@

SPOT:GetState()

- +

Get current state.

@@ -1739,15 +1778,15 @@ -

SPOT:Is(State)

+

SPOT:Is(State, If)

- +

Check if FSM is in state.

SPOT:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1759,7 +1798,7 @@

SPOT.Scores

- +

Scores.

@@ -1813,73 +1852,73 @@

SPOT:_add_to_map(Map, Event)

- +

Add to map.

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

- +

Call handler.

SPOT:_create_transition(EventName)

- +

Create transition.

SPOT:_delayed_transition(EventName)

- +

Delayed transition.

SPOT:_eventmap(Events, EventStructure)

- +

Event map.

SPOT:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

SPOT:_handler(EventName, ...)

- +

Handler.

SPOT:_isendstate(Current)

- +

Is end state.

SPOT:_submap(subs, sub, name)

- +

Sub maps.

SPOT:can(e)

- +

Check if can do an event.

SPOT:cannot(e)

- +

Check if cannot do an event.

SPOT.current

- +

Current state name.

@@ -1889,21 +1928,21 @@ -

SPOT:is(state)

+

SPOT:is(State, If, state)

- +

Check if FSM is in state.

SPOT.options

- +

Options.

SPOT.subs

- +

Subs.

@@ -2449,6 +2488,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + +
@@ -3662,6 +3734,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + +
@@ -3697,11 +3802,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string State

-

+ +

The FSM state.

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

SPOT:GetCurrentState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Return value:

+
+
+

#table:

+
+
+ +

End states.

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

Sub processes.

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

Returns a table with the scores defined.

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

Parameter:

+
+
+

+ #table + Scores +

+
+
+

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

SPOT:GetState()

- +

Get current state.

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

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

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

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

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

Transitions.

@@ -4248,10 +4412,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

@@ -4259,15 +4423,31 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

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

SPOT:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -4293,11 +4473,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table CallBackTable

-

+ +

Table of call backs.

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

SPOT:_add_to_map(Map, Event)

- +

Add to map.

@@ -4436,21 +4619,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

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

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

- +

Call handler.

@@ -4476,43 +4665,65 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string step

-

+ +

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

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

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

SPOT:_create_transition(EventName)

- +

Create transition.

@@ -4536,13 +4747,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

SPOT:_delayed_transition(EventName)

- +

Delayed transition.

@@ -4566,13 +4791,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

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

SPOT:_eventmap(Events, EventStructure)

- +

Event map.

@@ -4596,21 +4835,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

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

SPOT:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -4636,23 +4881,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

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

SPOT:_handler(EventName, ...)

- +

Handler.

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

+ #string EventName

-

+ +

Event name.

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

-

+ +

Arguments.

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

SPOT:_isendstate(Current)

- +

Is end state.

@@ -4716,13 +4983,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

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

SPOT:_submap(subs, sub, name)

- +

Sub maps.

@@ -4746,31 +5035,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

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

SPOT:can(e)

- +

Check if can do an event.

@@ -4796,13 +5094,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

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

SPOT:cannot(e)

- +

Check if cannot do an event.

@@ -4826,13 +5146,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -4841,10 +5175,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

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

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

@@ -4912,6 +5272,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +

+ +
+
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + +
diff --git a/Documentation/Core.Timer.html b/Documentation/Core.Timer.html new file mode 100644 index 000000000..3fa76df1e --- /dev/null +++ b/Documentation/Core.Timer.html @@ -0,0 +1,5624 @@ + + + + + + + + + + + + + + + +
+

+ +

+
+
+ + +Banner Image +
+
+

Module Core.Timer

+
+
+ +

Core - Timer scheduler.

+ + + +

Main Features:

+ +
    +
  • Delay function calls
  • +
  • Easy set up and little overhead
  • +
  • Set start, stop and time interval
  • +
  • Define max function calls
  • +
+ +
+ +

Author: funkyfranky

+ +
+

Global(s)

+
+ + + + + +

Global TIMER

+

Better three hours too soon than a minute too late. – William Shakespeare

+ +
+ +

Banner Image

+ +

The TIMER Concept

+ +

The TIMER class is the little sister of the SCHEDULER class.

+
+
+
+
+ + #TIMER +TIMER + +

Better three hours too soon than a minute too late. – William Shakespeare

+ +
+ +

Banner Image

+ +

The TIMER Concept

+ +

The TIMER class is the little sister of the SCHEDULER class.

+ + +

It does the same thing but is a bit easier to use and has less overhead. It should be sufficient in many cases.

+ +

Construction

+ +

A new TIMER is created by the TIMER.New(func, ...) function

+ +
local mytimer=TIMER:New(myfunction, a, b)
+
+ +

The first parameter func is the function that is called followed by the necessary comma separeted parameters that are passed to that function.

+ +

Starting the Timer

+ +

The timer is started by the TIMER.Start(Tstart, dT, Duration) function

+ +
mytimer:Start(5, 1, 20)
+
+ +

where

+ +
    +
  • Tstart is the relative start time in seconds. In the example, the first function call happens after 5 sec.
  • +
  • dT is the time interval between function calls in seconds. Above, the function is called once per second.
  • +
  • Duration is the duration in seconds after which the timer is stopped. This is relative to the start time. Here, the timer will run for 20 seconds.
  • +
+ +

Note that

+ +
    +
  • if Tstart is not specified (nil), the first function call happens immediately.
  • +
  • if dT is not specified (nil), the function is called only once.
  • +
  • if Duration is not specified (nil), the timer runs forever or until stopped manually or until the max function calls are reached (see below).
  • +
+ +

For example,

+ +
mytimer:Start(3)            -- Will call the function once after 3 seconds.
+mytimer:Start(nil, 0.5)     -- Will call right now and then every 0.5 sec until all eternaty.
+mytimer:Start(nil, 2.0, 20) -- Will call right now and then every 2.0 sec for 20 sec.
+mytimer:Start(1.0, nil, 10) -- Does not make sense as the function is only called once anyway. 
+
+ +

Stopping the Timer

+ +

The timer can be stopped manually by the TIMER.Start(Delay) function

+ +
mytimer:Stop()
+
+ +

If the optional paramter Delay is specified, the timer is stopped after delay seconds.

+ +

Limit Function Calls

+ +

The timer can be stopped after a certain amount of function calles with the TIMER.SetMaxFunctionCalls(Nmax) function

+ +
mytimer:SetMaxFunctionCalls(20)
+
+ +

where Nmax is the number of calls after which the timer is stopped, here 20.

+ +

For example,

+ +
mytimer:SetMaxFunctionCalls(66):Start(1.0, 0.1)
+
+ +

will start the timer after one second and call the function every 0.1 seconds. Once the function has been called 66 times, the timer is stopped.

+ + + +
+ +
+

Type(s)

+ +
+ TIMER +, extends Core.Base#BASE +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from TIMERDescription

TIMER.ClassName

+

Name of the class.

+

TIMER:New(Function, ...)

+

Create a new TIMER object.

+

TIMER:SetMaxFunctionCalls(Nmax)

+

Set max number of function calls.

+

TIMER:Start(Tstart, dT, Duration)

+

Create a new TIMER object.

+

TIMER:Stop(Delay)

+

Stop the timer by removing the timer function.

+

TIMER.Tstart

+

Relative start time in seconds.

+

TIMER.Tstop

+

Relative stop time in seconds.

+

TIMER:_Function(time)

+

Call timer function.

+

TIMER.dT

+

Time interval between function calls in seconds.

+

TIMER.func

+

Timer function.

+

TIMER.lid

+

Class id string for output to DCS log file.

+

TIMER.ncalls

+

Counter of function calls.

+

TIMER.ncallsMax

+

Max number of function calls. If reached, timer is stopped.

+

TIMER.para

+

Parameters passed to the timer function.

+

TIMER.tid

+

Timer ID returned by the DCS API function.

+

TIMER.version

+

TIMER class version.

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

TIMER.ClassID

+

The ID number of the class.

+

TIMER.ClassName

+

The name of the class.

+

TIMER.ClassNameAndID

+

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

+

TIMER:ClearState(Object, StateName)

+

Clear the state of an object.

+

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

+

Creation of a Birth Event.

+

TIMER:CreateEventCrash(EventTime, Initiator)

+

Creation of a Crash Event.

+

TIMER:CreateEventDead(EventTime, Initiator)

+

Creation of a Dead Event.

+

TIMER:CreateEventRemoveUnit(EventTime, Initiator)

+

Creation of a Remove Unit Event.

+

TIMER:CreateEventTakeoff(EventTime, Initiator)

+

Creation of a Takeoff Event.

+

TIMER:E(Arguments)

+

Log an exception which will be traced always.

+

TIMER:EventDispatcher()

+

Returns the event dispatcher

+

TIMER:EventRemoveAll()

+

Remove all subscribed events

+

TIMER:F(Arguments)

+

Trace a function call.

+

TIMER:F2(Arguments)

+

Trace a function call level 2.

+

TIMER:F3(Arguments)

+

Trace a function call level 3.

+

TIMER:GetClassID()

+

Get the ClassID of the class instance.

+

TIMER:GetClassName()

+

Get the ClassName of the class instance.

+

TIMER:GetClassNameAndID()

+

Get the ClassName + ClassID of the class instance.

+

TIMER:GetEventPriority()

+

Get the Class Event processing Priority.

+

TIMER:GetParent(Child, FromClass)

+

This is the worker method to retrieve the Parent class.

+

TIMER:GetState(Object, Key)

+

Get a Value given a Key from the Object.

+

TIMER:HandleEvent(Event, EventFunction)

+

Subscribe to a DCS Event.

+

TIMER:I(Arguments)

+

Log an information which will be traced always.

+

TIMER:Inherit(Child, Parent)

+

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

+

TIMER:IsInstanceOf(ClassName)

+

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

+

TIMER:IsTrace()

+

Enquires if tracing is on (for the class).

+

TIMER:New()

+

BASE constructor.

+

TIMER:OnEvent(EventData)

+

Occurs when an object is completely destroyed.

+

TIMER:OnEventBaseCaptured(EventData)

+

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

+

TIMER:OnEventBirth(EventData)

+

Occurs when any object is spawned into the mission.

+

TIMER:OnEventCrash(EventData)

+

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

+

TIMER:OnEventDead(EventData)

+

Occurs when an object is dead.

+

TIMER:OnEventDetailedFailure(EventData)

+

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

+

TIMER:OnEventEjection(EventData)

+

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

+

TIMER:OnEventEngineShutdown(EventData)

+

Occurs when any aircraft shuts down its engines.

+

TIMER:OnEventEngineStartup(EventData)

+

Occurs when any aircraft starts its engines.

+

TIMER:OnEventHit(EventData)

+

Occurs whenever an object is hit by a weapon.

+

TIMER:OnEventHumanFailure(EventData)

+

Occurs when any system fails on a human controlled aircraft.

+

TIMER:OnEventKill(EventData)

+

Occurs on the death of a unit.

+

TIMER:OnEventLand(EventData)

+

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

+

TIMER:OnEventLandingAfterEjection(EventData)

+

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

+

TIMER:OnEventMarkAdded(EventData)

+

Occurs when a new mark was added.

+

TIMER:OnEventMarkChange(EventData)

+

Occurs when a mark text was changed.

+

TIMER:OnEventMarkRemoved(EventData)

+

Occurs when a mark was removed.

+

TIMER:OnEventMissionEnd(EventData)

+

Occurs when a mission ends

+

TIMER:OnEventMissionStart(EventData)

+

Occurs when a mission starts

+

TIMER:OnEventPilotDead(EventData)

+

Occurs when the pilot of an aircraft is killed.

+

TIMER:OnEventPlayerEnterUnit(EventData)

+

Occurs when any player assumes direct control of a unit.

+

TIMER:OnEventPlayerLeaveUnit(EventData)

+

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

+

TIMER:OnEventRefueling(EventData)

+

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

+

TIMER:OnEventRefuelingStop(EventData)

+

Occurs when an aircraft is finished taking fuel.

+

TIMER:OnEventScore(EventData)

+

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

+

TIMER:OnEventShootingEnd(EventData)

+

Occurs when any unit stops firing its weapon.

+

TIMER:OnEventShootingStart(EventData)

+

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

+

TIMER:OnEventShot(EventData)

+

Occurs whenever any unit in a mission fires a weapon.

+

TIMER:OnEventTakeoff(EventData)

+

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

+

TIMER:OnEventUnitLost(EventData)

+

Occurs when the game thinks an object is destroyed.

+

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

+

Schedule a new time event.

+

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

+

Schedule a new time event.

+

TIMER:ScheduleStop(SchedulerFunction)

+

Stops the Schedule.

+

TIMER.Scheduler

+ +

TIMER:SetEventPriority(EventPriority)

+

Set the Class Event processing Priority.

+

TIMER:SetState(Object, Key, Value)

+

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

+

TIMER:T(Arguments)

+

Trace a function logic level 1.

+

TIMER:T2(Arguments)

+

Trace a function logic level 2.

+

TIMER:T3(Arguments)

+

Trace a function logic level 3.

+

TIMER:TraceAll(TraceAll)

+

Trace all methods in MOOSE

+

TIMER:TraceClass(Class)

+

Set tracing for a class

+

TIMER:TraceClassMethod(Class, Method)

+

Set tracing for a specific method of class

+

TIMER:TraceLevel(Level)

+

Set trace level

+

TIMER:TraceOff()

+

Set trace off.

+

TIMER:TraceOn()

+

Set trace on.

+

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

+

TIMER:UnHandleEvent(Event)

+

UnSubscribe to a DCS event.

+

TIMER._

+ +

TIMER:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+

Trace a function call.

+

TIMER:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+

Trace a function logic.

+

TIMER.__

+ +

TIMER:onEvent(event)

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

TIMER class.

+ +
+

Field(s)

+
+
+
+ + #string +TIMER.ClassName + +

Name of the class.

+ +
+ +
+
+
+ + #number +TIMER.Tstart + +

Relative start time in seconds.

+ +
+ +
+
+
+ + #number +TIMER.Tstop + +

Relative stop time in seconds.

+ +
+ +
+
+
+ + #number +TIMER.dT + +

Time interval between function calls in seconds.

+ +
+ +
+
+
+ + #function +TIMER.func + +

Timer function.

+ +
+ +
+
+
+ + #string +TIMER.lid + +

Class id string for output to DCS log file.

+ +
+ +
+
+
+ + #number +TIMER.ncalls + +

Counter of function calls.

+ +
+ +
+
+
+ + #number +TIMER.ncallsMax + +

Max number of function calls. If reached, timer is stopped.

+ +
+ +
+
+
+ + #table +TIMER.para + +

Parameters passed to the timer function.

+ +
+ +
+
+
+ + #number +TIMER.tid + +

Timer ID returned by the DCS API function.

+ +
+ +
+
+
+ + #string +TIMER.version + +

TIMER class version.

+ +
+ +
+
+

Function(s)

+
+
+ + + +

Create a new TIMER object.

+ +
+
+

Defined in:

+
+

TIMER

+
+

Parameters:

+
+
+

+ #function + Function +

+
+
+ +

The function to call.

+ +
+
+
+
+

+ ... +

+
+
+ +

Parameters passed to the function if any.

+ +
+
+

Return value:

+
+
+

#TIMER:

+
+
+ +

self

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

Set max number of function calls.

+ + +

When the function has been called this many times, the TIMER is stopped.

+ +
+
+

Defined in:

+
+

TIMER

+
+

Parameter:

+
+
+

+ #number + Nmax +

+
+
+ +

Set number of max function calls.

+ +
+
+

Return value:

+
+
+

#TIMER:

+
+
+ +

self

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

Create a new TIMER object.

+ +
+
+

Defined in:

+
+

TIMER

+
+

Parameters:

+
+
+

+ #number + Tstart +

+
+
+ +

Relative start time in seconds.

+ +
+
+
+
+

+ #number + dT +

+
+
+ +

Interval between function calls in seconds. If not specified nil, the function is called only once.

+ +
+
+
+
+

+ #number + Duration +

+
+
+ +

Time in seconds for how long the timer is running. If not specified nil, the timer runs forever or until stopped manually by the TIMER:Stop() function.

+ +
+
+

Return value:

+
+
+

#TIMER:

+
+
+ +

self

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

Stop the timer by removing the timer function.

+ +
+
+

Defined in:

+
+

TIMER

+
+

Parameter:

+
+
+

+ #number + Delay +

+
+
+ +

(Optional) Delay in seconds, before the timer is stopped.

+ +
+
+

Return value:

+
+
+

#TIMER:

+
+
+ +

self

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

Call timer function.

+ +
+
+

Defined in:

+
+

TIMER

+
+

Parameter:

+
+
+

+ #number + time +

+
+
+ +

DCS model time in seconds.

+ +
+
+

Return value:

+
+
+

#number:

+
+
+ +

Time when the function is called again or nil if the timer is stopped.

+ +
+
+
+ +
+
+ +
+

Field(s)

+
+
+
+ + #string +TIMER.ClassName + +

Name of the class.

+ +
+ +
+
+
+ + #number +TIMER.Tstart + +

Relative start time in seconds.

+ +
+ +
+
+
+ + #number +TIMER.Tstop + +

Relative stop time in seconds.

+ +
+ +
+
+
+ + #number +TIMER.dT + +

Time interval between function calls in seconds.

+ +
+ +
+
+
+ + #function +TIMER.func + +

Timer function.

+ +
+ +
+
+
+ + #string +TIMER.lid + +

Class id string for output to DCS log file.

+ +
+ +
+
+
+ + #number +TIMER.ncalls + +

Counter of function calls.

+ +
+ +
+
+
+ + #number +TIMER.ncallsMax + +

Max number of function calls. If reached, timer is stopped.

+ +
+ +
+
+
+ + #table +TIMER.para + +

Parameters passed to the timer function.

+ +
+ +
+
+
+ + #number +TIMER.tid + +

Timer ID returned by the DCS API function.

+ +
+ +
+
+
+ + #string +TIMER.version + +

TIMER class version.

+ +
+ +
+
+

Function(s)

+
+
+ + + +

Clear the state of an object.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Object +

+
+
+ +

The object that holds the Value set by the Key.

+ +
+
+
+
+

+ StateName +

+
+
+ +

The key that is should be cleared.

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

Creation of a Birth Event.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+
+

+ #string + IniUnitName +

+
+
+ +

The initiating unit name.

+ +
+
+
+
+

+ place +

+
+
+

+
+
+
+
+

+ subplace +

+
+
+

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

Creation of a Crash Event.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

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

Creation of a Dead Event.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

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

Creation of a Remove Unit Event.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

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

Creation of a Takeoff Event.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

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

Log an exception which will be traced always.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

Returns the event dispatcher

+ +
+
+

Defined in:

+ +

Return value:

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

Remove all subscribed events

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#BASE:

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

Trace a function call.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

Trace a function call level 2.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

Trace a function call level 3.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

Get the ClassID of the class instance.

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#string:

+
+
+ +

The ClassID of the class instance.

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

Get the ClassName of the class instance.

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#string:

+
+
+ +

The ClassName of the class instance.

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

Get the ClassName + ClassID of the class instance.

+ + +

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

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#string:

+
+
+ +

The ClassName + ClassID of the class instance.

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

Get the Class Event processing Priority.

+ + +

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

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#number:

+
+
+ +

The Event processing Priority.

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

This is the worker method to retrieve the Parent class.

+ + +

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

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

Defined in:

+ +

Parameters:

+
+
+

+ #BASE + Child +

+
+
+ +

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

+ +
+
+
+
+

+ #BASE + FromClass +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+

#BASE:

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

Get a Value given a Key from the Object.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Object +

+
+
+ +

The object that holds the Value set by the Key.

+ +
+
+
+
+

+ Key +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+
+
+ +

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

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

Subscribe to a DCS Event.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Core.Event#EVENTS + Event +

+
+
+

+
+
+
+
+

+ #function + EventFunction +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+

#BASE:

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

Log an information which will be traced always.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

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

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Child +

+
+
+ +

is the Child class that inherits.

+ +
+
+
+
+

+ #BASE + Parent +

+
+
+ +

is the Parent class that the Child inherits from.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ +

Child

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

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

+ + + +

Examples:

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

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

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

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

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

  • +
+ + +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ ClassName +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+

#boolean:

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

Enquires if tracing is on (for the class).

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#boolean:

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

BASE constructor.

+ + + +

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

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

Defined in:

+ +

Return value:

+
+
+

#BASE:

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

Occurs when an object is completely destroyed.

+ + +

initiator : The unit that is was destroyed.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

initiator : The unit that captured the base +place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when any object is spawned into the mission.

+ + +

initiator : The unit that was spawned

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

initiator : The unit that has crashed

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when an object is dead.

+ + +

initiator : The unit that is dead.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

Will update this page when new information become available.

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

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when any aircraft shuts down its engines.

+ + +

initiator : The unit that is stopping its engines.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when any aircraft starts its engines.

+ + +

initiator : The unit that is starting its engines.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs whenever an object is hit by a weapon.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when any system fails on a human controlled aircraft.

+ + +

initiator : The unit that had the failure

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs on the death of a unit.

+ + +

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs.

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

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

Can be an Airbase Object, FARP, or Ships

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker.

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

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when a new mark was added.

+ + +

MarkID: ID of the mark.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when a mark text was changed.

+ + +

MarkID: ID of the mark.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when a mark was removed.

+ + +

MarkID: ID of the mark.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when a mission ends

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when a mission starts

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when the pilot of an aircraft is killed.

+ + +

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. +initiator : The unit that the pilot has died in.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when any player assumes direct control of a unit.

+ + +

initiator : The unit that is being taken control of.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

initiator : The unit that the player left.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

initiator : The unit that is receiving fuel.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when an aircraft is finished taking fuel.

+ + +

initiator : The unit that was receiving fuel.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when any unit stops firing its weapon.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. +initiator : The unit that is doing the shooting. +target: The unit that is being targeted.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs whenever any unit in a mission fires a weapon.

+ + +

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when the game thinks an object is destroyed.

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

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Schedule a new time event.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #number + Start +

+
+
+ +

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

+ +
+
+
+
+

+ #function + SchedulerFunction +

+
+
+ +

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

+ +
+
+
+
+

+ #table + ... +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+

#number:

+
+
+ +

The ScheduleID of the planned schedule.

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

Schedule a new time event.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #number + Start +

+
+
+ +

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

+ +
+
+
+
+

+ #number + Repeat +

+
+
+ +

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

+ +
+
+
+
+

+ #number + RandomizeFactor +

+
+
+ +

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

+ +
+
+
+
+

+ #number + Stop +

+
+
+ +

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

+ +
+
+
+
+

+ #function + SchedulerFunction +

+
+
+ +

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

+ +
+
+
+
+

+ #table + ... +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+

#number:

+
+
+ +

The ScheduleID of the planned schedule.

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

Stops the Schedule.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #function + SchedulerFunction +

+
+
+ +

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

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

Set the Class Event processing Priority.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #number + EventPriority +

+
+
+ +

The Event processing Priority.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ +

self

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

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

+ + +

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

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Object +

+
+
+ +

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

+ +
+
+
+
+

+ Key +

+
+
+ +

The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

+ +
+
+
+
+

+ Value +

+
+
+ +

The value to is stored in the object.

+ +
+
+

Return value:

+
+
+
+
+ +

The Value set.

+ +
+
+
+ +
+
+ +
+ + + +

Trace a function logic level 1.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ + + +

Trace a function logic level 2.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ + + +

Trace a function logic level 3.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ + + +

Trace all methods in MOOSE

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #boolean + TraceAll +

+
+
+ +

true = trace all methods in MOOSE.

+ +
+
+
+ +
+
+ +
+ + + +

Set tracing for a class

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #string + Class +

+
+
+

+
+
+
+ +
+
+ +
+ + + +

Set tracing for a specific method of class

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #string + Class +

+
+
+

+
+
+
+
+

+ #string + Method +

+
+
+

+
+
+
+ +
+
+ +
+ + + +

Set trace level

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #number + Level +

+
+
+

+
+
+
+ +
+
+ +
+ + + +

Set trace off.

+ +
+
+

Defined in:

+ +

Usage:

+
-- Switch the tracing Off
+BASE:TraceOff()
+ +
+ +
+
+ +
+ + + +

Set trace on.

+ +
+
+

Defined in:

+ +

Usage:

+
-- Switch the tracing On
+BASE:TraceOn()
+ +
+ +
+
+ +
+ + + +

Set trace on or off +Note that when trace is off, no BASE.Debug statement is performed, increasing performance! +When Moose is loaded statically, (as one file), tracing is switched off by default.

+ + +

So tracing must be switched on manually in your mission if you are using Moose statically. +When moose is loading dynamically (for moose class development), tracing is switched on by default.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #boolean + TraceOnOff +

+
+
+ +

Switch the tracing on or off.

+ +
+
+

Usage:

+
-- Switch the tracing On
+BASE:TraceOnOff( true )
+
+-- Switch the tracing Off
+BASE:TraceOnOff( false )
+ +
+ +
+
+ +
+ + + +

UnSubscribe to a DCS event.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTS + Event +

+
+
+

+
+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ + + +

Trace a function call.

+ + +

This function is private.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ + + +

Trace a function logic.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ + + + + + +

TODO: Complete DCS#Event structure.
+- The main event handling function... This function captures all events generated for the class. + @param #BASE self + @param DCS#Event event

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ event +

+
+
+

+
+
+
+ +
+
+ +
+ +
+
+ + +
+ + + + diff --git a/Documentation/Core.UserFlag.html b/Documentation/Core.UserFlag.html index 153162587..c02f22cb8 100644 --- a/Documentation/Core.UserFlag.html +++ b/Documentation/Core.UserFlag.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Core.UserSound.html b/Documentation/Core.UserSound.html index ead224f6d..36e734828 100644 --- a/Documentation/Core.UserSound.html +++ b/Documentation/Core.UserSound.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Core.Velocity.html b/Documentation/Core.Velocity.html index 491860d2b..ac049b0d1 100644 --- a/Documentation/Core.Velocity.html +++ b/Documentation/Core.Velocity.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Core.Zone.html b/Documentation/Core.Zone.html index 7dafb500e..0c1ea5695 100644 --- a/Documentation/Core.Zone.html +++ b/Documentation/Core.Zone.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1992,7 +2025,13 @@ This class is an abstract BASE class for derived classes, and is not meant to be

ZONE_BASE.CallScheduler

- +

Call scheduler.

+ + + +

ZONE_BASE.ClassName

+ +

Name of the class.

@@ -2004,7 +2043,7 @@ This class is an abstract BASE class for derived classes, and is not meant to be

ZONE_BASE:GetCurrentState()

- +

Get current state.

@@ -2026,7 +2065,7 @@ This class is an abstract BASE class for derived classes, and is not meant to be -

ZONE_BASE:GetScores()

+

ZONE_BASE:GetScores(Scores)

Returns a table with the scores defined.

@@ -2040,7 +2079,7 @@ This class is an abstract BASE class for derived classes, and is not meant to be

ZONE_BASE:GetState()

- +

Get current state.

@@ -2056,15 +2095,15 @@ This class is an abstract BASE class for derived classes, and is not meant to be -

ZONE_BASE:Is(State)

+

ZONE_BASE:Is(State, If)

- +

Check if FSM is in state.

ZONE_BASE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2076,7 +2115,7 @@ This class is an abstract BASE class for derived classes, and is not meant to be

ZONE_BASE.Scores

- +

Scores.

@@ -2130,73 +2169,73 @@ This class is an abstract BASE class for derived classes, and is not meant to be

ZONE_BASE:_add_to_map(Map, Event)

- +

Add to map.

ZONE_BASE:_call_handler(step, trigger, params, EventName)

- +

Call handler.

ZONE_BASE:_create_transition(EventName)

- +

Create transition.

ZONE_BASE:_delayed_transition(EventName)

- +

Delayed transition.

ZONE_BASE:_eventmap(Events, EventStructure)

- +

Event map.

ZONE_BASE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

ZONE_BASE:_handler(EventName, ...)

- +

Handler.

ZONE_BASE:_isendstate(Current)

- +

Is end state.

ZONE_BASE:_submap(subs, sub, name)

- +

Sub maps.

ZONE_BASE:can(e)

- +

Check if can do an event.

ZONE_BASE:cannot(e)

- +

Check if cannot do an event.

ZONE_BASE.current

- +

Current state name.

@@ -2206,21 +2245,21 @@ This class is an abstract BASE class for derived classes, and is not meant to be -

ZONE_BASE:is(state)

+

ZONE_BASE:is(State, If, state)

- +

Check if FSM is in state.

ZONE_BASE.options

- +

Options.

ZONE_BASE.subs

- +

Subs.

@@ -4652,11 +4691,14 @@ end

+ #string State

-

+ +

The FSM state.

+
@@ -4981,7 +5023,7 @@ end

ZONE_BASE:GetCurrentState()

- +

Get current state.

@@ -4989,6 +5031,17 @@ end +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -5008,6 +5061,17 @@ end +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -5074,7 +5138,7 @@ end
- +

Sub processes.

@@ -5086,7 +5150,7 @@ end

Returns a table with the scores defined.

@@ -5097,6 +5161,18 @@ end +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -5138,7 +5214,7 @@ end

ZONE_BASE:GetState()

- +

Get current state.

@@ -5146,6 +5222,17 @@ end +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -5165,6 +5252,17 @@ end +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -5191,7 +5289,7 @@ end
- +

Transitions.

@@ -5203,10 +5301,10 @@ end
- +

Check if FSM is in state.

@@ -5214,15 +5312,31 @@ end -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -5236,7 +5350,7 @@ end

ZONE_BASE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -5248,11 +5362,14 @@ end

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -5379,7 +5496,7 @@ end

ZONE_BASE:_add_to_map(Map, Event)

- +

Add to map.

@@ -5391,21 +5508,27 @@ end

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -5419,7 +5542,7 @@ end

ZONE_BASE:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -5431,43 +5554,65 @@ end

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -5479,7 +5624,7 @@ end

ZONE_BASE:_create_transition(EventName)

- +

Create transition.

@@ -5491,13 +5636,27 @@ end

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -5509,7 +5668,7 @@ end

ZONE_BASE:_delayed_transition(EventName)

- +

Delayed transition.

@@ -5521,13 +5680,27 @@ end

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -5539,7 +5712,7 @@ end

ZONE_BASE:_eventmap(Events, EventStructure)

- +

Event map.

@@ -5551,21 +5724,27 @@ end

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -5579,7 +5758,7 @@ end

ZONE_BASE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -5591,23 +5770,40 @@ end

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -5619,7 +5815,7 @@ end

ZONE_BASE:_handler(EventName, ...)

- +

Handler.

@@ -5631,11 +5827,14 @@ end

+ #string EventName

-

+ +

Event name.

+
@@ -5645,7 +5844,9 @@ end

-

+ +

Arguments.

+
@@ -5659,7 +5860,7 @@ end

ZONE_BASE:_isendstate(Current)

- +

Is end state.

@@ -5671,13 +5872,35 @@ end

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -5689,7 +5912,7 @@ end

ZONE_BASE:_submap(subs, sub, name)

- +

Sub maps.

@@ -5701,31 +5924,40 @@ end

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -5739,7 +5971,7 @@ end

ZONE_BASE:can(e)

- +

Check if can do an event.

@@ -5751,13 +5983,35 @@ end

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -5769,7 +6023,7 @@ end

ZONE_BASE:cannot(e)

- +

Check if cannot do an event.

@@ -5781,13 +6035,27 @@ end

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -5796,10 +6064,10 @@ end
- +

Check if FSM is in state.

@@ -5807,7 +6075,33 @@ end -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/DCS.html b/Documentation/DCS.html index 99a83f896..6e182b93c 100644 --- a/Documentation/DCS.html +++ b/Documentation/DCS.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2993,13 +3026,13 @@

Box3.max

- +

Max

Box3.min

- +

Min.

@@ -3636,25 +3669,25 @@

Position3.p

- +

3D position vector.

Position3.x

- +

Orientation component of vector pointing East.

Position3.y

- +

Orientation component of vector pointing up.

Position3.z

- +

Orientation component of vector pointing North.

@@ -5811,6 +5844,12 @@ First value indicates if at least one of the unit's radar(s) is on.

world.event

https://wiki.hoggitworld.com/view/DCS_enum_world

+ + + +

world.getAirbases(coalitionId)

+ +

Returns a table of DCS airbase objects.

@@ -7109,7 +7148,7 @@ Represents airbases: airdromes, helipads and ships with flying decks or landing #Vec3 Box3.max - +

Max

@@ -7120,7 +7159,7 @@ Represents airbases: airdromes, helipads and ships with flying decks or landing #Vec3 Box3.min - +

Min.

@@ -8574,7 +8613,7 @@ OptionValue = AI.Option.Air.val[optionName] or AI.Option.Ground.val[optionName]
- +

3D position vector with x,y,z components.

@@ -8664,7 +8703,7 @@ OptionValue = AI.Option.Air.val[optionName] or AI.Option.Ground.val[optionName]
- +

3D velocity vector.

@@ -8847,7 +8886,7 @@ OptionValue = AI.Option.Air.val[optionName] or AI.Option.Ground.val[optionName] #Vec3 Position3.p - +

3D position vector.

@@ -8858,7 +8897,7 @@ OptionValue = AI.Option.Air.val[optionName] or AI.Option.Ground.val[optionName] #Vec3 Position3.x - +

Orientation component of vector pointing East.

@@ -8869,7 +8908,7 @@ OptionValue = AI.Option.Air.val[optionName] or AI.Option.Ground.val[optionName] #Vec3 Position3.y - +

Orientation component of vector pointing up.

@@ -8880,7 +8919,7 @@ OptionValue = AI.Option.Air.val[optionName] or AI.Option.Ground.val[optionName] #Vec3 Position3.z - +

Orientation component of vector pointing North.

@@ -11497,6 +11536,50 @@ If sensor type is not specified the function returns true if the unit has at lea + + + +
+ + + +

Returns a table of DCS airbase objects.

+ +
+
+

Defined in:

+
+

world

+
+

Parameter:

+
+
+

+ #number + coalitionId +

+
+
+ +

The coalition side number ID. Default is all airbases are returned.

+ +
+
+

Return value:

+
+
+

#table:

+
+
+ +

Table of DCS airbase objects.

+ +
+
+
+
diff --git a/Documentation/ENUMS.html b/Documentation/ENUMS.html index f0de59533..1369688d8 100644 --- a/Documentation/ENUMS.html +++ b/Documentation/ENUMS.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1377,6 +1410,12 @@ values in your head or look them up in the docs.

Fields and Methods inherited from ENUMS Description + +

ENUMS.AlarmState

+ + + +

ENUMS.Formation

@@ -1433,6 +1472,12 @@ values in your head or look them up in the docs.

Fields and Methods inherited from ENUMS Description + +

ENUMS.AlarmState

+ + + +

ENUMS.Formation

@@ -1473,6 +1518,37 @@ values in your head or look them up in the docs.

ENUMS.WeaponFlag

+ + + + + + + +
+ + + + + + + + + + + + + + + +
Fields and Methods inherited from ENUMS.AlarmStateDescription

ENUMS.AlarmState.Auto

+

AI will automatically switch alarm states based on the presence of threats. The AI kind of cheats in this regard.

+

ENUMS.AlarmState.Green

+

Group is not combat ready. Sensors are stowed if possible.

+

ENUMS.AlarmState.Red

+

Group is combat ready and actively searching for targets. Some groups like infantry will not move in this state.

@@ -1498,6 +1574,12 @@ values in your head or look them up in the docs.

ENUMS.Formation.RotaryWing

+ + + +

ENUMS.Formation.Vehicle

+ + @@ -2276,6 +2358,17 @@ values in your head or look them up in the docs.

Field(s)

+
+ + +
@@ -2359,6 +2452,54 @@ values in your head or look them up in the docs.

+ +
+
+ +

Alarm state.

+ +
+

Field(s)

+
+
+
+ + #number +ENUMS.AlarmState.Auto + +

AI will automatically switch alarm states based on the presence of threats. The AI kind of cheats in this regard.

+ +
+ +
+
+
+ + #number +ENUMS.AlarmState.Green + +

Group is not combat ready. Sensors are stowed if possible.

+ +
+ +
+
+
+ + #number +ENUMS.AlarmState.Red + +

Group is combat ready and actively searching for targets. Some groups like infantry will not move in this state.

+ +
+ +
+
+

Function(s)

+
+
+ +
@@ -2390,6 +2531,17 @@ values in your head or look them up in the docs.

+
+ +
+
+
+ + #table +ENUMS.Formation.Vehicle + + +
diff --git a/Documentation/Functional.ATC_Ground.html b/Documentation/Functional.ATC_Ground.html index 04d90427a..28e493ccd 100644 --- a/Documentation/Functional.ATC_Ground.html +++ b/Documentation/Functional.ATC_Ground.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Functional.Arty.html b/Documentation/Functional.Arty.html index e2e6b470d..692a11f47 100644 --- a/Documentation/Functional.Arty.html +++ b/Documentation/Functional.Arty.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -3304,7 +3337,13 @@ normandy:Start()

ARTY.CallScheduler

- +

Call scheduler.

+ + + +

ARTY.ClassName

+ +

Name of the class.

@@ -3316,7 +3355,7 @@ normandy:Start()

ARTY:GetCurrentState()

- +

Get current state.

@@ -3338,7 +3377,7 @@ normandy:Start() -

ARTY:GetScores()

+

ARTY:GetScores(Scores)

Returns a table with the scores defined.

@@ -3352,7 +3391,7 @@ normandy:Start()

ARTY:GetState()

- +

Get current state.

@@ -3368,15 +3407,15 @@ normandy:Start() -

ARTY:Is(State)

+

ARTY:Is(State, If)

- +

Check if FSM is in state.

ARTY:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -3388,7 +3427,7 @@ normandy:Start()

ARTY.Scores

- +

Scores.

@@ -3442,73 +3481,73 @@ normandy:Start()

ARTY:_add_to_map(Map, Event)

- +

Add to map.

ARTY:_call_handler(step, trigger, params, EventName)

- +

Call handler.

ARTY:_create_transition(EventName)

- +

Create transition.

ARTY:_delayed_transition(EventName)

- +

Delayed transition.

ARTY:_eventmap(Events, EventStructure)

- +

Event map.

ARTY:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

ARTY:_handler(EventName, ...)

- +

Handler.

ARTY:_isendstate(Current)

- +

Is end state.

ARTY:_submap(subs, sub, name)

- +

Sub maps.

ARTY:can(e)

- +

Check if can do an event.

ARTY:cannot(e)

- +

Check if cannot do an event.

ARTY.current

- +

Current state name.

@@ -3518,21 +3557,21 @@ normandy:Start() -

ARTY:is(state)

+

ARTY:is(State, If, state)

- +

Check if FSM is in state.

ARTY.options

- +

Options.

ARTY.subs

- +

Subs.

@@ -15358,11 +15397,14 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

+ #string State

-

+ +

The FSM state.

+
@@ -15687,7 +15729,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

ARTY:GetCurrentState()

- +

Get current state.

@@ -15695,6 +15737,17 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -15714,6 +15767,17 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -15780,7 +15844,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent
- +

Sub processes.

@@ -15792,7 +15856,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

Returns a table with the scores defined.

@@ -15803,6 +15867,18 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -15844,7 +15920,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

ARTY:GetState()

- +

Get current state.

@@ -15852,6 +15928,17 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -15871,6 +15958,17 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -15897,7 +15995,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent
- +

Transitions.

@@ -15909,10 +16007,10 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent
- +

Check if FSM is in state.

@@ -15920,15 +16018,31 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -15942,7 +16056,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

ARTY:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -15954,11 +16068,14 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -16085,7 +16202,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

ARTY:_add_to_map(Map, Event)

- +

Add to map.

@@ -16097,21 +16214,27 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -16125,7 +16248,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

ARTY:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -16137,43 +16260,65 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -16185,7 +16330,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

ARTY:_create_transition(EventName)

- +

Create transition.

@@ -16197,13 +16342,27 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -16215,7 +16374,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

ARTY:_delayed_transition(EventName)

- +

Delayed transition.

@@ -16227,13 +16386,27 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -16245,7 +16418,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

ARTY:_eventmap(Events, EventStructure)

- +

Event map.

@@ -16257,21 +16430,27 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -16285,7 +16464,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

ARTY:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -16297,23 +16476,40 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -16325,7 +16521,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

ARTY:_handler(EventName, ...)

- +

Handler.

@@ -16337,11 +16533,14 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

+ #string EventName

-

+ +

Event name.

+
@@ -16351,7 +16550,9 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

-

+ +

Arguments.

+
@@ -16365,7 +16566,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

ARTY:_isendstate(Current)

- +

Is end state.

@@ -16377,13 +16578,35 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -16395,7 +16618,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

ARTY:_submap(subs, sub, name)

- +

Sub maps.

@@ -16407,31 +16630,40 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -16445,7 +16677,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

ARTY:can(e)

- +

Check if can do an event.

@@ -16457,13 +16689,35 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -16475,7 +16729,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

ARTY:cannot(e)

- +

Check if cannot do an event.

@@ -16487,13 +16741,27 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -16502,10 +16770,10 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent
- +

Check if FSM is in state.

@@ -16513,7 +16781,33 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Functional.CleanUp.html b/Documentation/Functional.CleanUp.html index 4b2d63289..56ff9ae3b 100644 --- a/Documentation/Functional.CleanUp.html +++ b/Documentation/Functional.CleanUp.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index f80e62e7f..88de7c6e8 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2406,7 +2439,13 @@ Use the method DESIGNATE.SetMission() to

DESIGNATE.CallScheduler

- +

Call scheduler.

+ + + +

DESIGNATE.ClassName

+ +

Name of the class.

@@ -2418,7 +2457,7 @@ Use the method DESIGNATE.SetMission() to

DESIGNATE:GetCurrentState()

- +

Get current state.

@@ -2440,7 +2479,7 @@ Use the method DESIGNATE.SetMission() to -

DESIGNATE:GetScores()

+

DESIGNATE:GetScores(Scores)

Returns a table with the scores defined.

@@ -2454,7 +2493,7 @@ Use the method DESIGNATE.SetMission() to

DESIGNATE:GetState()

- +

Get current state.

@@ -2470,15 +2509,15 @@ Use the method DESIGNATE.SetMission() to -

DESIGNATE:Is(State)

+

DESIGNATE:Is(State, If)

- +

Check if FSM is in state.

DESIGNATE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2490,7 +2529,7 @@ Use the method DESIGNATE.SetMission() to

DESIGNATE.Scores

- +

Scores.

@@ -2544,73 +2583,73 @@ Use the method DESIGNATE.SetMission() to

DESIGNATE:_add_to_map(Map, Event)

- +

Add to map.

DESIGNATE:_call_handler(step, trigger, params, EventName)

- +

Call handler.

DESIGNATE:_create_transition(EventName)

- +

Create transition.

DESIGNATE:_delayed_transition(EventName)

- +

Delayed transition.

DESIGNATE:_eventmap(Events, EventStructure)

- +

Event map.

DESIGNATE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

DESIGNATE:_handler(EventName, ...)

- +

Handler.

DESIGNATE:_isendstate(Current)

- +

Is end state.

DESIGNATE:_submap(subs, sub, name)

- +

Sub maps.

DESIGNATE:can(e)

- +

Check if can do an event.

DESIGNATE:cannot(e)

- +

Check if cannot do an event.

DESIGNATE.current

- +

Current state name.

@@ -2620,21 +2659,21 @@ Use the method DESIGNATE.SetMission() to -

DESIGNATE:is(state)

+

DESIGNATE:is(State, If, state)

- +

Check if FSM is in state.

DESIGNATE.options

- +

Options.

DESIGNATE.subs

- +

Subs.

@@ -3202,6 +3241,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
@@ -3213,6 +3263,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -6359,6 +6420,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
@@ -6370,6 +6442,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -7158,6 +7241,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
@@ -7169,6 +7263,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -7927,6 +8032,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
@@ -7938,6 +8054,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -8097,11 +8224,14 @@ Designate:SetFlashStatusMenu( false )

+ #string State

-

+ +

The FSM state.

+
@@ -8426,7 +8556,7 @@ Designate:SetFlashStatusMenu( false )

DESIGNATE:GetCurrentState()

- +

Get current state.

@@ -8434,6 +8564,17 @@ Designate:SetFlashStatusMenu( false ) +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -8453,6 +8594,17 @@ Designate:SetFlashStatusMenu( false ) +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -8519,7 +8671,7 @@ Designate:SetFlashStatusMenu( false )
- +

Sub processes.

@@ -8531,7 +8683,7 @@ Designate:SetFlashStatusMenu( false )

Returns a table with the scores defined.

@@ -8542,6 +8694,18 @@ Designate:SetFlashStatusMenu( false ) +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -8583,7 +8747,7 @@ Designate:SetFlashStatusMenu( false )

DESIGNATE:GetState()

- +

Get current state.

@@ -8591,6 +8755,17 @@ Designate:SetFlashStatusMenu( false ) +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -8610,6 +8785,17 @@ Designate:SetFlashStatusMenu( false ) +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -8636,7 +8822,7 @@ Designate:SetFlashStatusMenu( false )
- +

Transitions.

@@ -8648,10 +8834,10 @@ Designate:SetFlashStatusMenu( false )
- +

Check if FSM is in state.

@@ -8659,15 +8845,31 @@ Designate:SetFlashStatusMenu( false ) -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -8681,7 +8883,7 @@ Designate:SetFlashStatusMenu( false )

DESIGNATE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -8693,11 +8895,14 @@ Designate:SetFlashStatusMenu( false )

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -8824,7 +9029,7 @@ Designate:SetFlashStatusMenu( false )

DESIGNATE:_add_to_map(Map, Event)

- +

Add to map.

@@ -8836,21 +9041,27 @@ Designate:SetFlashStatusMenu( false )

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -8864,7 +9075,7 @@ Designate:SetFlashStatusMenu( false )

DESIGNATE:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -8876,43 +9087,65 @@ Designate:SetFlashStatusMenu( false )

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -8924,7 +9157,7 @@ Designate:SetFlashStatusMenu( false )

DESIGNATE:_create_transition(EventName)

- +

Create transition.

@@ -8936,13 +9169,27 @@ Designate:SetFlashStatusMenu( false )

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -8954,7 +9201,7 @@ Designate:SetFlashStatusMenu( false )

DESIGNATE:_delayed_transition(EventName)

- +

Delayed transition.

@@ -8966,13 +9213,27 @@ Designate:SetFlashStatusMenu( false )

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -8984,7 +9245,7 @@ Designate:SetFlashStatusMenu( false )

DESIGNATE:_eventmap(Events, EventStructure)

- +

Event map.

@@ -8996,21 +9257,27 @@ Designate:SetFlashStatusMenu( false )

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -9024,7 +9291,7 @@ Designate:SetFlashStatusMenu( false )

DESIGNATE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -9036,23 +9303,40 @@ Designate:SetFlashStatusMenu( false )

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -9064,7 +9348,7 @@ Designate:SetFlashStatusMenu( false )

DESIGNATE:_handler(EventName, ...)

- +

Handler.

@@ -9076,11 +9360,14 @@ Designate:SetFlashStatusMenu( false )

+ #string EventName

-

+ +

Event name.

+
@@ -9090,7 +9377,9 @@ Designate:SetFlashStatusMenu( false )

-

+ +

Arguments.

+
@@ -9104,7 +9393,7 @@ Designate:SetFlashStatusMenu( false )

DESIGNATE:_isendstate(Current)

- +

Is end state.

@@ -9116,13 +9405,35 @@ Designate:SetFlashStatusMenu( false )

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -9134,7 +9445,7 @@ Designate:SetFlashStatusMenu( false )

DESIGNATE:_submap(subs, sub, name)

- +

Sub maps.

@@ -9146,31 +9457,40 @@ Designate:SetFlashStatusMenu( false )

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -9184,7 +9504,7 @@ Designate:SetFlashStatusMenu( false )

DESIGNATE:can(e)

- +

Check if can do an event.

@@ -9196,13 +9516,35 @@ Designate:SetFlashStatusMenu( false )

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -9214,7 +9556,7 @@ Designate:SetFlashStatusMenu( false )

DESIGNATE:cannot(e)

- +

Check if cannot do an event.

@@ -9226,13 +9568,27 @@ Designate:SetFlashStatusMenu( false )

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -9241,10 +9597,10 @@ Designate:SetFlashStatusMenu( false )
- +

Check if FSM is in state.

@@ -9252,7 +9608,33 @@ Designate:SetFlashStatusMenu( false ) -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

@@ -9334,6 +9716,17 @@ Designate:SetFlashStatusMenu( false ) +

+ +
+
+
@@ -9345,6 +9738,17 @@ Designate:SetFlashStatusMenu( false ) +
+ +
+
+
+ + #table +DESIGNATE.LaserCodes + + +
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index b293f7a70..cb5f53502 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2662,7 +2695,13 @@ The different values of Unit.Category can be:

DETECTION_AREAS.CallScheduler

- +

Call scheduler.

+ + + +

DETECTION_AREAS.ClassName

+ +

Name of the class.

@@ -2674,7 +2713,7 @@ The different values of Unit.Category can be:

DETECTION_AREAS:GetCurrentState()

- +

Get current state.

@@ -2696,7 +2735,7 @@ The different values of Unit.Category can be:

-

DETECTION_AREAS:GetScores()

+

DETECTION_AREAS:GetScores(Scores)

Returns a table with the scores defined.

@@ -2710,7 +2749,7 @@ The different values of Unit.Category can be:

DETECTION_AREAS:GetState()

- +

Get current state.

@@ -2726,15 +2765,15 @@ The different values of Unit.Category can be:

-

DETECTION_AREAS:Is(State)

+

DETECTION_AREAS:Is(State, If)

- +

Check if FSM is in state.

DETECTION_AREAS:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2746,7 +2785,7 @@ The different values of Unit.Category can be:

DETECTION_AREAS.Scores

- +

Scores.

@@ -2800,73 +2839,73 @@ The different values of Unit.Category can be:

DETECTION_AREAS:_add_to_map(Map, Event)

- +

Add to map.

DETECTION_AREAS:_call_handler(step, trigger, params, EventName)

- +

Call handler.

DETECTION_AREAS:_create_transition(EventName)

- +

Create transition.

DETECTION_AREAS:_delayed_transition(EventName)

- +

Delayed transition.

DETECTION_AREAS:_eventmap(Events, EventStructure)

- +

Event map.

DETECTION_AREAS:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

DETECTION_AREAS:_handler(EventName, ...)

- +

Handler.

DETECTION_AREAS:_isendstate(Current)

- +

Is end state.

DETECTION_AREAS:_submap(subs, sub, name)

- +

Sub maps.

DETECTION_AREAS:can(e)

- +

Check if can do an event.

DETECTION_AREAS:cannot(e)

- +

Check if cannot do an event.

DETECTION_AREAS.current

- +

Current state name.

@@ -2876,21 +2915,21 @@ The different values of Unit.Category can be:

-

DETECTION_AREAS:is(state)

+

DETECTION_AREAS:is(State, If, state)

- +

Check if FSM is in state.

DETECTION_AREAS.options

- +

Options.

DETECTION_AREAS.subs

- +

Subs.

@@ -4191,7 +4230,13 @@ The different values of Unit.Category can be:

DETECTION_BASE.CallScheduler

- +

Call scheduler.

+ + + +

DETECTION_BASE.ClassName

+ +

Name of the class.

@@ -4203,7 +4248,7 @@ The different values of Unit.Category can be:

DETECTION_BASE:GetCurrentState()

- +

Get current state.

@@ -4225,7 +4270,7 @@ The different values of Unit.Category can be:

-

DETECTION_BASE:GetScores()

+

DETECTION_BASE:GetScores(Scores)

Returns a table with the scores defined.

@@ -4239,7 +4284,7 @@ The different values of Unit.Category can be:

DETECTION_BASE:GetState()

- +

Get current state.

@@ -4255,15 +4300,15 @@ The different values of Unit.Category can be:

-

DETECTION_BASE:Is(State)

+

DETECTION_BASE:Is(State, If)

- +

Check if FSM is in state.

DETECTION_BASE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -4275,7 +4320,7 @@ The different values of Unit.Category can be:

DETECTION_BASE.Scores

- +

Scores.

@@ -4329,73 +4374,73 @@ The different values of Unit.Category can be:

DETECTION_BASE:_add_to_map(Map, Event)

- +

Add to map.

DETECTION_BASE:_call_handler(step, trigger, params, EventName)

- +

Call handler.

DETECTION_BASE:_create_transition(EventName)

- +

Create transition.

DETECTION_BASE:_delayed_transition(EventName)

- +

Delayed transition.

DETECTION_BASE:_eventmap(Events, EventStructure)

- +

Event map.

DETECTION_BASE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

DETECTION_BASE:_handler(EventName, ...)

- +

Handler.

DETECTION_BASE:_isendstate(Current)

- +

Is end state.

DETECTION_BASE:_submap(subs, sub, name)

- +

Sub maps.

DETECTION_BASE:can(e)

- +

Check if can do an event.

DETECTION_BASE:cannot(e)

- +

Check if cannot do an event.

DETECTION_BASE.current

- +

Current state name.

@@ -4405,21 +4450,21 @@ The different values of Unit.Category can be:

-

DETECTION_BASE:is(state)

+

DETECTION_BASE:is(State, If, state)

- +

Check if FSM is in state.

DETECTION_BASE.options

- +

Options.

DETECTION_BASE.subs

- +

Subs.

@@ -6037,7 +6082,13 @@ The different values of Unit.Category can be:

DETECTION_TYPES.CallScheduler

- +

Call scheduler.

+ + + +

DETECTION_TYPES.ClassName

+ +

Name of the class.

@@ -6049,7 +6100,7 @@ The different values of Unit.Category can be:

DETECTION_TYPES:GetCurrentState()

- +

Get current state.

@@ -6071,7 +6122,7 @@ The different values of Unit.Category can be:

-

DETECTION_TYPES:GetScores()

+

DETECTION_TYPES:GetScores(Scores)

Returns a table with the scores defined.

@@ -6085,7 +6136,7 @@ The different values of Unit.Category can be:

DETECTION_TYPES:GetState()

- +

Get current state.

@@ -6101,15 +6152,15 @@ The different values of Unit.Category can be:

-

DETECTION_TYPES:Is(State)

+

DETECTION_TYPES:Is(State, If)

- +

Check if FSM is in state.

DETECTION_TYPES:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -6121,7 +6172,7 @@ The different values of Unit.Category can be:

DETECTION_TYPES.Scores

- +

Scores.

@@ -6175,73 +6226,73 @@ The different values of Unit.Category can be:

DETECTION_TYPES:_add_to_map(Map, Event)

- +

Add to map.

DETECTION_TYPES:_call_handler(step, trigger, params, EventName)

- +

Call handler.

DETECTION_TYPES:_create_transition(EventName)

- +

Create transition.

DETECTION_TYPES:_delayed_transition(EventName)

- +

Delayed transition.

DETECTION_TYPES:_eventmap(Events, EventStructure)

- +

Event map.

DETECTION_TYPES:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

DETECTION_TYPES:_handler(EventName, ...)

- +

Handler.

DETECTION_TYPES:_isendstate(Current)

- +

Is end state.

DETECTION_TYPES:_submap(subs, sub, name)

- +

Sub maps.

DETECTION_TYPES:can(e)

- +

Check if can do an event.

DETECTION_TYPES:cannot(e)

- +

Check if cannot do an event.

DETECTION_TYPES.current

- +

Current state name.

@@ -6251,21 +6302,21 @@ The different values of Unit.Category can be:

-

DETECTION_TYPES:is(state)

+

DETECTION_TYPES:is(State, If, state)

- +

Check if FSM is in state.

DETECTION_TYPES.options

- +

Options.

DETECTION_TYPES.subs

- +

Subs.

@@ -7641,7 +7692,13 @@ The different values of Unit.Category can be:

DETECTION_UNITS.CallScheduler

- +

Call scheduler.

+ + + +

DETECTION_UNITS.ClassName

+ +

Name of the class.

@@ -7653,7 +7710,7 @@ The different values of Unit.Category can be:

DETECTION_UNITS:GetCurrentState()

- +

Get current state.

@@ -7675,7 +7732,7 @@ The different values of Unit.Category can be:

-

DETECTION_UNITS:GetScores()

+

DETECTION_UNITS:GetScores(Scores)

Returns a table with the scores defined.

@@ -7689,7 +7746,7 @@ The different values of Unit.Category can be:

DETECTION_UNITS:GetState()

- +

Get current state.

@@ -7705,15 +7762,15 @@ The different values of Unit.Category can be:

-

DETECTION_UNITS:Is(State)

+

DETECTION_UNITS:Is(State, If)

- +

Check if FSM is in state.

DETECTION_UNITS:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -7725,7 +7782,7 @@ The different values of Unit.Category can be:

DETECTION_UNITS.Scores

- +

Scores.

@@ -7779,73 +7836,73 @@ The different values of Unit.Category can be:

DETECTION_UNITS:_add_to_map(Map, Event)

- +

Add to map.

DETECTION_UNITS:_call_handler(step, trigger, params, EventName)

- +

Call handler.

DETECTION_UNITS:_create_transition(EventName)

- +

Create transition.

DETECTION_UNITS:_delayed_transition(EventName)

- +

Delayed transition.

DETECTION_UNITS:_eventmap(Events, EventStructure)

- +

Event map.

DETECTION_UNITS:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

DETECTION_UNITS:_handler(EventName, ...)

- +

Handler.

DETECTION_UNITS:_isendstate(Current)

- +

Is end state.

DETECTION_UNITS:_submap(subs, sub, name)

- +

Sub maps.

DETECTION_UNITS:can(e)

- +

Check if can do an event.

DETECTION_UNITS:cannot(e)

- +

Check if cannot do an event.

DETECTION_UNITS.current

- +

Current state name.

@@ -7855,21 +7912,21 @@ The different values of Unit.Category can be:

-

DETECTION_UNITS:is(state)

+

DETECTION_UNITS:is(State, If, state)

- +

Check if FSM is in state.

DETECTION_UNITS.options

- +

Options.

DETECTION_UNITS.subs

- +

Subs.

@@ -13556,11 +13613,14 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string State

-

+ +

The FSM state.

+
@@ -13885,7 +13945,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_AREAS:GetCurrentState()

- +

Get current state.

@@ -13893,6 +13953,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -13912,6 +13983,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -13978,7 +14060,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- +

Sub processes.

@@ -13990,7 +14072,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

Returns a table with the scores defined.

@@ -14001,6 +14083,18 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -14042,7 +14136,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_AREAS:GetState()

- +

Get current state.

@@ -14050,6 +14144,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -14069,6 +14174,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -14095,7 +14211,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- +

Transitions.

@@ -14107,10 +14223,10 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- +

Check if FSM is in state.

@@ -14118,15 +14234,31 @@ zones that reflect cloudy areas where detected units may not be so easily visual -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -14140,7 +14272,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_AREAS:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -14152,11 +14284,14 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -14283,7 +14418,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_AREAS:_add_to_map(Map, Event)

- +

Add to map.

@@ -14295,21 +14430,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -14323,7 +14464,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_AREAS:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -14335,43 +14476,65 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -14383,7 +14546,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_AREAS:_create_transition(EventName)

- +

Create transition.

@@ -14395,13 +14558,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -14413,7 +14590,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_AREAS:_delayed_transition(EventName)

- +

Delayed transition.

@@ -14425,13 +14602,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -14443,7 +14634,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_AREAS:_eventmap(Events, EventStructure)

- +

Event map.

@@ -14455,21 +14646,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -14483,7 +14680,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_AREAS:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -14495,23 +14692,40 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -14523,7 +14737,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_AREAS:_handler(EventName, ...)

- +

Handler.

@@ -14535,11 +14749,14 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string EventName

-

+ +

Event name.

+
@@ -14549,7 +14766,9 @@ zones that reflect cloudy areas where detected units may not be so easily visual

-

+ +

Arguments.

+
@@ -14563,7 +14782,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_AREAS:_isendstate(Current)

- +

Is end state.

@@ -14575,13 +14794,35 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -14593,7 +14834,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_AREAS:_submap(subs, sub, name)

- +

Sub maps.

@@ -14605,31 +14846,40 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -14643,7 +14893,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_AREAS:can(e)

- +

Check if can do an event.

@@ -14655,13 +14905,35 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -14673,7 +14945,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_AREAS:cannot(e)

- +

Check if cannot do an event.

@@ -14685,13 +14957,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -14700,10 +14986,10 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- +

Check if FSM is in state.

@@ -14711,7 +14997,33 @@ zones that reflect cloudy areas where detected units may not be so easily visual -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

@@ -18063,7 +18375,18 @@ BASE:TraceOnOff( false )

+ #boolean +DETECTION_BASE.Locking + + +
+ +
+
+
+ + #number DETECTION_BASE.RefreshTimeInterval @@ -22754,7 +23077,18 @@ zones that reflect cloudy areas where detected units may not be so easily visual
+ #boolean +DETECTION_BASE.Locking + + +
+ +
+
+
+ + #number DETECTION_BASE.RefreshTimeInterval @@ -22827,11 +23161,14 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string State

-

+ +

The FSM state.

+
@@ -23156,7 +23493,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_BASE:GetCurrentState()

- +

Get current state.

@@ -23164,6 +23501,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -23183,6 +23531,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -23249,7 +23608,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- +

Sub processes.

@@ -23261,7 +23620,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

Returns a table with the scores defined.

@@ -23272,6 +23631,18 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -23313,7 +23684,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_BASE:GetState()

- +

Get current state.

@@ -23321,6 +23692,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -23340,6 +23722,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -23366,7 +23759,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- +

Transitions.

@@ -23378,10 +23771,10 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- +

Check if FSM is in state.

@@ -23389,15 +23782,31 @@ zones that reflect cloudy areas where detected units may not be so easily visual -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -23411,7 +23820,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_BASE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -23423,11 +23832,14 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -23554,7 +23966,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_BASE:_add_to_map(Map, Event)

- +

Add to map.

@@ -23566,21 +23978,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -23594,7 +24012,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_BASE:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -23606,43 +24024,65 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -23654,7 +24094,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_BASE:_create_transition(EventName)

- +

Create transition.

@@ -23666,13 +24106,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -23684,7 +24138,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_BASE:_delayed_transition(EventName)

- +

Delayed transition.

@@ -23696,13 +24150,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -23714,7 +24182,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_BASE:_eventmap(Events, EventStructure)

- +

Event map.

@@ -23726,21 +24194,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -23754,7 +24228,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_BASE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -23766,23 +24240,40 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -23794,7 +24285,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_BASE:_handler(EventName, ...)

- +

Handler.

@@ -23806,11 +24297,14 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string EventName

-

+ +

Event name.

+
@@ -23820,7 +24314,9 @@ zones that reflect cloudy areas where detected units may not be so easily visual

-

+ +

Arguments.

+
@@ -23834,7 +24330,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_BASE:_isendstate(Current)

- +

Is end state.

@@ -23846,13 +24342,35 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -23864,7 +24382,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_BASE:_submap(subs, sub, name)

- +

Sub maps.

@@ -23876,31 +24394,40 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -23914,7 +24441,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_BASE:can(e)

- +

Check if can do an event.

@@ -23926,13 +24453,35 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -23944,7 +24493,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_BASE:cannot(e)

- +

Check if cannot do an event.

@@ -23956,13 +24505,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -23971,10 +24534,10 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- +

Check if FSM is in state.

@@ -23982,7 +24545,33 @@ zones that reflect cloudy areas where detected units may not be so easily visual -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

@@ -24246,7 +24835,18 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #boolean +DETECTION_BASE.Locking + + +
+ +
+
+
+ + #number DETECTION_BASE.RefreshTimeInterval @@ -32551,11 +33151,14 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string State

-

+ +

The FSM state.

+
@@ -32880,7 +33483,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_TYPES:GetCurrentState()

- +

Get current state.

@@ -32888,6 +33491,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -32907,6 +33521,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -32973,7 +33598,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- +

Sub processes.

@@ -32985,7 +33610,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

Returns a table with the scores defined.

@@ -32996,6 +33621,18 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -33037,7 +33674,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_TYPES:GetState()

- +

Get current state.

@@ -33045,6 +33682,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -33064,6 +33712,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -33090,7 +33749,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- +

Transitions.

@@ -33102,10 +33761,10 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- +

Check if FSM is in state.

@@ -33113,15 +33772,31 @@ zones that reflect cloudy areas where detected units may not be so easily visual -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -33135,7 +33810,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_TYPES:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -33147,11 +33822,14 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -33278,7 +33956,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_TYPES:_add_to_map(Map, Event)

- +

Add to map.

@@ -33290,21 +33968,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -33318,7 +34002,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_TYPES:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -33330,43 +34014,65 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -33378,7 +34084,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_TYPES:_create_transition(EventName)

- +

Create transition.

@@ -33390,13 +34096,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -33408,7 +34128,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_TYPES:_delayed_transition(EventName)

- +

Delayed transition.

@@ -33420,13 +34140,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -33438,7 +34172,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_TYPES:_eventmap(Events, EventStructure)

- +

Event map.

@@ -33450,21 +34184,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -33478,7 +34218,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_TYPES:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -33490,23 +34230,40 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -33518,7 +34275,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_TYPES:_handler(EventName, ...)

- +

Handler.

@@ -33530,11 +34287,14 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string EventName

-

+ +

Event name.

+
@@ -33544,7 +34304,9 @@ zones that reflect cloudy areas where detected units may not be so easily visual

-

+ +

Arguments.

+
@@ -33558,7 +34320,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_TYPES:_isendstate(Current)

- +

Is end state.

@@ -33570,13 +34332,35 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -33588,7 +34372,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_TYPES:_submap(subs, sub, name)

- +

Sub maps.

@@ -33600,31 +34384,40 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -33638,7 +34431,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_TYPES:can(e)

- +

Check if can do an event.

@@ -33650,13 +34443,35 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -33668,7 +34483,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_TYPES:cannot(e)

- +

Check if cannot do an event.

@@ -33680,13 +34495,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -33695,10 +34524,10 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- +

Check if FSM is in state.

@@ -33706,7 +34535,33 @@ zones that reflect cloudy areas where detected units may not be so easily visual -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

@@ -41632,11 +42487,14 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string State

-

+ +

The FSM state.

+
@@ -41961,7 +42819,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_UNITS:GetCurrentState()

- +

Get current state.

@@ -41969,6 +42827,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -41988,6 +42857,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -42054,7 +42934,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- +

Sub processes.

@@ -42066,7 +42946,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

Returns a table with the scores defined.

@@ -42077,6 +42957,18 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -42118,7 +43010,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_UNITS:GetState()

- +

Get current state.

@@ -42126,6 +43018,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -42145,6 +43048,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -42171,7 +43085,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- +

Transitions.

@@ -42183,10 +43097,10 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- +

Check if FSM is in state.

@@ -42194,15 +43108,31 @@ zones that reflect cloudy areas where detected units may not be so easily visual -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -42216,7 +43146,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_UNITS:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -42228,11 +43158,14 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -42359,7 +43292,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_UNITS:_add_to_map(Map, Event)

- +

Add to map.

@@ -42371,21 +43304,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -42399,7 +43338,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_UNITS:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -42411,43 +43350,65 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -42459,7 +43420,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_UNITS:_create_transition(EventName)

- +

Create transition.

@@ -42471,13 +43432,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -42489,7 +43464,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_UNITS:_delayed_transition(EventName)

- +

Delayed transition.

@@ -42501,13 +43476,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -42519,7 +43508,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_UNITS:_eventmap(Events, EventStructure)

- +

Event map.

@@ -42531,21 +43520,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -42559,7 +43554,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_UNITS:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -42571,23 +43566,40 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -42599,7 +43611,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_UNITS:_handler(EventName, ...)

- +

Handler.

@@ -42611,11 +43623,14 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string EventName

-

+ +

Event name.

+
@@ -42625,7 +43640,9 @@ zones that reflect cloudy areas where detected units may not be so easily visual

-

+ +

Arguments.

+
@@ -42639,7 +43656,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_UNITS:_isendstate(Current)

- +

Is end state.

@@ -42651,13 +43668,35 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -42669,7 +43708,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_UNITS:_submap(subs, sub, name)

- +

Sub maps.

@@ -42681,31 +43720,40 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -42719,7 +43767,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_UNITS:can(e)

- +

Check if can do an event.

@@ -42731,13 +43779,35 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -42749,7 +43819,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual

DETECTION_UNITS:cannot(e)

- +

Check if cannot do an event.

@@ -42761,13 +43831,27 @@ zones that reflect cloudy areas where detected units may not be so easily visual

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -42776,10 +43860,10 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- +

Check if FSM is in state.

@@ -42787,7 +43871,33 @@ zones that reflect cloudy areas where detected units may not be so easily visual -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Functional.Escort.html b/Documentation/Functional.Escort.html index 5971abcfc..3145f0258 100644 --- a/Documentation/Functional.Escort.html +++ b/Documentation/Functional.Escort.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Functional.FOX.html b/Documentation/Functional.FOX.html index f037371b2..22ecc8d69 100644 --- a/Documentation/Functional.FOX.html +++ b/Documentation/Functional.FOX.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2012,7 +2045,13 @@ fox:Start()

FOX.CallScheduler

- +

Call scheduler.

+ + + +

FOX.ClassName

+ +

Name of the class.

@@ -2024,7 +2063,7 @@ fox:Start()

FOX:GetCurrentState()

- +

Get current state.

@@ -2046,7 +2085,7 @@ fox:Start() -

FOX:GetScores()

+

FOX:GetScores(Scores)

Returns a table with the scores defined.

@@ -2060,7 +2099,7 @@ fox:Start()

FOX:GetState()

- +

Get current state.

@@ -2076,15 +2115,15 @@ fox:Start() -

FOX:Is(State)

+

FOX:Is(State, If)

- +

Check if FSM is in state.

FOX:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2096,7 +2135,7 @@ fox:Start()

FOX.Scores

- +

Scores.

@@ -2150,73 +2189,73 @@ fox:Start()

FOX:_add_to_map(Map, Event)

- +

Add to map.

FOX:_call_handler(step, trigger, params, EventName)

- +

Call handler.

FOX:_create_transition(EventName)

- +

Create transition.

FOX:_delayed_transition(EventName)

- +

Delayed transition.

FOX:_eventmap(Events, EventStructure)

- +

Event map.

FOX:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

FOX:_handler(EventName, ...)

- +

Handler.

FOX:_isendstate(Current)

- +

Is end state.

FOX:_submap(subs, sub, name)

- +

Sub maps.

FOX:can(e)

- +

Check if can do an event.

FOX:cannot(e)

- +

Check if cannot do an event.

FOX.current

- +

Current state name.

@@ -2226,21 +2265,21 @@ fox:Start() -

FOX:is(state)

+

FOX:is(State, If, state)

- +

Check if FSM is in state.

FOX.options

- +

Options.

FOX.subs

- +

Subs.

@@ -6060,11 +6099,14 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

+ #string State

-

+ +

The FSM state.

+
@@ -6389,7 +6431,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

FOX:GetCurrentState()

- +

Get current state.

@@ -6397,6 +6439,17 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -6416,6 +6469,17 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -6482,7 +6546,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini
- +

Sub processes.

@@ -6494,7 +6558,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

Returns a table with the scores defined.

@@ -6505,6 +6569,18 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -6546,7 +6622,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

FOX:GetState()

- +

Get current state.

@@ -6554,6 +6630,17 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -6573,6 +6660,17 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -6599,7 +6697,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini
- +

Transitions.

@@ -6611,10 +6709,10 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini
- +

Check if FSM is in state.

@@ -6622,15 +6720,31 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -6644,7 +6758,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

FOX:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -6656,11 +6770,14 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -6787,7 +6904,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

FOX:_add_to_map(Map, Event)

- +

Add to map.

@@ -6799,21 +6916,27 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -6827,7 +6950,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

FOX:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -6839,43 +6962,65 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -6887,7 +7032,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

FOX:_create_transition(EventName)

- +

Create transition.

@@ -6899,13 +7044,27 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -6917,7 +7076,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

FOX:_delayed_transition(EventName)

- +

Delayed transition.

@@ -6929,13 +7088,27 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -6947,7 +7120,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

FOX:_eventmap(Events, EventStructure)

- +

Event map.

@@ -6959,21 +7132,27 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -6987,7 +7166,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

FOX:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -6999,23 +7178,40 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -7027,7 +7223,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

FOX:_handler(EventName, ...)

- +

Handler.

@@ -7039,11 +7235,14 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

+ #string EventName

-

+ +

Event name.

+
@@ -7053,7 +7252,9 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

-

+ +

Arguments.

+
@@ -7067,7 +7268,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

FOX:_isendstate(Current)

- +

Is end state.

@@ -7079,13 +7280,35 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -7097,7 +7320,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

FOX:_submap(subs, sub, name)

- +

Sub maps.

@@ -7109,31 +7332,40 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -7147,7 +7379,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

FOX:can(e)

- +

Check if can do an event.

@@ -7159,13 +7391,35 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -7177,7 +7431,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

FOX:cannot(e)

- +

Check if cannot do an event.

@@ -7189,13 +7443,27 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -7204,10 +7472,10 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini
- +

Check if FSM is in state.

@@ -7215,7 +7483,33 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Functional.MissileTrainer.html b/Documentation/Functional.MissileTrainer.html index 4f0bf3482..890d4520a 100644 --- a/Documentation/Functional.MissileTrainer.html +++ b/Documentation/Functional.MissileTrainer.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Functional.Movement.html b/Documentation/Functional.Movement.html index 8c6edbb5a..f255ee54d 100644 --- a/Documentation/Functional.Movement.html +++ b/Documentation/Functional.Movement.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Functional.PseudoATC.html b/Documentation/Functional.PseudoATC.html index b4f19c9f9..f8d5f0c85 100644 --- a/Documentation/Functional.PseudoATC.html +++ b/Documentation/Functional.PseudoATC.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Functional.Range.html b/Documentation/Functional.Range.html index 30f1e9864..846804917 100644 --- a/Documentation/Functional.Range.html +++ b/Documentation/Functional.Range.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2545,7 +2578,13 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th

RANGE.CallScheduler

- +

Call scheduler.

+ + + +

RANGE.ClassName

+ +

Name of the class.

@@ -2557,7 +2596,7 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th

RANGE:GetCurrentState()

- +

Get current state.

@@ -2579,7 +2618,7 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th -

RANGE:GetScores()

+

RANGE:GetScores(Scores)

Returns a table with the scores defined.

@@ -2593,7 +2632,7 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th

RANGE:GetState()

- +

Get current state.

@@ -2609,15 +2648,15 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th -

RANGE:Is(State)

+

RANGE:Is(State, If)

- +

Check if FSM is in state.

RANGE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2629,7 +2668,7 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th

RANGE.Scores

- +

Scores.

@@ -2683,73 +2722,73 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th

RANGE:_add_to_map(Map, Event)

- +

Add to map.

RANGE:_call_handler(step, trigger, params, EventName)

- +

Call handler.

RANGE:_create_transition(EventName)

- +

Create transition.

RANGE:_delayed_transition(EventName)

- +

Delayed transition.

RANGE:_eventmap(Events, EventStructure)

- +

Event map.

RANGE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

RANGE:_handler(EventName, ...)

- +

Handler.

RANGE:_isendstate(Current)

- +

Is end state.

RANGE:_submap(subs, sub, name)

- +

Sub maps.

RANGE:can(e)

- +

Check if can do an event.

RANGE:cannot(e)

- +

Check if cannot do an event.

RANGE.current

- +

Current state name.

@@ -2759,21 +2798,21 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th -

RANGE:is(state)

+

RANGE:is(State, If, state)

- +

Check if FSM is in state.

RANGE.options

- +

Options.

RANGE.subs

- +

Subs.

@@ -9490,11 +9529,14 @@ If a zone is not explicitly specified, the range zone is determined by its locat

+ #string State

-

+ +

The FSM state.

+
@@ -9819,7 +9861,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat

RANGE:GetCurrentState()

- +

Get current state.

@@ -9827,6 +9869,17 @@ If a zone is not explicitly specified, the range zone is determined by its locat +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -9846,6 +9899,17 @@ If a zone is not explicitly specified, the range zone is determined by its locat +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -9912,7 +9976,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
- +

Sub processes.

@@ -9924,7 +9988,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat

Returns a table with the scores defined.

@@ -9935,6 +9999,18 @@ If a zone is not explicitly specified, the range zone is determined by its locat +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -9976,7 +10052,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat

RANGE:GetState()

- +

Get current state.

@@ -9984,6 +10060,17 @@ If a zone is not explicitly specified, the range zone is determined by its locat +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -10003,6 +10090,17 @@ If a zone is not explicitly specified, the range zone is determined by its locat +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -10029,7 +10127,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
- +

Transitions.

@@ -10041,10 +10139,10 @@ If a zone is not explicitly specified, the range zone is determined by its locat
- +

Check if FSM is in state.

@@ -10052,15 +10150,31 @@ If a zone is not explicitly specified, the range zone is determined by its locat -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -10074,7 +10188,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat

RANGE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -10086,11 +10200,14 @@ If a zone is not explicitly specified, the range zone is determined by its locat

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -10217,7 +10334,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat

RANGE:_add_to_map(Map, Event)

- +

Add to map.

@@ -10229,21 +10346,27 @@ If a zone is not explicitly specified, the range zone is determined by its locat

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -10257,7 +10380,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat

RANGE:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -10269,43 +10392,65 @@ If a zone is not explicitly specified, the range zone is determined by its locat

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -10317,7 +10462,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat

RANGE:_create_transition(EventName)

- +

Create transition.

@@ -10329,13 +10474,27 @@ If a zone is not explicitly specified, the range zone is determined by its locat

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -10347,7 +10506,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat

RANGE:_delayed_transition(EventName)

- +

Delayed transition.

@@ -10359,13 +10518,27 @@ If a zone is not explicitly specified, the range zone is determined by its locat

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -10377,7 +10550,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat

RANGE:_eventmap(Events, EventStructure)

- +

Event map.

@@ -10389,21 +10562,27 @@ If a zone is not explicitly specified, the range zone is determined by its locat

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -10417,7 +10596,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat

RANGE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -10429,23 +10608,40 @@ If a zone is not explicitly specified, the range zone is determined by its locat

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -10457,7 +10653,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat

RANGE:_handler(EventName, ...)

- +

Handler.

@@ -10469,11 +10665,14 @@ If a zone is not explicitly specified, the range zone is determined by its locat

+ #string EventName

-

+ +

Event name.

+
@@ -10483,7 +10682,9 @@ If a zone is not explicitly specified, the range zone is determined by its locat

-

+ +

Arguments.

+
@@ -10497,7 +10698,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat

RANGE:_isendstate(Current)

- +

Is end state.

@@ -10509,13 +10710,35 @@ If a zone is not explicitly specified, the range zone is determined by its locat

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -10527,7 +10750,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat

RANGE:_submap(subs, sub, name)

- +

Sub maps.

@@ -10539,31 +10762,40 @@ If a zone is not explicitly specified, the range zone is determined by its locat

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -10577,7 +10809,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat

RANGE:can(e)

- +

Check if can do an event.

@@ -10589,13 +10821,35 @@ If a zone is not explicitly specified, the range zone is determined by its locat

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -10607,7 +10861,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat

RANGE:cannot(e)

- +

Check if cannot do an event.

@@ -10619,13 +10873,27 @@ If a zone is not explicitly specified, the range zone is determined by its locat

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -10634,10 +10902,10 @@ If a zone is not explicitly specified, the range zone is determined by its locat
- +

Check if FSM is in state.

@@ -10645,7 +10913,33 @@ If a zone is not explicitly specified, the range zone is determined by its locat -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html index 94851c98f..1fed10be1 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -3183,12 +3216,6 @@ manager:Stop(7200)

RAT.termtype

Type of terminal to be used when spawning at an airbase.

- - - -

RAT.type

- - @@ -4149,6 +4176,42 @@ and any spaces before and after the resulting name are removed.

RAT:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)

+ + + +

RAT.communication

+ + + + + +

RAT.frequency

+ + + + + +

RAT.livery_id

+ + + + + +

RAT.modulation

+ + + + + +

RAT.skill

+ + + + + +

RAT.uncontrolled

+ + @@ -6436,17 +6499,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Type of terminal to be used when spawning at an airbase.

- - - -
-
- - -RAT.type - - -
@@ -14327,17 +14379,6 @@ Initializes the ratcraft array and group menu.

Type of terminal to be used when spawning at an airbase.

- - - -
-
- - -RAT.type - - -
@@ -20273,17 +20314,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

Type of terminal to be used when spawning at an airbase.

- - - -
-
- - -RAT.type - - -
diff --git a/Documentation/Functional.Scoring.html b/Documentation/Functional.Scoring.html index 04627b52e..d47c15151 100644 --- a/Documentation/Functional.Scoring.html +++ b/Documentation/Functional.Scoring.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Functional.Sead.html b/Documentation/Functional.Sead.html index fa3d7f405..0be77902f 100644 --- a/Documentation/Functional.Sead.html +++ b/Documentation/Functional.Sead.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Functional.Suppression.html b/Documentation/Functional.Suppression.html index e39ba6782..6bf07fa6e 100644 --- a/Documentation/Functional.Suppression.html +++ b/Documentation/Functional.Suppression.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2478,7 +2511,13 @@ If no scenery object is near the group the TakeCover event is r

SUPPRESSION.CallScheduler

- +

Call scheduler.

+ + + +

SUPPRESSION.ClassName

+ +

Name of the class.

@@ -2490,7 +2529,7 @@ If no scenery object is near the group the TakeCover event is r

SUPPRESSION:GetCurrentState()

- +

Get current state.

@@ -2512,7 +2551,7 @@ If no scenery object is near the group the TakeCover event is r -

SUPPRESSION:GetScores()

+

SUPPRESSION:GetScores(Scores)

Returns a table with the scores defined.

@@ -2526,7 +2565,7 @@ If no scenery object is near the group the TakeCover event is r

SUPPRESSION:GetState()

- +

Get current state.

@@ -2542,15 +2581,15 @@ If no scenery object is near the group the TakeCover event is r -

SUPPRESSION:Is(State)

+

SUPPRESSION:Is(State, If)

- +

Check if FSM is in state.

SUPPRESSION:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2562,7 +2601,7 @@ If no scenery object is near the group the TakeCover event is r

SUPPRESSION.Scores

- +

Scores.

@@ -2616,73 +2655,73 @@ If no scenery object is near the group the TakeCover event is r

SUPPRESSION:_add_to_map(Map, Event)

- +

Add to map.

SUPPRESSION:_call_handler(step, trigger, params, EventName)

- +

Call handler.

SUPPRESSION:_create_transition(EventName)

- +

Create transition.

SUPPRESSION:_delayed_transition(EventName)

- +

Delayed transition.

SUPPRESSION:_eventmap(Events, EventStructure)

- +

Event map.

SUPPRESSION:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

SUPPRESSION:_handler(EventName, ...)

- +

Handler.

SUPPRESSION:_isendstate(Current)

- +

Is end state.

SUPPRESSION:_submap(subs, sub, name)

- +

Sub maps.

SUPPRESSION:can(e)

- +

Check if can do an event.

SUPPRESSION:cannot(e)

- +

Check if cannot do an event.

SUPPRESSION.current

- +

Current state name.

@@ -2692,21 +2731,21 @@ If no scenery object is near the group the TakeCover event is r -

SUPPRESSION:is(state)

+

SUPPRESSION:is(State, If, state)

- +

Check if FSM is in state.

SUPPRESSION.options

- +

Options.

SUPPRESSION.subs

- +

Subs.

@@ -10208,11 +10247,14 @@ If the group consists of more than one unit, this referrs to the group strength

+ #string State

-

+ +

The FSM state.

+
@@ -10537,7 +10579,7 @@ If the group consists of more than one unit, this referrs to the group strength

SUPPRESSION:GetCurrentState()

- +

Get current state.

@@ -10545,6 +10587,17 @@ If the group consists of more than one unit, this referrs to the group strength +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -10564,6 +10617,17 @@ If the group consists of more than one unit, this referrs to the group strength +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -10630,7 +10694,7 @@ If the group consists of more than one unit, this referrs to the group strength
- +

Sub processes.

@@ -10642,7 +10706,7 @@ If the group consists of more than one unit, this referrs to the group strength

Returns a table with the scores defined.

@@ -10653,6 +10717,18 @@ If the group consists of more than one unit, this referrs to the group strength +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -10694,7 +10770,7 @@ If the group consists of more than one unit, this referrs to the group strength

SUPPRESSION:GetState()

- +

Get current state.

@@ -10702,6 +10778,17 @@ If the group consists of more than one unit, this referrs to the group strength +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -10721,6 +10808,17 @@ If the group consists of more than one unit, this referrs to the group strength +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -10747,7 +10845,7 @@ If the group consists of more than one unit, this referrs to the group strength
- +

Transitions.

@@ -10759,10 +10857,10 @@ If the group consists of more than one unit, this referrs to the group strength
- +

Check if FSM is in state.

@@ -10770,15 +10868,31 @@ If the group consists of more than one unit, this referrs to the group strength -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -10792,7 +10906,7 @@ If the group consists of more than one unit, this referrs to the group strength

SUPPRESSION:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -10804,11 +10918,14 @@ If the group consists of more than one unit, this referrs to the group strength

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -10935,7 +11052,7 @@ If the group consists of more than one unit, this referrs to the group strength

SUPPRESSION:_add_to_map(Map, Event)

- +

Add to map.

@@ -10947,21 +11064,27 @@ If the group consists of more than one unit, this referrs to the group strength

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -10975,7 +11098,7 @@ If the group consists of more than one unit, this referrs to the group strength

SUPPRESSION:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -10987,43 +11110,65 @@ If the group consists of more than one unit, this referrs to the group strength

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -11035,7 +11180,7 @@ If the group consists of more than one unit, this referrs to the group strength

SUPPRESSION:_create_transition(EventName)

- +

Create transition.

@@ -11047,13 +11192,27 @@ If the group consists of more than one unit, this referrs to the group strength

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -11065,7 +11224,7 @@ If the group consists of more than one unit, this referrs to the group strength

SUPPRESSION:_delayed_transition(EventName)

- +

Delayed transition.

@@ -11077,13 +11236,27 @@ If the group consists of more than one unit, this referrs to the group strength

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -11095,7 +11268,7 @@ If the group consists of more than one unit, this referrs to the group strength

SUPPRESSION:_eventmap(Events, EventStructure)

- +

Event map.

@@ -11107,21 +11280,27 @@ If the group consists of more than one unit, this referrs to the group strength

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -11135,7 +11314,7 @@ If the group consists of more than one unit, this referrs to the group strength

SUPPRESSION:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -11147,23 +11326,40 @@ If the group consists of more than one unit, this referrs to the group strength

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -11175,7 +11371,7 @@ If the group consists of more than one unit, this referrs to the group strength

SUPPRESSION:_handler(EventName, ...)

- +

Handler.

@@ -11187,11 +11383,14 @@ If the group consists of more than one unit, this referrs to the group strength

+ #string EventName

-

+ +

Event name.

+
@@ -11201,7 +11400,9 @@ If the group consists of more than one unit, this referrs to the group strength

-

+ +

Arguments.

+
@@ -11215,7 +11416,7 @@ If the group consists of more than one unit, this referrs to the group strength

SUPPRESSION:_isendstate(Current)

- +

Is end state.

@@ -11227,13 +11428,35 @@ If the group consists of more than one unit, this referrs to the group strength

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -11245,7 +11468,7 @@ If the group consists of more than one unit, this referrs to the group strength

SUPPRESSION:_submap(subs, sub, name)

- +

Sub maps.

@@ -11257,31 +11480,40 @@ If the group consists of more than one unit, this referrs to the group strength

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -11295,7 +11527,7 @@ If the group consists of more than one unit, this referrs to the group strength

SUPPRESSION:can(e)

- +

Check if can do an event.

@@ -11307,13 +11539,35 @@ If the group consists of more than one unit, this referrs to the group strength

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -11325,7 +11579,7 @@ If the group consists of more than one unit, this referrs to the group strength

SUPPRESSION:cannot(e)

- +

Check if cannot do an event.

@@ -11337,13 +11591,27 @@ If the group consists of more than one unit, this referrs to the group strength

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -11352,10 +11620,10 @@ If the group consists of more than one unit, this referrs to the group strength
- +

Check if FSM is in state.

@@ -11363,7 +11631,33 @@ If the group consists of more than one unit, this referrs to the group strength -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Functional.Warehouse.html b/Documentation/Functional.Warehouse.html index 650d51737..ef9703c98 100644 --- a/Documentation/Functional.Warehouse.html +++ b/Documentation/Functional.Warehouse.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -4597,7 +4630,13 @@ end

WAREHOUSE.CallScheduler

- +

Call scheduler.

+ + + +

WAREHOUSE.ClassName

+ +

Name of the class.

@@ -4609,7 +4648,7 @@ end

WAREHOUSE:GetCurrentState()

- +

Get current state.

@@ -4631,7 +4670,7 @@ end -

WAREHOUSE:GetScores()

+

WAREHOUSE:GetScores(Scores)

Returns a table with the scores defined.

@@ -4645,7 +4684,7 @@ end

WAREHOUSE:GetState()

- +

Get current state.

@@ -4661,15 +4700,15 @@ end -

WAREHOUSE:Is(State)

+

WAREHOUSE:Is(State, If)

- +

Check if FSM is in state.

WAREHOUSE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -4681,7 +4720,7 @@ end

WAREHOUSE.Scores

- +

Scores.

@@ -4735,73 +4774,73 @@ end

WAREHOUSE:_add_to_map(Map, Event)

- +

Add to map.

WAREHOUSE:_call_handler(step, trigger, params, EventName)

- +

Call handler.

WAREHOUSE:_create_transition(EventName)

- +

Create transition.

WAREHOUSE:_delayed_transition(EventName)

- +

Delayed transition.

WAREHOUSE:_eventmap(Events, EventStructure)

- +

Event map.

WAREHOUSE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

WAREHOUSE:_handler(EventName, ...)

- +

Handler.

WAREHOUSE:_isendstate(Current)

- +

Is end state.

WAREHOUSE:_submap(subs, sub, name)

- +

Sub maps.

WAREHOUSE:can(e)

- +

Check if can do an event.

WAREHOUSE:cannot(e)

- +

Check if cannot do an event.

WAREHOUSE.current

- +

Current state name.

@@ -4811,21 +4850,21 @@ end -

WAREHOUSE:is(state)

+

WAREHOUSE:is(State, If, state)

- +

Check if FSM is in state.

WAREHOUSE.options

- +

Options.

WAREHOUSE.subs

- +

Subs.

@@ -19669,11 +19708,14 @@ this request is used to put the groups back into the warehouse stock.

+ #string State

-

+ +

The FSM state.

+
@@ -19998,7 +20040,7 @@ this request is used to put the groups back into the warehouse stock.

WAREHOUSE:GetCurrentState()

- +

Get current state.

@@ -20006,6 +20048,17 @@ this request is used to put the groups back into the warehouse stock.

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -20025,6 +20078,17 @@ this request is used to put the groups back into the warehouse stock.

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -20091,7 +20155,7 @@ this request is used to put the groups back into the warehouse stock.

- +

Sub processes.

@@ -20103,7 +20167,7 @@ this request is used to put the groups back into the warehouse stock.

Returns a table with the scores defined.

@@ -20114,6 +20178,18 @@ this request is used to put the groups back into the warehouse stock.

+

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -20155,7 +20231,7 @@ this request is used to put the groups back into the warehouse stock.

WAREHOUSE:GetState()

- +

Get current state.

@@ -20163,6 +20239,17 @@ this request is used to put the groups back into the warehouse stock.

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -20182,6 +20269,17 @@ this request is used to put the groups back into the warehouse stock.

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -20208,7 +20306,7 @@ this request is used to put the groups back into the warehouse stock.

- +

Transitions.

@@ -20220,10 +20318,10 @@ this request is used to put the groups back into the warehouse stock.

- +

Check if FSM is in state.

@@ -20231,15 +20329,31 @@ this request is used to put the groups back into the warehouse stock.

-

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -20253,7 +20367,7 @@ this request is used to put the groups back into the warehouse stock.

WAREHOUSE:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -20265,11 +20379,14 @@ this request is used to put the groups back into the warehouse stock.

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -20396,7 +20513,7 @@ this request is used to put the groups back into the warehouse stock.

WAREHOUSE:_add_to_map(Map, Event)

- +

Add to map.

@@ -20408,21 +20525,27 @@ this request is used to put the groups back into the warehouse stock.

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -20436,7 +20559,7 @@ this request is used to put the groups back into the warehouse stock.

WAREHOUSE:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -20448,43 +20571,65 @@ this request is used to put the groups back into the warehouse stock.

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -20496,7 +20641,7 @@ this request is used to put the groups back into the warehouse stock.

WAREHOUSE:_create_transition(EventName)

- +

Create transition.

@@ -20508,13 +20653,27 @@ this request is used to put the groups back into the warehouse stock.

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -20526,7 +20685,7 @@ this request is used to put the groups back into the warehouse stock.

WAREHOUSE:_delayed_transition(EventName)

- +

Delayed transition.

@@ -20538,13 +20697,27 @@ this request is used to put the groups back into the warehouse stock.

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -20556,7 +20729,7 @@ this request is used to put the groups back into the warehouse stock.

WAREHOUSE:_eventmap(Events, EventStructure)

- +

Event map.

@@ -20568,21 +20741,27 @@ this request is used to put the groups back into the warehouse stock.

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -20596,7 +20775,7 @@ this request is used to put the groups back into the warehouse stock.

WAREHOUSE:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -20608,23 +20787,40 @@ this request is used to put the groups back into the warehouse stock.

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -20636,7 +20832,7 @@ this request is used to put the groups back into the warehouse stock.

WAREHOUSE:_handler(EventName, ...)

- +

Handler.

@@ -20648,11 +20844,14 @@ this request is used to put the groups back into the warehouse stock.

+ #string EventName

-

+ +

Event name.

+
@@ -20662,7 +20861,9 @@ this request is used to put the groups back into the warehouse stock.

-

+ +

Arguments.

+
@@ -20676,7 +20877,7 @@ this request is used to put the groups back into the warehouse stock.

WAREHOUSE:_isendstate(Current)

- +

Is end state.

@@ -20688,13 +20889,35 @@ this request is used to put the groups back into the warehouse stock.

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -20706,7 +20929,7 @@ this request is used to put the groups back into the warehouse stock.

WAREHOUSE:_submap(subs, sub, name)

- +

Sub maps.

@@ -20718,31 +20941,40 @@ this request is used to put the groups back into the warehouse stock.

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -20756,7 +20988,7 @@ this request is used to put the groups back into the warehouse stock.

WAREHOUSE:can(e)

- +

Check if can do an event.

@@ -20768,13 +21000,35 @@ this request is used to put the groups back into the warehouse stock.

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -20786,7 +21040,7 @@ this request is used to put the groups back into the warehouse stock.

WAREHOUSE:cannot(e)

- +

Check if cannot do an event.

@@ -20798,13 +21052,27 @@ this request is used to put the groups back into the warehouse stock.

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -20813,10 +21081,10 @@ this request is used to put the groups back into the warehouse stock.

- +

Check if FSM is in state.

@@ -20824,7 +21092,33 @@ this request is used to put the groups back into the warehouse stock.

-

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Functional.ZoneCaptureCoalition.html b/Documentation/Functional.ZoneCaptureCoalition.html index 490135052..6412eb667 100644 --- a/Documentation/Functional.ZoneCaptureCoalition.html +++ b/Documentation/Functional.ZoneCaptureCoalition.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Functional.ZoneGoal.html b/Documentation/Functional.ZoneGoal.html index bd32262d1..d42c2f637 100644 --- a/Documentation/Functional.ZoneGoal.html +++ b/Documentation/Functional.ZoneGoal.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Functional.ZoneGoalCargo.html b/Documentation/Functional.ZoneGoalCargo.html index 3ea515043..7873f7893 100644 --- a/Documentation/Functional.ZoneGoalCargo.html +++ b/Documentation/Functional.ZoneGoalCargo.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Functional.ZoneGoalCoalition.html b/Documentation/Functional.ZoneGoalCoalition.html index d512bc33e..371caf127 100644 --- a/Documentation/Functional.ZoneGoalCoalition.html +++ b/Documentation/Functional.ZoneGoalCoalition.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index 230baa83f..b0245c074 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -5443,7 +5476,13 @@ If enabled, status and debug text messages will be displayed on the screen. Also

AIRBOSS.CallScheduler

- +

Call scheduler.

+ + + +

AIRBOSS.ClassName

+ +

Name of the class.

@@ -5455,7 +5494,7 @@ If enabled, status and debug text messages will be displayed on the screen. Also

AIRBOSS:GetCurrentState()

- +

Get current state.

@@ -5477,7 +5516,7 @@ If enabled, status and debug text messages will be displayed on the screen. Also -

AIRBOSS:GetScores()

+

AIRBOSS:GetScores(Scores)

Returns a table with the scores defined.

@@ -5491,7 +5530,7 @@ If enabled, status and debug text messages will be displayed on the screen. Also

AIRBOSS:GetState()

- +

Get current state.

@@ -5507,15 +5546,15 @@ If enabled, status and debug text messages will be displayed on the screen. Also -

AIRBOSS:Is(State)

+

AIRBOSS:Is(State, If)

- +

Check if FSM is in state.

AIRBOSS:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -5527,7 +5566,7 @@ If enabled, status and debug text messages will be displayed on the screen. Also

AIRBOSS.Scores

- +

Scores.

@@ -5581,73 +5620,73 @@ If enabled, status and debug text messages will be displayed on the screen. Also

AIRBOSS:_add_to_map(Map, Event)

- +

Add to map.

AIRBOSS:_call_handler(step, trigger, params, EventName)

- +

Call handler.

AIRBOSS:_create_transition(EventName)

- +

Create transition.

AIRBOSS:_delayed_transition(EventName)

- +

Delayed transition.

AIRBOSS:_eventmap(Events, EventStructure)

- +

Event map.

AIRBOSS:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

AIRBOSS:_handler(EventName, ...)

- +

Handler.

AIRBOSS:_isendstate(Current)

- +

Is end state.

AIRBOSS:_submap(subs, sub, name)

- +

Sub maps.

AIRBOSS:can(e)

- +

Check if can do an event.

AIRBOSS:cannot(e)

- +

Check if cannot do an event.

AIRBOSS.current

- +

Current state name.

@@ -5657,21 +5696,21 @@ If enabled, status and debug text messages will be displayed on the screen. Also -

AIRBOSS:is(state)

+

AIRBOSS:is(State, If, state)

- +

Check if FSM is in state.

AIRBOSS.options

- +

Options.

AIRBOSS.subs

- +

Subs.

@@ -28746,11 +28785,14 @@ If removed flight is the section lead, we try to find a new leader.

+ #string State

-

+ +

The FSM state.

+
@@ -29075,7 +29117,7 @@ If removed flight is the section lead, we try to find a new leader.

AIRBOSS:GetCurrentState()

- +

Get current state.

@@ -29083,6 +29125,17 @@ If removed flight is the section lead, we try to find a new leader.

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -29102,6 +29155,17 @@ If removed flight is the section lead, we try to find a new leader.

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -29168,7 +29232,7 @@ If removed flight is the section lead, we try to find a new leader.

- +

Sub processes.

@@ -29180,7 +29244,7 @@ If removed flight is the section lead, we try to find a new leader.

Returns a table with the scores defined.

@@ -29191,6 +29255,18 @@ If removed flight is the section lead, we try to find a new leader.

+

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -29232,7 +29308,7 @@ If removed flight is the section lead, we try to find a new leader.

AIRBOSS:GetState()

- +

Get current state.

@@ -29240,6 +29316,17 @@ If removed flight is the section lead, we try to find a new leader.

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -29259,6 +29346,17 @@ If removed flight is the section lead, we try to find a new leader.

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -29285,7 +29383,7 @@ If removed flight is the section lead, we try to find a new leader.

- +

Transitions.

@@ -29297,10 +29395,10 @@ If removed flight is the section lead, we try to find a new leader.

- +

Check if FSM is in state.

@@ -29308,15 +29406,31 @@ If removed flight is the section lead, we try to find a new leader.

-

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -29330,7 +29444,7 @@ If removed flight is the section lead, we try to find a new leader.

AIRBOSS:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -29342,11 +29456,14 @@ If removed flight is the section lead, we try to find a new leader.

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -29473,7 +29590,7 @@ If removed flight is the section lead, we try to find a new leader.

AIRBOSS:_add_to_map(Map, Event)

- +

Add to map.

@@ -29485,21 +29602,27 @@ If removed flight is the section lead, we try to find a new leader.

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -29513,7 +29636,7 @@ If removed flight is the section lead, we try to find a new leader.

AIRBOSS:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -29525,43 +29648,65 @@ If removed flight is the section lead, we try to find a new leader.

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -29573,7 +29718,7 @@ If removed flight is the section lead, we try to find a new leader.

AIRBOSS:_create_transition(EventName)

- +

Create transition.

@@ -29585,13 +29730,27 @@ If removed flight is the section lead, we try to find a new leader.

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -29603,7 +29762,7 @@ If removed flight is the section lead, we try to find a new leader.

AIRBOSS:_delayed_transition(EventName)

- +

Delayed transition.

@@ -29615,13 +29774,27 @@ If removed flight is the section lead, we try to find a new leader.

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -29633,7 +29806,7 @@ If removed flight is the section lead, we try to find a new leader.

AIRBOSS:_eventmap(Events, EventStructure)

- +

Event map.

@@ -29645,21 +29818,27 @@ If removed flight is the section lead, we try to find a new leader.

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -29673,7 +29852,7 @@ If removed flight is the section lead, we try to find a new leader.

AIRBOSS:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -29685,23 +29864,40 @@ If removed flight is the section lead, we try to find a new leader.

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -29713,7 +29909,7 @@ If removed flight is the section lead, we try to find a new leader.

AIRBOSS:_handler(EventName, ...)

- +

Handler.

@@ -29725,11 +29921,14 @@ If removed flight is the section lead, we try to find a new leader.

+ #string EventName

-

+ +

Event name.

+
@@ -29739,7 +29938,9 @@ If removed flight is the section lead, we try to find a new leader.

-

+ +

Arguments.

+
@@ -29753,7 +29954,7 @@ If removed flight is the section lead, we try to find a new leader.

AIRBOSS:_isendstate(Current)

- +

Is end state.

@@ -29765,13 +29966,35 @@ If removed flight is the section lead, we try to find a new leader.

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -29783,7 +30006,7 @@ If removed flight is the section lead, we try to find a new leader.

AIRBOSS:_submap(subs, sub, name)

- +

Sub maps.

@@ -29795,31 +30018,40 @@ If removed flight is the section lead, we try to find a new leader.

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -29833,7 +30065,7 @@ If removed flight is the section lead, we try to find a new leader.

AIRBOSS:can(e)

- +

Check if can do an event.

@@ -29845,13 +30077,35 @@ If removed flight is the section lead, we try to find a new leader.

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -29863,7 +30117,7 @@ If removed flight is the section lead, we try to find a new leader.

AIRBOSS:cannot(e)

- +

Check if cannot do an event.

@@ -29875,13 +30129,27 @@ If removed flight is the section lead, we try to find a new leader.

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -29890,10 +30158,10 @@ If removed flight is the section lead, we try to find a new leader.

- +

Check if FSM is in state.

@@ -29901,7 +30169,33 @@ If removed flight is the section lead, we try to find a new leader.

-

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

@@ -37344,7 +37638,7 @@ BASE:TraceOnOff( false ) -

Set current case.

+

Set case of f

@@ -37426,17 +37720,6 @@ BASE:TraceOnOff( false )

Data table at each position in the groove. Elements are of type AIRBOSS.GrooveData.

-
- -
-
-
- - #boolean -AIRBOSS.PlayerData.holding - - -
@@ -37605,6 +37888,9 @@ BASE:TraceOnOff( false ) + +

Set new time stamp.

+
diff --git a/Documentation/Ops.Atis.html b/Documentation/Ops.Atis.html index 2b05b7359..30c0e2490 100644 --- a/Documentation/Ops.Atis.html +++ b/Documentation/Ops.Atis.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1773,13 +1806,13 @@ atisAbuDhabi:Start()

ATIS:ReportQNHOnly()

- +

Suppresses QFE readout.

ATIS:ReportZuluTimeOnly()

- +

Suppresses local time, sunrise, and sunset.

@@ -2297,7 +2330,13 @@ atisAbuDhabi:Start()

ATIS.CallScheduler

- +

Call scheduler.

+ + + +

ATIS.ClassName

+ +

Name of the class.

@@ -2309,7 +2348,7 @@ atisAbuDhabi:Start()

ATIS:GetCurrentState()

- +

Get current state.

@@ -2331,7 +2370,7 @@ atisAbuDhabi:Start() -

ATIS:GetScores()

+

ATIS:GetScores(Scores)

Returns a table with the scores defined.

@@ -2345,7 +2384,7 @@ atisAbuDhabi:Start()

ATIS:GetState()

- +

Get current state.

@@ -2361,15 +2400,15 @@ atisAbuDhabi:Start() -

ATIS:Is(State)

+

ATIS:Is(State, If)

- +

Check if FSM is in state.

ATIS:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2381,7 +2420,7 @@ atisAbuDhabi:Start()

ATIS.Scores

- +

Scores.

@@ -2435,73 +2474,73 @@ atisAbuDhabi:Start()

ATIS:_add_to_map(Map, Event)

- +

Add to map.

ATIS:_call_handler(step, trigger, params, EventName)

- +

Call handler.

ATIS:_create_transition(EventName)

- +

Create transition.

ATIS:_delayed_transition(EventName)

- +

Delayed transition.

ATIS:_eventmap(Events, EventStructure)

- +

Event map.

ATIS:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

ATIS:_handler(EventName, ...)

- +

Handler.

ATIS:_isendstate(Current)

- +

Is end state.

ATIS:_submap(subs, sub, name)

- +

Sub maps.

ATIS:can(e)

- +

Check if can do an event.

ATIS:cannot(e)

- +

Check if cannot do an event.

ATIS.current

- +

Current state name.

@@ -2511,21 +2550,21 @@ atisAbuDhabi:Start() -

ATIS:is(state)

+

ATIS:is(State, If, state)

- +

Check if FSM is in state.

ATIS.options

- +

Options.

ATIS.subs

- +

Subs.

@@ -3515,6 +3554,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

ATIS.Sound.SnowStorm

+ + + +

ATIS.Sound.StatuteMiles

+ + @@ -3593,6 +3638,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

ATIS.Sound.WindFrom

+ + + +

ATIS.Sound.Zulu

+ + @@ -4916,12 +4967,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

ATIS:ReportQNHOnly()

- +

Suppresses QFE readout.

-

Suppresses QFE readout. Default is to report both QNH and QFE. - @param #ATIS self - @return #ATIS self

+

Default is to report both QNH and QFE.

@@ -4929,6 +4978,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

ATIS

+

Return value:

+
+
+

#ATIS:

+
+
+ +

self

+ +
+
@@ -4940,12 +5000,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

ATIS:ReportZuluTimeOnly()

- +

Suppresses local time, sunrise, and sunset.

-

Suppresses local time, sunrise, and sunset. Default is to report all these times. - @param #ATIS self - @return #ATIS self

+

Default is to report all these times.

@@ -4953,6 +5011,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

ATIS

+

Return value:

+
+
+

#ATIS:

+
+
+ +

self

+ +
+
@@ -7253,11 +7322,14 @@ Note that the dew point is only an artificial information as DCS does not have a

+ #string State

-

+ +

The FSM state.

+
@@ -7582,7 +7654,7 @@ Note that the dew point is only an artificial information as DCS does not have a

ATIS:GetCurrentState()

- +

Get current state.

@@ -7590,6 +7662,17 @@ Note that the dew point is only an artificial information as DCS does not have a +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -7609,6 +7692,17 @@ Note that the dew point is only an artificial information as DCS does not have a +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -7675,7 +7769,7 @@ Note that the dew point is only an artificial information as DCS does not have a
- +

Sub processes.

@@ -7687,7 +7781,7 @@ Note that the dew point is only an artificial information as DCS does not have a

Returns a table with the scores defined.

@@ -7698,6 +7792,18 @@ Note that the dew point is only an artificial information as DCS does not have a +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -7739,7 +7845,7 @@ Note that the dew point is only an artificial information as DCS does not have a

ATIS:GetState()

- +

Get current state.

@@ -7747,6 +7853,17 @@ Note that the dew point is only an artificial information as DCS does not have a +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -7766,6 +7883,17 @@ Note that the dew point is only an artificial information as DCS does not have a +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -7792,7 +7920,7 @@ Note that the dew point is only an artificial information as DCS does not have a
- +

Transitions.

@@ -7804,10 +7932,10 @@ Note that the dew point is only an artificial information as DCS does not have a
- +

Check if FSM is in state.

@@ -7815,15 +7943,31 @@ Note that the dew point is only an artificial information as DCS does not have a -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -7837,7 +7981,7 @@ Note that the dew point is only an artificial information as DCS does not have a

ATIS:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -7849,11 +7993,14 @@ Note that the dew point is only an artificial information as DCS does not have a

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -7980,7 +8127,7 @@ Note that the dew point is only an artificial information as DCS does not have a

ATIS:_add_to_map(Map, Event)

- +

Add to map.

@@ -7992,21 +8139,27 @@ Note that the dew point is only an artificial information as DCS does not have a

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -8020,7 +8173,7 @@ Note that the dew point is only an artificial information as DCS does not have a

ATIS:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -8032,43 +8185,65 @@ Note that the dew point is only an artificial information as DCS does not have a

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -8080,7 +8255,7 @@ Note that the dew point is only an artificial information as DCS does not have a

ATIS:_create_transition(EventName)

- +

Create transition.

@@ -8092,13 +8267,27 @@ Note that the dew point is only an artificial information as DCS does not have a

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -8110,7 +8299,7 @@ Note that the dew point is only an artificial information as DCS does not have a

ATIS:_delayed_transition(EventName)

- +

Delayed transition.

@@ -8122,13 +8311,27 @@ Note that the dew point is only an artificial information as DCS does not have a

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -8140,7 +8343,7 @@ Note that the dew point is only an artificial information as DCS does not have a

ATIS:_eventmap(Events, EventStructure)

- +

Event map.

@@ -8152,21 +8355,27 @@ Note that the dew point is only an artificial information as DCS does not have a

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -8180,7 +8389,7 @@ Note that the dew point is only an artificial information as DCS does not have a

ATIS:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -8192,23 +8401,40 @@ Note that the dew point is only an artificial information as DCS does not have a

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -8220,7 +8446,7 @@ Note that the dew point is only an artificial information as DCS does not have a

ATIS:_handler(EventName, ...)

- +

Handler.

@@ -8232,11 +8458,14 @@ Note that the dew point is only an artificial information as DCS does not have a

+ #string EventName

-

+ +

Event name.

+
@@ -8246,7 +8475,9 @@ Note that the dew point is only an artificial information as DCS does not have a

-

+ +

Arguments.

+
@@ -8260,7 +8491,7 @@ Note that the dew point is only an artificial information as DCS does not have a

ATIS:_isendstate(Current)

- +

Is end state.

@@ -8272,13 +8503,35 @@ Note that the dew point is only an artificial information as DCS does not have a

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -8290,7 +8543,7 @@ Note that the dew point is only an artificial information as DCS does not have a

ATIS:_submap(subs, sub, name)

- +

Sub maps.

@@ -8302,31 +8555,40 @@ Note that the dew point is only an artificial information as DCS does not have a

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -8340,7 +8602,7 @@ Note that the dew point is only an artificial information as DCS does not have a

ATIS:can(e)

- +

Check if can do an event.

@@ -8352,13 +8614,35 @@ Note that the dew point is only an artificial information as DCS does not have a

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -8370,7 +8654,7 @@ Note that the dew point is only an artificial information as DCS does not have a

ATIS:cannot(e)

- +

Check if cannot do an event.

@@ -8382,13 +8666,27 @@ Note that the dew point is only an artificial information as DCS does not have a

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -8397,10 +8695,10 @@ Note that the dew point is only an artificial information as DCS does not have a
- +

Check if FSM is in state.

@@ -8408,7 +8706,33 @@ Note that the dew point is only an artificial information as DCS does not have a -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

@@ -12770,6 +13094,17 @@ BASE:TraceOnOff( false ) +

+ +
+
+
+ + #table +ATIS.Sound.StatuteMiles + + +
@@ -12913,6 +13248,17 @@ BASE:TraceOnOff( false ) +
+ +
+
+
+ + #table +ATIS.Sound.Zulu + + +
diff --git a/Documentation/Ops.RecoveryTanker.html b/Documentation/Ops.RecoveryTanker.html index e83501b21..63d802d35 100644 --- a/Documentation/Ops.RecoveryTanker.html +++ b/Documentation/Ops.RecoveryTanker.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2329,7 +2362,13 @@ If enabled, text messages about the tanker status will be displayed on screen an

RECOVERYTANKER.CallScheduler

- +

Call scheduler.

+ + + +

RECOVERYTANKER.ClassName

+ +

Name of the class.

@@ -2341,7 +2380,7 @@ If enabled, text messages about the tanker status will be displayed on screen an

RECOVERYTANKER:GetCurrentState()

- +

Get current state.

@@ -2363,7 +2402,7 @@ If enabled, text messages about the tanker status will be displayed on screen an -

RECOVERYTANKER:GetScores()

+

RECOVERYTANKER:GetScores(Scores)

Returns a table with the scores defined.

@@ -2377,7 +2416,7 @@ If enabled, text messages about the tanker status will be displayed on screen an

RECOVERYTANKER:GetState()

- +

Get current state.

@@ -2393,15 +2432,15 @@ If enabled, text messages about the tanker status will be displayed on screen an -

RECOVERYTANKER:Is(State)

+

RECOVERYTANKER:Is(State, If)

- +

Check if FSM is in state.

RECOVERYTANKER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2413,7 +2452,7 @@ If enabled, text messages about the tanker status will be displayed on screen an

RECOVERYTANKER.Scores

- +

Scores.

@@ -2467,73 +2506,73 @@ If enabled, text messages about the tanker status will be displayed on screen an

RECOVERYTANKER:_add_to_map(Map, Event)

- +

Add to map.

RECOVERYTANKER:_call_handler(step, trigger, params, EventName)

- +

Call handler.

RECOVERYTANKER:_create_transition(EventName)

- +

Create transition.

RECOVERYTANKER:_delayed_transition(EventName)

- +

Delayed transition.

RECOVERYTANKER:_eventmap(Events, EventStructure)

- +

Event map.

RECOVERYTANKER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

RECOVERYTANKER:_handler(EventName, ...)

- +

Handler.

RECOVERYTANKER:_isendstate(Current)

- +

Is end state.

RECOVERYTANKER:_submap(subs, sub, name)

- +

Sub maps.

RECOVERYTANKER:can(e)

- +

Check if can do an event.

RECOVERYTANKER:cannot(e)

- +

Check if cannot do an event.

RECOVERYTANKER.current

- +

Current state name.

@@ -2543,21 +2582,21 @@ If enabled, text messages about the tanker status will be displayed on screen an -

RECOVERYTANKER:is(state)

+

RECOVERYTANKER:is(State, If, state)

- +

Check if FSM is in state.

RECOVERYTANKER.options

- +

Options.

RECOVERYTANKER.subs

- +

Subs.

@@ -7051,11 +7090,14 @@ The group name is the one specified in the RECO

+ #string State

-

+ +

The FSM state.

+
@@ -7380,7 +7422,7 @@ The group name is the one specified in the
RECO

RECOVERYTANKER:GetCurrentState()

- +

Get current state.

@@ -7388,6 +7430,17 @@ The group name is the one specified in the RECO +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -7407,6 +7460,17 @@ The group name is the one specified in the RECO +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -7473,7 +7537,7 @@ The group name is the one specified in the RECO
- +

Sub processes.

@@ -7485,7 +7549,7 @@ The group name is the one specified in the
RECO

Returns a table with the scores defined.

@@ -7496,6 +7560,18 @@ The group name is the one specified in the RECO +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -7537,7 +7613,7 @@ The group name is the one specified in the RECO

RECOVERYTANKER:GetState()

- +

Get current state.

@@ -7545,6 +7621,17 @@ The group name is the one specified in the RECO +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -7564,6 +7651,17 @@ The group name is the one specified in the RECO +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -7590,7 +7688,7 @@ The group name is the one specified in the RECO
- +

Transitions.

@@ -7602,10 +7700,10 @@ The group name is the one specified in the
RECO - +

Create transition.

@@ -7908,7 +8067,7 @@ The group name is the one specified in the RECO

RECOVERYTANKER:_delayed_transition(EventName)

- +

Delayed transition.

@@ -7938,7 +8111,7 @@ The group name is the one specified in the RECO

RECOVERYTANKER:_eventmap(Events, EventStructure)

- +

Event map.

- +

Go sub.

@@ -8018,7 +8214,7 @@ The group name is the one specified in the RECO

RECOVERYTANKER:_handler(EventName, ...)

- +

Handler.

@@ -8058,7 +8259,7 @@ The group name is the one specified in the RECO

RECOVERYTANKER:_isendstate(Current)

- +

Is end state.

@@ -8088,7 +8311,7 @@ The group name is the one specified in the RECO

RECOVERYTANKER:_submap(subs, sub, name)

- +

Sub maps.

- +

Check if can do an event.

@@ -8168,7 +8422,7 @@ The group name is the one specified in the RECO

RECOVERYTANKER:cannot(e)

- +

Check if cannot do an event.

@@ -8195,10 +8463,10 @@ The group name is the one specified in the RECO
- +

Check if FSM is in state.

@@ -8206,7 +8474,33 @@ The group name is the one specified in the RECO -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Ops.RescueHelo.html b/Documentation/Ops.RescueHelo.html index fdf39ed80..9c978324f 100644 --- a/Documentation/Ops.RescueHelo.html +++ b/Documentation/Ops.RescueHelo.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2159,7 +2192,13 @@ If enabled, text messages about the helo status will be displayed on screen and

RESCUEHELO.CallScheduler

- +

Call scheduler.

+ + + +

RESCUEHELO.ClassName

+ +

Name of the class.

@@ -2171,7 +2210,7 @@ If enabled, text messages about the helo status will be displayed on screen and

RESCUEHELO:GetCurrentState()

- +

Get current state.

@@ -2193,7 +2232,7 @@ If enabled, text messages about the helo status will be displayed on screen and -

RESCUEHELO:GetScores()

+

RESCUEHELO:GetScores(Scores)

Returns a table with the scores defined.

@@ -2207,7 +2246,7 @@ If enabled, text messages about the helo status will be displayed on screen and

RESCUEHELO:GetState()

- +

Get current state.

@@ -2223,15 +2262,15 @@ If enabled, text messages about the helo status will be displayed on screen and -

RESCUEHELO:Is(State)

+

RESCUEHELO:Is(State, If)

- +

Check if FSM is in state.

RESCUEHELO:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2243,7 +2282,7 @@ If enabled, text messages about the helo status will be displayed on screen and

RESCUEHELO.Scores

- +

Scores.

@@ -2297,73 +2336,73 @@ If enabled, text messages about the helo status will be displayed on screen and

RESCUEHELO:_add_to_map(Map, Event)

- +

Add to map.

RESCUEHELO:_call_handler(step, trigger, params, EventName)

- +

Call handler.

RESCUEHELO:_create_transition(EventName)

- +

Create transition.

RESCUEHELO:_delayed_transition(EventName)

- +

Delayed transition.

RESCUEHELO:_eventmap(Events, EventStructure)

- +

Event map.

RESCUEHELO:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

RESCUEHELO:_handler(EventName, ...)

- +

Handler.

RESCUEHELO:_isendstate(Current)

- +

Is end state.

RESCUEHELO:_submap(subs, sub, name)

- +

Sub maps.

RESCUEHELO:can(e)

- +

Check if can do an event.

RESCUEHELO:cannot(e)

- +

Check if cannot do an event.

RESCUEHELO.current

- +

Current state name.

@@ -2373,21 +2412,21 @@ If enabled, text messages about the helo status will be displayed on screen and -

RESCUEHELO:is(state)

+

RESCUEHELO:is(State, If, state)

- +

Check if FSM is in state.

RESCUEHELO.options

- +

Options.

RESCUEHELO.subs

- +

Subs.

@@ -6179,11 +6218,14 @@ The group name is the one specified in the RESCUEHE

+ #string State

-

+ +

The FSM state.

+
@@ -6508,7 +6550,7 @@ The group name is the one specified in the
RESCUEHE

RESCUEHELO:GetCurrentState()

- +

Get current state.

@@ -6516,6 +6558,17 @@ The group name is the one specified in the RESCUEHE +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -6535,6 +6588,17 @@ The group name is the one specified in the RESCUEHE +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -6601,7 +6665,7 @@ The group name is the one specified in the RESCUEHE
- +

Sub processes.

@@ -6613,7 +6677,7 @@ The group name is the one specified in the
RESCUEHE

Returns a table with the scores defined.

@@ -6624,6 +6688,18 @@ The group name is the one specified in the RESCUEHE +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -6665,7 +6741,7 @@ The group name is the one specified in the RESCUEHE

RESCUEHELO:GetState()

- +

Get current state.

@@ -6673,6 +6749,17 @@ The group name is the one specified in the RESCUEHE +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -6692,6 +6779,17 @@ The group name is the one specified in the RESCUEHE +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -6718,7 +6816,7 @@ The group name is the one specified in the RESCUEHE
- +

Transitions.

@@ -6730,10 +6828,10 @@ The group name is the one specified in the
RESCUEHE - +

Create transition.

@@ -7036,7 +7195,7 @@ The group name is the one specified in the RESCUEHE

RESCUEHELO:_delayed_transition(EventName)

- +

Delayed transition.

@@ -7066,7 +7239,7 @@ The group name is the one specified in the RESCUEHE

RESCUEHELO:_eventmap(Events, EventStructure)

- +

Event map.

- +

Go sub.

@@ -7146,7 +7342,7 @@ The group name is the one specified in the RESCUEHE

RESCUEHELO:_handler(EventName, ...)

- +

Handler.

@@ -7186,7 +7387,7 @@ The group name is the one specified in the RESCUEHE

RESCUEHELO:_isendstate(Current)

- +

Is end state.

@@ -7216,7 +7439,7 @@ The group name is the one specified in the RESCUEHE

RESCUEHELO:_submap(subs, sub, name)

- +

Sub maps.

- +

Check if can do an event.

@@ -7296,7 +7550,7 @@ The group name is the one specified in the RESCUEHE

RESCUEHELO:cannot(e)

- +

Check if cannot do an event.

@@ -7323,10 +7591,10 @@ The group name is the one specified in the RESCUEHE
- +

Check if FSM is in state.

@@ -7334,7 +7602,33 @@ The group name is the one specified in the RESCUEHE -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Tasking.CommandCenter.html b/Documentation/Tasking.CommandCenter.html index 4683984c6..a0e8698ce 100644 --- a/Documentation/Tasking.CommandCenter.html +++ b/Documentation/Tasking.CommandCenter.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Tasking.DetectionManager.html b/Documentation/Tasking.DetectionManager.html index a961dacec..089a0fc73 100644 --- a/Documentation/Tasking.DetectionManager.html +++ b/Documentation/Tasking.DetectionManager.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1623,7 +1656,13 @@ If an ad-hoc report is requested, use the method

DETECTION_MANAGER.CallScheduler

- +

Call scheduler.

+ + + +

DETECTION_MANAGER.ClassName

+ +

Name of the class.

@@ -1635,7 +1674,7 @@ If an ad-hoc report is requested, use the method

DETECTION_MANAGER:GetCurrentState()

- +

Get current state.

@@ -1657,7 +1696,7 @@ If an ad-hoc report is requested, use the method -

DETECTION_MANAGER:GetScores()

+

DETECTION_MANAGER:GetScores(Scores)

Returns a table with the scores defined.

@@ -1671,7 +1710,7 @@ If an ad-hoc report is requested, use the method

DETECTION_MANAGER:GetState()

- +

Get current state.

@@ -1687,15 +1726,15 @@ If an ad-hoc report is requested, use the method -

DETECTION_MANAGER:Is(State)

+

DETECTION_MANAGER:Is(State, If)

- +

Check if FSM is in state.

DETECTION_MANAGER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1707,7 +1746,7 @@ If an ad-hoc report is requested, use the method

DETECTION_MANAGER.Scores

- +

Scores.

@@ -1761,73 +1800,73 @@ If an ad-hoc report is requested, use the method

DETECTION_MANAGER:_add_to_map(Map, Event)

- +

Add to map.

DETECTION_MANAGER:_call_handler(step, trigger, params, EventName)

- +

Call handler.

DETECTION_MANAGER:_create_transition(EventName)

- +

Create transition.

DETECTION_MANAGER:_delayed_transition(EventName)

- +

Delayed transition.

DETECTION_MANAGER:_eventmap(Events, EventStructure)

- +

Event map.

DETECTION_MANAGER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

DETECTION_MANAGER:_handler(EventName, ...)

- +

Handler.

DETECTION_MANAGER:_isendstate(Current)

- +

Is end state.

DETECTION_MANAGER:_submap(subs, sub, name)

- +

Sub maps.

DETECTION_MANAGER:can(e)

- +

Check if can do an event.

DETECTION_MANAGER:cannot(e)

- +

Check if cannot do an event.

DETECTION_MANAGER.current

- +

Current state name.

@@ -1837,21 +1876,21 @@ If an ad-hoc report is requested, use the method -

DETECTION_MANAGER:is(state)

+

DETECTION_MANAGER:is(State, If, state)

- +

Check if FSM is in state.

DETECTION_MANAGER.options

- +

Options.

DETECTION_MANAGER.subs

- +

Subs.

@@ -3680,11 +3719,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string State

-

+ +

The FSM state.

+
@@ -4009,7 +4051,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

DETECTION_MANAGER:GetCurrentState()

- +

Get current state.

@@ -4017,6 +4059,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -4036,6 +4089,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -4102,7 +4166,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Sub processes.

@@ -4114,7 +4178,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Returns a table with the scores defined.

@@ -4125,6 +4189,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -4166,7 +4242,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

DETECTION_MANAGER:GetState()

- +

Get current state.

@@ -4174,6 +4250,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -4193,6 +4280,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -4219,7 +4317,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Transitions.

@@ -4231,10 +4329,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

@@ -4242,15 +4340,31 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -4264,7 +4378,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

DETECTION_MANAGER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -4276,11 +4390,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -4407,7 +4524,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

DETECTION_MANAGER:_add_to_map(Map, Event)

- +

Add to map.

@@ -4419,21 +4536,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -4447,7 +4570,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

DETECTION_MANAGER:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -4459,43 +4582,65 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -4507,7 +4652,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

DETECTION_MANAGER:_create_transition(EventName)

- +

Create transition.

@@ -4519,13 +4664,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -4537,7 +4696,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

DETECTION_MANAGER:_delayed_transition(EventName)

- +

Delayed transition.

@@ -4549,13 +4708,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -4567,7 +4740,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

DETECTION_MANAGER:_eventmap(Events, EventStructure)

- +

Event map.

@@ -4579,21 +4752,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -4607,7 +4786,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

DETECTION_MANAGER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -4619,23 +4798,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -4647,7 +4843,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

DETECTION_MANAGER:_handler(EventName, ...)

- +

Handler.

@@ -4659,11 +4855,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
@@ -4673,7 +4872,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

-

+ +

Arguments.

+
@@ -4687,7 +4888,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

DETECTION_MANAGER:_isendstate(Current)

- +

Is end state.

@@ -4699,13 +4900,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -4717,7 +4940,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

DETECTION_MANAGER:_submap(subs, sub, name)

- +

Sub maps.

@@ -4729,31 +4952,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -4767,7 +4999,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

DETECTION_MANAGER:can(e)

- +

Check if can do an event.

@@ -4779,13 +5011,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -4797,7 +5051,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

DETECTION_MANAGER:cannot(e)

- +

Check if cannot do an event.

@@ -4809,13 +5063,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -4824,10 +5092,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

@@ -4835,7 +5103,33 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Tasking.Mission.html b/Documentation/Tasking.Mission.html index 5e67394f0..84270771c 100644 --- a/Documentation/Tasking.Mission.html +++ b/Documentation/Tasking.Mission.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2038,7 +2071,13 @@ structure managing the tasks of the mission.

MISSION.CallScheduler

- +

Call scheduler.

+ + + +

MISSION.ClassName

+ +

Name of the class.

@@ -2050,7 +2089,7 @@ structure managing the tasks of the mission.

MISSION:GetCurrentState()

- +

Get current state.

@@ -2072,7 +2111,7 @@ structure managing the tasks of the mission.

-

MISSION:GetScores()

+

MISSION:GetScores(Scores)

Returns a table with the scores defined.

@@ -2086,7 +2125,7 @@ structure managing the tasks of the mission.

MISSION:GetState()

- +

Get current state.

@@ -2102,15 +2141,15 @@ structure managing the tasks of the mission.

-

MISSION:Is(State)

+

MISSION:Is(State, If)

- +

Check if FSM is in state.

MISSION:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2122,7 +2161,7 @@ structure managing the tasks of the mission.

MISSION.Scores

- +

Scores.

@@ -2176,73 +2215,73 @@ structure managing the tasks of the mission.

MISSION:_add_to_map(Map, Event)

- +

Add to map.

MISSION:_call_handler(step, trigger, params, EventName)

- +

Call handler.

MISSION:_create_transition(EventName)

- +

Create transition.

MISSION:_delayed_transition(EventName)

- +

Delayed transition.

MISSION:_eventmap(Events, EventStructure)

- +

Event map.

MISSION:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

MISSION:_handler(EventName, ...)

- +

Handler.

MISSION:_isendstate(Current)

- +

Is end state.

MISSION:_submap(subs, sub, name)

- +

Sub maps.

MISSION:can(e)

- +

Check if can do an event.

MISSION:cannot(e)

- +

Check if cannot do an event.

MISSION.current

- +

Current state name.

@@ -2252,21 +2291,21 @@ structure managing the tasks of the mission.

-

MISSION:is(state)

+

MISSION:is(State, If, state)

- +

Check if FSM is in state.

MISSION.options

- +

Options.

MISSION.subs

- +

Subs.

@@ -6302,11 +6341,14 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

+ #string State

-

+ +

The FSM state.

+
@@ -6631,7 +6673,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

MISSION:GetCurrentState()

- +

Get current state.

@@ -6639,6 +6681,17 @@ Each Task can be set a certain Goals. The Mission will not be completed until al +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -6658,6 +6711,17 @@ Each Task can be set a certain Goals. The Mission will not be completed until al +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -6724,7 +6788,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al
- +

Sub processes.

@@ -6736,7 +6800,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

Returns a table with the scores defined.

@@ -6747,6 +6811,18 @@ Each Task can be set a certain Goals. The Mission will not be completed until al +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -6788,7 +6864,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

MISSION:GetState()

- +

Get current state.

@@ -6796,6 +6872,17 @@ Each Task can be set a certain Goals. The Mission will not be completed until al +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -6815,6 +6902,17 @@ Each Task can be set a certain Goals. The Mission will not be completed until al +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -6841,7 +6939,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al
- +

Transitions.

@@ -6853,10 +6951,10 @@ Each Task can be set a certain Goals. The Mission will not be completed until al
- +

Check if FSM is in state.

@@ -6864,15 +6962,31 @@ Each Task can be set a certain Goals. The Mission will not be completed until al -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -6886,7 +7000,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

MISSION:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -6898,11 +7012,14 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -7029,7 +7146,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

MISSION:_add_to_map(Map, Event)

- +

Add to map.

@@ -7041,21 +7158,27 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -7069,7 +7192,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

MISSION:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -7081,43 +7204,65 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -7129,7 +7274,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

MISSION:_create_transition(EventName)

- +

Create transition.

@@ -7141,13 +7286,27 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -7159,7 +7318,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

MISSION:_delayed_transition(EventName)

- +

Delayed transition.

@@ -7171,13 +7330,27 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -7189,7 +7362,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

MISSION:_eventmap(Events, EventStructure)

- +

Event map.

@@ -7201,21 +7374,27 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -7229,7 +7408,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

MISSION:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -7241,23 +7420,40 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -7269,7 +7465,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

MISSION:_handler(EventName, ...)

- +

Handler.

@@ -7281,11 +7477,14 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

+ #string EventName

-

+ +

Event name.

+
@@ -7295,7 +7494,9 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

-

+ +

Arguments.

+
@@ -7309,7 +7510,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

MISSION:_isendstate(Current)

- +

Is end state.

@@ -7321,13 +7522,35 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -7339,7 +7562,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

MISSION:_submap(subs, sub, name)

- +

Sub maps.

@@ -7351,31 +7574,40 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -7389,7 +7621,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

MISSION:can(e)

- +

Check if can do an event.

@@ -7401,13 +7633,35 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -7419,7 +7673,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

MISSION:cannot(e)

- +

Check if cannot do an event.

@@ -7431,13 +7685,27 @@ Each Task can be set a certain Goals. The Mission will not be completed until al

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -7446,10 +7714,10 @@ Each Task can be set a certain Goals. The Mission will not be completed until al
- +

Check if FSM is in state.

@@ -7457,7 +7725,33 @@ Each Task can be set a certain Goals. The Mission will not be completed until al -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Tasking.Task.html b/Documentation/Tasking.Task.html index fa63cb0e5..67468c54b 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Tasking.TaskInfo.html b/Documentation/Tasking.TaskInfo.html index 0af59e69a..1ed10d92b 100644 --- a/Documentation/Tasking.TaskInfo.html +++ b/Documentation/Tasking.TaskInfo.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Tasking.TaskZoneCapture.html b/Documentation/Tasking.TaskZoneCapture.html index 2d1df4cf5..7dbead9a3 100644 --- a/Documentation/Tasking.TaskZoneCapture.html +++ b/Documentation/Tasking.TaskZoneCapture.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Tasking.Task_A2A.html b/Documentation/Tasking.Task_A2A.html index 7b43a6b11..e33fcc3d2 100644 --- a/Documentation/Tasking.Task_A2A.html +++ b/Documentation/Tasking.Task_A2A.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html index 562bc9bb2..0e0106f24 100644 --- a/Documentation/Tasking.Task_A2A_Dispatcher.html +++ b/Documentation/Tasking.Task_A2A_Dispatcher.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1831,7 +1864,13 @@ So, this method will be called only ONCE when a player joins a

TASK_A2A_DISPATCHER.CallScheduler

- +

Call scheduler.

+ + + +

TASK_A2A_DISPATCHER.ClassName

+ +

Name of the class.

@@ -1843,7 +1882,7 @@ So, this method will be called only ONCE when a player joins a

TASK_A2A_DISPATCHER:GetCurrentState()

- +

Get current state.

@@ -1865,7 +1904,7 @@ So, this method will be called only ONCE when a player joins a -

TASK_A2A_DISPATCHER:GetScores()

+

TASK_A2A_DISPATCHER:GetScores(Scores)

Returns a table with the scores defined.

@@ -1879,7 +1918,7 @@ So, this method will be called only ONCE when a player joins a

TASK_A2A_DISPATCHER:GetState()

- +

Get current state.

@@ -1895,15 +1934,15 @@ So, this method will be called only ONCE when a player joins a -

TASK_A2A_DISPATCHER:Is(State)

+

TASK_A2A_DISPATCHER:Is(State, If)

- +

Check if FSM is in state.

TASK_A2A_DISPATCHER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1915,7 +1954,7 @@ So, this method will be called only ONCE when a player joins a

TASK_A2A_DISPATCHER.Scores

- +

Scores.

@@ -1969,73 +2008,73 @@ So, this method will be called only ONCE when a player joins a

TASK_A2A_DISPATCHER:_add_to_map(Map, Event)

- +

Add to map.

TASK_A2A_DISPATCHER:_call_handler(step, trigger, params, EventName)

- +

Call handler.

TASK_A2A_DISPATCHER:_create_transition(EventName)

- +

Create transition.

TASK_A2A_DISPATCHER:_delayed_transition(EventName)

- +

Delayed transition.

TASK_A2A_DISPATCHER:_eventmap(Events, EventStructure)

- +

Event map.

TASK_A2A_DISPATCHER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

TASK_A2A_DISPATCHER:_handler(EventName, ...)

- +

Handler.

TASK_A2A_DISPATCHER:_isendstate(Current)

- +

Is end state.

TASK_A2A_DISPATCHER:_submap(subs, sub, name)

- +

Sub maps.

TASK_A2A_DISPATCHER:can(e)

- +

Check if can do an event.

TASK_A2A_DISPATCHER:cannot(e)

- +

Check if cannot do an event.

TASK_A2A_DISPATCHER.current

- +

Current state name.

@@ -2045,21 +2084,21 @@ So, this method will be called only ONCE when a player joins a -

TASK_A2A_DISPATCHER:is(state)

+

TASK_A2A_DISPATCHER:is(State, If, state)

- +

Check if FSM is in state.

TASK_A2A_DISPATCHER.options

- +

Options.

TASK_A2A_DISPATCHER.subs

- +

Subs.

@@ -4456,11 +4495,14 @@ If too large, any airborne cap may not be able to reach the detected target area

+ #string State

-

+ +

The FSM state.

+
@@ -4785,7 +4827,7 @@ If too large, any airborne cap may not be able to reach the detected target area

TASK_A2A_DISPATCHER:GetCurrentState()

- +

Get current state.

@@ -4793,6 +4835,17 @@ If too large, any airborne cap may not be able to reach the detected target area +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -4812,6 +4865,17 @@ If too large, any airborne cap may not be able to reach the detected target area +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -4878,7 +4942,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- +

Sub processes.

@@ -4890,7 +4954,7 @@ If too large, any airborne cap may not be able to reach the detected target area

Returns a table with the scores defined.

@@ -4901,6 +4965,18 @@ If too large, any airborne cap may not be able to reach the detected target area +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -4942,7 +5018,7 @@ If too large, any airborne cap may not be able to reach the detected target area

TASK_A2A_DISPATCHER:GetState()

- +

Get current state.

@@ -4950,6 +5026,17 @@ If too large, any airborne cap may not be able to reach the detected target area +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -4969,6 +5056,17 @@ If too large, any airborne cap may not be able to reach the detected target area +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -4995,7 +5093,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- +

Transitions.

@@ -5007,10 +5105,10 @@ If too large, any airborne cap may not be able to reach the detected target area
- +

Check if FSM is in state.

@@ -5018,15 +5116,31 @@ If too large, any airborne cap may not be able to reach the detected target area -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -5040,7 +5154,7 @@ If too large, any airborne cap may not be able to reach the detected target area

TASK_A2A_DISPATCHER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -5052,11 +5166,14 @@ If too large, any airborne cap may not be able to reach the detected target area

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -5183,7 +5300,7 @@ If too large, any airborne cap may not be able to reach the detected target area

TASK_A2A_DISPATCHER:_add_to_map(Map, Event)

- +

Add to map.

@@ -5195,21 +5312,27 @@ If too large, any airborne cap may not be able to reach the detected target area

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -5223,7 +5346,7 @@ If too large, any airborne cap may not be able to reach the detected target area

TASK_A2A_DISPATCHER:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -5235,43 +5358,65 @@ If too large, any airborne cap may not be able to reach the detected target area

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -5283,7 +5428,7 @@ If too large, any airborne cap may not be able to reach the detected target area

TASK_A2A_DISPATCHER:_create_transition(EventName)

- +

Create transition.

@@ -5295,13 +5440,27 @@ If too large, any airborne cap may not be able to reach the detected target area

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -5313,7 +5472,7 @@ If too large, any airborne cap may not be able to reach the detected target area

TASK_A2A_DISPATCHER:_delayed_transition(EventName)

- +

Delayed transition.

@@ -5325,13 +5484,27 @@ If too large, any airborne cap may not be able to reach the detected target area

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -5343,7 +5516,7 @@ If too large, any airborne cap may not be able to reach the detected target area

TASK_A2A_DISPATCHER:_eventmap(Events, EventStructure)

- +

Event map.

@@ -5355,21 +5528,27 @@ If too large, any airborne cap may not be able to reach the detected target area

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -5383,7 +5562,7 @@ If too large, any airborne cap may not be able to reach the detected target area

TASK_A2A_DISPATCHER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -5395,23 +5574,40 @@ If too large, any airborne cap may not be able to reach the detected target area

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -5423,7 +5619,7 @@ If too large, any airborne cap may not be able to reach the detected target area

TASK_A2A_DISPATCHER:_handler(EventName, ...)

- +

Handler.

@@ -5435,11 +5631,14 @@ If too large, any airborne cap may not be able to reach the detected target area

+ #string EventName

-

+ +

Event name.

+
@@ -5449,7 +5648,9 @@ If too large, any airborne cap may not be able to reach the detected target area

-

+ +

Arguments.

+
@@ -5463,7 +5664,7 @@ If too large, any airborne cap may not be able to reach the detected target area

TASK_A2A_DISPATCHER:_isendstate(Current)

- +

Is end state.

@@ -5475,13 +5676,35 @@ If too large, any airborne cap may not be able to reach the detected target area

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -5493,7 +5716,7 @@ If too large, any airborne cap may not be able to reach the detected target area

TASK_A2A_DISPATCHER:_submap(subs, sub, name)

- +

Sub maps.

@@ -5505,31 +5728,40 @@ If too large, any airborne cap may not be able to reach the detected target area

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -5543,7 +5775,7 @@ If too large, any airborne cap may not be able to reach the detected target area

TASK_A2A_DISPATCHER:can(e)

- +

Check if can do an event.

@@ -5555,13 +5787,35 @@ If too large, any airborne cap may not be able to reach the detected target area

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -5573,7 +5827,7 @@ If too large, any airborne cap may not be able to reach the detected target area

TASK_A2A_DISPATCHER:cannot(e)

- +

Check if cannot do an event.

@@ -5585,13 +5839,27 @@ If too large, any airborne cap may not be able to reach the detected target area

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -5600,10 +5868,10 @@ If too large, any airborne cap may not be able to reach the detected target area
- +

Check if FSM is in state.

@@ -5611,7 +5879,33 @@ If too large, any airborne cap may not be able to reach the detected target area -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Tasking.Task_A2G.html b/Documentation/Tasking.Task_A2G.html index 98ad0becd..97781b360 100644 --- a/Documentation/Tasking.Task_A2G.html +++ b/Documentation/Tasking.Task_A2G.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Tasking.Task_A2G_Dispatcher.html b/Documentation/Tasking.Task_A2G_Dispatcher.html index 773d9fcb0..25389e043 100644 --- a/Documentation/Tasking.Task_A2G_Dispatcher.html +++ b/Documentation/Tasking.Task_A2G_Dispatcher.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2101,7 +2134,13 @@ TaskDispatcher = TASK_A2G_DISPATCHER

TASK_A2G_DISPATCHER.CallScheduler

- +

Call scheduler.

+ + + +

TASK_A2G_DISPATCHER.ClassName

+ +

Name of the class.

@@ -2113,7 +2152,7 @@ TaskDispatcher = TASK_A2G_DISPATCHER

TASK_A2G_DISPATCHER:GetCurrentState()

- +

Get current state.

@@ -2135,7 +2174,7 @@ TaskDispatcher = TASK_A2G_DISPATCHER -

TASK_A2G_DISPATCHER:GetScores()

+

TASK_A2G_DISPATCHER:GetScores(Scores)

Returns a table with the scores defined.

@@ -2149,7 +2188,7 @@ TaskDispatcher = TASK_A2G_DISPATCHER

TASK_A2G_DISPATCHER:GetState()

- +

Get current state.

@@ -2165,15 +2204,15 @@ TaskDispatcher = TASK_A2G_DISPATCHER -

TASK_A2G_DISPATCHER:Is(State)

+

TASK_A2G_DISPATCHER:Is(State, If)

- +

Check if FSM is in state.

TASK_A2G_DISPATCHER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2185,7 +2224,7 @@ TaskDispatcher = TASK_A2G_DISPATCHER

TASK_A2G_DISPATCHER.Scores

- +

Scores.

@@ -2239,73 +2278,73 @@ TaskDispatcher = TASK_A2G_DISPATCHER

TASK_A2G_DISPATCHER:_add_to_map(Map, Event)

- +

Add to map.

TASK_A2G_DISPATCHER:_call_handler(step, trigger, params, EventName)

- +

Call handler.

TASK_A2G_DISPATCHER:_create_transition(EventName)

- +

Create transition.

TASK_A2G_DISPATCHER:_delayed_transition(EventName)

- +

Delayed transition.

TASK_A2G_DISPATCHER:_eventmap(Events, EventStructure)

- +

Event map.

TASK_A2G_DISPATCHER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

TASK_A2G_DISPATCHER:_handler(EventName, ...)

- +

Handler.

TASK_A2G_DISPATCHER:_isendstate(Current)

- +

Is end state.

TASK_A2G_DISPATCHER:_submap(subs, sub, name)

- +

Sub maps.

TASK_A2G_DISPATCHER:can(e)

- +

Check if can do an event.

TASK_A2G_DISPATCHER:cannot(e)

- +

Check if cannot do an event.

TASK_A2G_DISPATCHER.current

- +

Current state name.

@@ -2315,21 +2354,21 @@ TaskDispatcher = TASK_A2G_DISPATCHER -

TASK_A2G_DISPATCHER:is(state)

+

TASK_A2G_DISPATCHER:is(State, If, state)

- +

Check if FSM is in state.

TASK_A2G_DISPATCHER.options

- +

Options.

TASK_A2G_DISPATCHER.subs

- +

Subs.

@@ -4600,11 +4639,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string State

-

+ +

The FSM state.

+
@@ -4929,7 +4971,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_A2G_DISPATCHER:GetCurrentState()

- +

Get current state.

@@ -4937,6 +4979,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -4956,6 +5009,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -5022,7 +5086,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Sub processes.

@@ -5034,7 +5098,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Returns a table with the scores defined.

@@ -5045,6 +5109,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -5086,7 +5162,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_A2G_DISPATCHER:GetState()

- +

Get current state.

@@ -5094,6 +5170,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -5113,6 +5200,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -5139,7 +5237,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Transitions.

@@ -5151,10 +5249,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

@@ -5162,15 +5260,31 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -5184,7 +5298,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_A2G_DISPATCHER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -5196,11 +5310,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -5327,7 +5444,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_A2G_DISPATCHER:_add_to_map(Map, Event)

- +

Add to map.

@@ -5339,21 +5456,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -5367,7 +5490,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_A2G_DISPATCHER:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -5379,43 +5502,65 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -5427,7 +5572,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_A2G_DISPATCHER:_create_transition(EventName)

- +

Create transition.

@@ -5439,13 +5584,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -5457,7 +5616,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_A2G_DISPATCHER:_delayed_transition(EventName)

- +

Delayed transition.

@@ -5469,13 +5628,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -5487,7 +5660,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_A2G_DISPATCHER:_eventmap(Events, EventStructure)

- +

Event map.

@@ -5499,21 +5672,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -5527,7 +5706,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_A2G_DISPATCHER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -5539,23 +5718,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -5567,7 +5763,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_A2G_DISPATCHER:_handler(EventName, ...)

- +

Handler.

@@ -5579,11 +5775,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
@@ -5593,7 +5792,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

-

+ +

Arguments.

+
@@ -5607,7 +5808,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_A2G_DISPATCHER:_isendstate(Current)

- +

Is end state.

@@ -5619,13 +5820,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -5637,7 +5860,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_A2G_DISPATCHER:_submap(subs, sub, name)

- +

Sub maps.

@@ -5649,31 +5872,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -5687,7 +5919,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_A2G_DISPATCHER:can(e)

- +

Check if can do an event.

@@ -5699,13 +5931,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -5717,7 +5971,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_A2G_DISPATCHER:cannot(e)

- +

Check if cannot do an event.

@@ -5729,13 +5983,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -5744,10 +6012,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

@@ -5755,7 +6023,33 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index e9a93f4b1..1290b1164 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Tasking.Task_Cargo_CSAR.html b/Documentation/Tasking.Task_Cargo_CSAR.html index acd21e040..6437dd521 100644 --- a/Documentation/Tasking.Task_Cargo_CSAR.html +++ b/Documentation/Tasking.Task_Cargo_CSAR.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index e8759a489..bf3d8e2f0 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -2106,7 +2139,13 @@ You can use this event handler to post messages to players, or provide status up

TASK_CARGO_DISPATCHER.CallScheduler

- +

Call scheduler.

+ + + +

TASK_CARGO_DISPATCHER.ClassName

+ +

Name of the class.

@@ -2118,7 +2157,7 @@ You can use this event handler to post messages to players, or provide status up

TASK_CARGO_DISPATCHER:GetCurrentState()

- +

Get current state.

@@ -2140,7 +2179,7 @@ You can use this event handler to post messages to players, or provide status up -

TASK_CARGO_DISPATCHER:GetScores()

+

TASK_CARGO_DISPATCHER:GetScores(Scores)

Returns a table with the scores defined.

@@ -2154,7 +2193,7 @@ You can use this event handler to post messages to players, or provide status up

TASK_CARGO_DISPATCHER:GetState()

- +

Get current state.

@@ -2170,15 +2209,15 @@ You can use this event handler to post messages to players, or provide status up -

TASK_CARGO_DISPATCHER:Is(State)

+

TASK_CARGO_DISPATCHER:Is(State, If)

- +

Check if FSM is in state.

TASK_CARGO_DISPATCHER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -2190,7 +2229,7 @@ You can use this event handler to post messages to players, or provide status up

TASK_CARGO_DISPATCHER.Scores

- +

Scores.

@@ -2244,73 +2283,73 @@ You can use this event handler to post messages to players, or provide status up

TASK_CARGO_DISPATCHER:_add_to_map(Map, Event)

- +

Add to map.

TASK_CARGO_DISPATCHER:_call_handler(step, trigger, params, EventName)

- +

Call handler.

TASK_CARGO_DISPATCHER:_create_transition(EventName)

- +

Create transition.

TASK_CARGO_DISPATCHER:_delayed_transition(EventName)

- +

Delayed transition.

TASK_CARGO_DISPATCHER:_eventmap(Events, EventStructure)

- +

Event map.

TASK_CARGO_DISPATCHER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

TASK_CARGO_DISPATCHER:_handler(EventName, ...)

- +

Handler.

TASK_CARGO_DISPATCHER:_isendstate(Current)

- +

Is end state.

TASK_CARGO_DISPATCHER:_submap(subs, sub, name)

- +

Sub maps.

TASK_CARGO_DISPATCHER:can(e)

- +

Check if can do an event.

TASK_CARGO_DISPATCHER:cannot(e)

- +

Check if cannot do an event.

TASK_CARGO_DISPATCHER.current

- +

Current state name.

@@ -2320,21 +2359,21 @@ You can use this event handler to post messages to players, or provide status up -

TASK_CARGO_DISPATCHER:is(state)

+

TASK_CARGO_DISPATCHER:is(State, If, state)

- +

Check if FSM is in state.

TASK_CARGO_DISPATCHER.options

- +

Options.

TASK_CARGO_DISPATCHER.subs

- +

Subs.

@@ -2867,6 +2906,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

+
+ + +
+
+ + +
+
+ + +
+
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
@@ -3946,6 +4029,50 @@ This method can only be used once!

Field(s)

+
+ + +
+
+ + +
+
+ + +
+
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
@@ -4804,6 +4931,50 @@ This method can only be used once!

Field(s)

+ + + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
@@ -4869,11 +5040,14 @@ This method can only be used once!

+ #string State

-

+ +

The FSM state.

+
@@ -5198,7 +5372,7 @@ This method can only be used once!

TASK_CARGO_DISPATCHER:GetCurrentState()

- +

Get current state.

@@ -5206,6 +5380,17 @@ This method can only be used once!

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -5225,6 +5410,17 @@ This method can only be used once!

+

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -5291,7 +5487,7 @@ This method can only be used once!

- +

Sub processes.

@@ -5303,7 +5499,7 @@ This method can only be used once!

Returns a table with the scores defined.

@@ -5314,6 +5510,18 @@ This method can only be used once!

+

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -5355,7 +5563,7 @@ This method can only be used once!

TASK_CARGO_DISPATCHER:GetState()

- +

Get current state.

@@ -5363,6 +5571,17 @@ This method can only be used once!

+

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -5382,6 +5601,17 @@ This method can only be used once!

+

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -5408,7 +5638,7 @@ This method can only be used once!

- +

Transitions.

@@ -5420,10 +5650,10 @@ This method can only be used once!

- +

Check if FSM is in state.

@@ -5431,15 +5661,31 @@ This method can only be used once!

-

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -5453,7 +5699,7 @@ This method can only be used once!

TASK_CARGO_DISPATCHER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -5465,11 +5711,14 @@ This method can only be used once!

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -5596,7 +5845,7 @@ This method can only be used once!

TASK_CARGO_DISPATCHER:_add_to_map(Map, Event)

- +

Add to map.

@@ -5608,21 +5857,27 @@ This method can only be used once!

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -5636,7 +5891,7 @@ This method can only be used once!

TASK_CARGO_DISPATCHER:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -5648,43 +5903,65 @@ This method can only be used once!

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -5696,7 +5973,7 @@ This method can only be used once!

TASK_CARGO_DISPATCHER:_create_transition(EventName)

- +

Create transition.

@@ -5708,13 +5985,27 @@ This method can only be used once!

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -5726,7 +6017,7 @@ This method can only be used once!

TASK_CARGO_DISPATCHER:_delayed_transition(EventName)

- +

Delayed transition.

@@ -5738,13 +6029,27 @@ This method can only be used once!

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -5756,7 +6061,7 @@ This method can only be used once!

TASK_CARGO_DISPATCHER:_eventmap(Events, EventStructure)

- +

Event map.

@@ -5768,21 +6073,27 @@ This method can only be used once!

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -5796,7 +6107,7 @@ This method can only be used once!

TASK_CARGO_DISPATCHER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -5808,23 +6119,40 @@ This method can only be used once!

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -5836,7 +6164,7 @@ This method can only be used once!

TASK_CARGO_DISPATCHER:_handler(EventName, ...)

- +

Handler.

@@ -5848,11 +6176,14 @@ This method can only be used once!

+ #string EventName

-

+ +

Event name.

+
@@ -5862,7 +6193,9 @@ This method can only be used once!

-

+ +

Arguments.

+
@@ -5876,7 +6209,7 @@ This method can only be used once!

TASK_CARGO_DISPATCHER:_isendstate(Current)

- +

Is end state.

@@ -5888,13 +6221,35 @@ This method can only be used once!

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -5906,7 +6261,7 @@ This method can only be used once!

TASK_CARGO_DISPATCHER:_submap(subs, sub, name)

- +

Sub maps.

@@ -5918,31 +6273,40 @@ This method can only be used once!

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -5956,7 +6320,7 @@ This method can only be used once!

TASK_CARGO_DISPATCHER:can(e)

- +

Check if can do an event.

@@ -5968,13 +6332,35 @@ This method can only be used once!

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -5986,7 +6372,7 @@ This method can only be used once!

TASK_CARGO_DISPATCHER:cannot(e)

- +

Check if cannot do an event.

@@ -5998,13 +6384,27 @@ This method can only be used once!

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -6013,10 +6413,10 @@ This method can only be used once!

- +

Check if FSM is in state.

@@ -6024,7 +6424,33 @@ This method can only be used once!

-

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

@@ -6043,6 +6469,50 @@ This method can only be used once!

Field(s)

+ + + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
diff --git a/Documentation/Tasking.Task_Cargo_Transport.html b/Documentation/Tasking.Task_Cargo_Transport.html index 579003c8b..1b1bdae6b 100644 --- a/Documentation/Tasking.Task_Cargo_Transport.html +++ b/Documentation/Tasking.Task_Cargo_Transport.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+
+
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

diff --git a/Documentation/Tasking.Task_Manager.html b/Documentation/Tasking.Task_Manager.html index fa70ca54b..8cd6f2741 100644 --- a/Documentation/Tasking.Task_Manager.html +++ b/Documentation/Tasking.Task_Manager.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1546,7 +1579,13 @@ If an ad-hoc report is requested, use the method

TASK_MANAGER.CallScheduler

- +

Call scheduler.

+ + + +

TASK_MANAGER.ClassName

+ +

Name of the class.

@@ -1558,7 +1597,7 @@ If an ad-hoc report is requested, use the method

TASK_MANAGER:GetCurrentState()

- +

Get current state.

@@ -1580,7 +1619,7 @@ If an ad-hoc report is requested, use the method -

TASK_MANAGER:GetScores()

+

TASK_MANAGER:GetScores(Scores)

Returns a table with the scores defined.

@@ -1594,7 +1633,7 @@ If an ad-hoc report is requested, use the method

TASK_MANAGER:GetState()

- +

Get current state.

@@ -1610,15 +1649,15 @@ If an ad-hoc report is requested, use the method -

TASK_MANAGER:Is(State)

+

TASK_MANAGER:Is(State, If)

- +

Check if FSM is in state.

TASK_MANAGER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1630,7 +1669,7 @@ If an ad-hoc report is requested, use the method

TASK_MANAGER.Scores

- +

Scores.

@@ -1684,73 +1723,73 @@ If an ad-hoc report is requested, use the method

TASK_MANAGER:_add_to_map(Map, Event)

- +

Add to map.

TASK_MANAGER:_call_handler(step, trigger, params, EventName)

- +

Call handler.

TASK_MANAGER:_create_transition(EventName)

- +

Create transition.

TASK_MANAGER:_delayed_transition(EventName)

- +

Delayed transition.

TASK_MANAGER:_eventmap(Events, EventStructure)

- +

Event map.

TASK_MANAGER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

TASK_MANAGER:_handler(EventName, ...)

- +

Handler.

TASK_MANAGER:_isendstate(Current)

- +

Is end state.

TASK_MANAGER:_submap(subs, sub, name)

- +

Sub maps.

TASK_MANAGER:can(e)

- +

Check if can do an event.

TASK_MANAGER:cannot(e)

- +

Check if cannot do an event.

TASK_MANAGER.current

- +

Current state name.

@@ -1760,21 +1799,21 @@ If an ad-hoc report is requested, use the method -

TASK_MANAGER:is(state)

+

TASK_MANAGER:is(State, If, state)

- +

Check if FSM is in state.

TASK_MANAGER.options

- +

Options.

TASK_MANAGER.subs

- +

Subs.

@@ -3183,11 +3222,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string State

-

+ +

The FSM state.

+
@@ -3512,7 +3554,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_MANAGER:GetCurrentState()

- +

Get current state.

@@ -3520,6 +3562,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -3539,6 +3592,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -3605,7 +3669,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Sub processes.

@@ -3617,7 +3681,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Returns a table with the scores defined.

@@ -3628,6 +3692,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -3669,7 +3745,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_MANAGER:GetState()

- +

Get current state.

@@ -3677,6 +3753,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -3696,6 +3783,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -3722,7 +3820,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Transitions.

@@ -3734,10 +3832,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

@@ -3745,15 +3843,31 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -3767,7 +3881,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_MANAGER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -3779,11 +3893,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -3910,7 +4027,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_MANAGER:_add_to_map(Map, Event)

- +

Add to map.

@@ -3922,21 +4039,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -3950,7 +4073,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_MANAGER:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -3962,43 +4085,65 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -4010,7 +4155,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_MANAGER:_create_transition(EventName)

- +

Create transition.

@@ -4022,13 +4167,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -4040,7 +4199,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_MANAGER:_delayed_transition(EventName)

- +

Delayed transition.

@@ -4052,13 +4211,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -4070,7 +4243,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_MANAGER:_eventmap(Events, EventStructure)

- +

Event map.

@@ -4082,21 +4255,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -4110,7 +4289,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_MANAGER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -4122,23 +4301,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -4150,7 +4346,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_MANAGER:_handler(EventName, ...)

- +

Handler.

@@ -4162,11 +4358,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string EventName

-

+ +

Event name.

+
@@ -4176,7 +4375,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

-

+ +

Arguments.

+
@@ -4190,7 +4391,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_MANAGER:_isendstate(Current)

- +

Is end state.

@@ -4202,13 +4403,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -4220,7 +4443,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_MANAGER:_submap(subs, sub, name)

- +

Sub maps.

@@ -4232,31 +4455,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -4270,7 +4502,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_MANAGER:can(e)

- +

Check if can do an event.

@@ -4282,13 +4514,35 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -4300,7 +4554,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

TASK_MANAGER:cannot(e)

- +

Check if cannot do an event.

@@ -4312,13 +4566,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -4327,10 +4595,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- +

Check if FSM is in state.

@@ -4338,7 +4606,33 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Tasking.Task_Zone_Capture_Dispatcher.html b/Documentation/Tasking.Task_Zone_Capture_Dispatcher.html index 3eab54462..e6f6a324b 100644 --- a/Documentation/Tasking.Task_Zone_Capture_Dispatcher.html +++ b/Documentation/Tasking.Task_Zone_Capture_Dispatcher.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1777,7 +1810,13 @@ and setup a new capture zone task and assign it to a group of players, while you

TASK_CAPTURE_DISPATCHER.CallScheduler

- +

Call scheduler.

+ + + +

TASK_CAPTURE_DISPATCHER.ClassName

+ +

Name of the class.

@@ -1789,7 +1828,7 @@ and setup a new capture zone task and assign it to a group of players, while you

TASK_CAPTURE_DISPATCHER:GetCurrentState()

- +

Get current state.

@@ -1811,7 +1850,7 @@ and setup a new capture zone task and assign it to a group of players, while you -

TASK_CAPTURE_DISPATCHER:GetScores()

+

TASK_CAPTURE_DISPATCHER:GetScores(Scores)

Returns a table with the scores defined.

@@ -1825,7 +1864,7 @@ and setup a new capture zone task and assign it to a group of players, while you

TASK_CAPTURE_DISPATCHER:GetState()

- +

Get current state.

@@ -1841,15 +1880,15 @@ and setup a new capture zone task and assign it to a group of players, while you -

TASK_CAPTURE_DISPATCHER:Is(State)

+

TASK_CAPTURE_DISPATCHER:Is(State, If)

- +

Check if FSM is in state.

TASK_CAPTURE_DISPATCHER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -1861,7 +1900,7 @@ and setup a new capture zone task and assign it to a group of players, while you

TASK_CAPTURE_DISPATCHER.Scores

- +

Scores.

@@ -1915,73 +1954,73 @@ and setup a new capture zone task and assign it to a group of players, while you

TASK_CAPTURE_DISPATCHER:_add_to_map(Map, Event)

- +

Add to map.

TASK_CAPTURE_DISPATCHER:_call_handler(step, trigger, params, EventName)

- +

Call handler.

TASK_CAPTURE_DISPATCHER:_create_transition(EventName)

- +

Create transition.

TASK_CAPTURE_DISPATCHER:_delayed_transition(EventName)

- +

Delayed transition.

TASK_CAPTURE_DISPATCHER:_eventmap(Events, EventStructure)

- +

Event map.

TASK_CAPTURE_DISPATCHER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

TASK_CAPTURE_DISPATCHER:_handler(EventName, ...)

- +

Handler.

TASK_CAPTURE_DISPATCHER:_isendstate(Current)

- +

Is end state.

TASK_CAPTURE_DISPATCHER:_submap(subs, sub, name)

- +

Sub maps.

TASK_CAPTURE_DISPATCHER:can(e)

- +

Check if can do an event.

TASK_CAPTURE_DISPATCHER:cannot(e)

- +

Check if cannot do an event.

TASK_CAPTURE_DISPATCHER.current

- +

Current state name.

@@ -1991,21 +2030,21 @@ and setup a new capture zone task and assign it to a group of players, while you -

TASK_CAPTURE_DISPATCHER:is(state)

+

TASK_CAPTURE_DISPATCHER:is(State, If, state)

- +

Check if FSM is in state.

TASK_CAPTURE_DISPATCHER.options

- +

Options.

TASK_CAPTURE_DISPATCHER.subs

- +

Subs.

@@ -3852,11 +3891,14 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

+ #string State

-

+ +

The FSM state.

+
@@ -4181,7 +4223,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

TASK_CAPTURE_DISPATCHER:GetCurrentState()

- +

Get current state.

@@ -4189,6 +4231,17 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -4208,6 +4261,17 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref +

Return value:

+
+
+

#table:

+
+
+ +

End states.

+ +
+
@@ -4274,7 +4338,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
- +

Sub processes.

@@ -4286,7 +4350,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

Returns a table with the scores defined.

@@ -4297,6 +4361,18 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref +

Parameter:

+
+
+

+ #table + Scores +

+
+
+

+
+
@@ -4338,7 +4414,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

TASK_CAPTURE_DISPATCHER:GetState()

- +

Get current state.

@@ -4346,6 +4422,17 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref +

Return value:

+
+
+

#string:

+
+
+ +

Current FSM state.

+ +
+
@@ -4365,6 +4452,17 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref +

Return value:

+
+
+

#table:

+
+
+ +

Sub processes.

+ +
+
@@ -4391,7 +4489,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
- +

Transitions.

@@ -4403,10 +4501,10 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
- +

Check if FSM is in state.

@@ -4414,15 +4512,31 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref -

Parameter:

+

Parameters:

+ #string State

-

+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+
@@ -4436,7 +4550,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

TASK_CAPTURE_DISPATCHER:LoadCallBacks(CallBackTable)

- +

Load call backs.

@@ -4448,11 +4562,14 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

+ #table CallBackTable

-

+ +

Table of call backs.

+
@@ -4579,7 +4696,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

TASK_CAPTURE_DISPATCHER:_add_to_map(Map, Event)

- +

Add to map.

@@ -4591,21 +4708,27 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

+ #table Map

-

+ +

Map.

+

+ #table Event

-

+ +

Event table.

+
@@ -4619,7 +4742,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

TASK_CAPTURE_DISPATCHER:_call_handler(step, trigger, params, EventName)

- +

Call handler.

@@ -4631,43 +4754,65 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

+ #string step

-

+ +

Step "onafter", "onbefore", "onenter", "onleave".

+

+ #string trigger

-

+ +

Trigger.

+

+ #table params

-

+ +

Parameters.

+

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+
+
+ +

Value.

+ +
+
@@ -4679,7 +4824,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

TASK_CAPTURE_DISPATCHER:_create_transition(EventName)

- +

Create transition.

@@ -4691,13 +4836,27 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -4709,7 +4868,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

TASK_CAPTURE_DISPATCHER:_delayed_transition(EventName)

- +

Delayed transition.

@@ -4721,13 +4880,27 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

+ #string EventName

-

+ +

Event name.

+
+

Return value:

+
+
+

#function:

+
+
+ +

Function.

+ +
+
@@ -4739,7 +4912,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

TASK_CAPTURE_DISPATCHER:_eventmap(Events, EventStructure)

- +

Event map.

@@ -4751,21 +4924,27 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

+ #table Events

-

+ +

Events.

+

+ #table EventStructure

-

+ +

Event structure.

+
@@ -4779,7 +4958,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

TASK_CAPTURE_DISPATCHER:_gosub(ParentFrom, ParentEvent)

- +

Go sub.

@@ -4791,23 +4970,40 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

+ #string ParentFrom

-

+ +

Parent from state.

+

+ #string ParentEvent

-

+ +

Parent event name.

+
+

Return value:

+
+
+

#table:

+
+
+ +

Subs.

+ +
+
@@ -4819,7 +5015,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

TASK_CAPTURE_DISPATCHER:_handler(EventName, ...)

- +

Handler.

@@ -4831,11 +5027,14 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

+ #string EventName

-

+ +

Event name.

+
@@ -4845,7 +5044,9 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

-

+ +

Arguments.

+
@@ -4859,7 +5060,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

TASK_CAPTURE_DISPATCHER:_isendstate(Current)

- +

Is end state.

@@ -4871,13 +5072,35 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

+ #string Current

-

+ +

Current state name.

+
+

Return values:

+
+
+

#table:

+
+
+ +

FSM parent.

+ +
+
+

#string:

+
+
+ +

Event name.

+ +
+
@@ -4889,7 +5112,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

TASK_CAPTURE_DISPATCHER:_submap(subs, sub, name)

- +

Sub maps.

@@ -4901,31 +5124,40 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

+ #table subs

-

+ +

Subs.

+

+ #table sub

-

+ +

Sub.

+

+ #string name

-

+ +

Name.

+
@@ -4939,7 +5171,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

TASK_CAPTURE_DISPATCHER:can(e)

- +

Check if can do an event.

@@ -4951,13 +5183,35 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

+ #string e

-

+ +

Event name.

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

If true, FSM can do the event.

+ +
+
+

#string:

+
+
+ +

To state.

+ +
+
@@ -4969,7 +5223,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

TASK_CAPTURE_DISPATCHER:cannot(e)

- +

Check if cannot do an event.

@@ -4981,13 +5235,27 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref

+ #string e

-

+ +

Event name.

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, FSM cannot do the event.

+ +
+
@@ -4996,10 +5264,10 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
- +

Check if FSM is in state.

@@ -5007,7 +5275,33 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref -

Parameter:

+

Parameters:

+
+
+

+ #string + State +

+
+
+ +

State name.

+ +
+
+
+
+

+ #boolean + If +

+
+
+ +

true, FSM is in this state.

+ +
+

diff --git a/Documentation/Utilities.PROFILER.html b/Documentation/Utilities.PROFILER.html new file mode 100644 index 000000000..e914ee45a --- /dev/null +++ b/Documentation/Utilities.PROFILER.html @@ -0,0 +1,2328 @@ + + + + + + + + + + + + + + + +

+

+ +

+
+
+ + +Banner Image +
+
+

Module Utilities.PROFILER

+
+
+ +

Utils - Lua Profiler.

+ + + +

Find out how many times functions are called and how much real time it costs.

+ +
+ +

Author: TAW CougarNL, funkyfranky

+ + +
+

Global(s)

+
+ + + + + +

Global PROFILER

+

*The emperor counsels simplicity.

+
+
+
+
+ + #PROFILER +PROFILER + +

*The emperor counsels simplicity.

+ + +

First principles. Of each particular thing, ask: What is it in itself, in its own constitution? What is its causal nature? *

+ +
+ +

Banner Image

+ +

The PROFILER Concept

+ +

Profile your lua code. This tells you, which functions are called very often and which consume most real time. +With this information you can optimize the perfomance of your code.

+ +

Prerequisites

+ +

The modules os and lfs need to be desanizied.

+ + +

Start

+ +

The profiler can simply be started with the PROFILER.Start(Delay, Duration) function

+ +
PROFILER.Start()
+
+ +

The optional parameter Delay can be used to delay the start by a certain amount of seconds and the optional parameter Duration can be used to +stop the profiler after a certain amount of seconds.

+ +

Stop

+ +

The profiler automatically stops when the mission ends. But it can be stopped any time with the PROFILER.Stop(Delay) function

+ +
PROFILER.Stop()
+
+ +

The optional parameter Delay can be used to specify a delay after which the profiler is stopped.

+ +

When the profiler is stopped, the output is written to a file.

+ +

Output

+ +

The profiler output is written to a file in your DCS home folder

+ +
X:\User\<Your User Name>\Saved Games\DCS OpenBeta\Logs
+
+ +

The default file name is "MooseProfiler.txt". If that file exists, the file name is "MooseProfiler-001.txt" etc.

+ +

Data

+ +

The data in the output file provides information on the functions that were called in the mission.

+ +

It will tell you how many times a function was called in total, how many times per second, how much time in total and the percentage of time.

+ +

If you only want output for functions that are called more than X times per second, you can set

+ +
PROFILER.ThreshCPS=1.5
+
+ +

With this setting, only functions which are called more than 1.5 times per second are displayed. The default setting is PROFILER.ThreshCPS=0.0 (no threshold).

+ +

Furthermore, you can limit the output for functions that consumed a certain amount of CPU time in total by

+ +
PROFILER.ThreshTtot=0.005
+
+ +

With this setting, which is also the default, only functions which in total used more than 5 milliseconds CPU time.

+ + +
+ +
+

Type(s)

+ +
+ PROFILER +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from PROFILERDescription

PROFILER.ClassName

+

Name of the class.

+

PROFILER.Counters

+

Function counters.

+

PROFILER.Start(Delay, Duration)

+

Start profiler.

+

PROFILER.Stop(Delay)

+

Stop profiler.

+

PROFILER.ThreshCPS

+

Low calls per second threshold. Only write output if function has more calls per second than this value.

+

PROFILER.ThreshTtot

+

Total time threshold. Only write output if total function CPU time is more than this value.

+

PROFILER.TstartGame

+

Game start time timer.getTime().

+

PROFILER.TstartOS

+

OS real start time os.clock.

+

PROFILER._flog(f, txt)

+

Write text to log file.

+

PROFILER.dInfo

+

Info.

+

PROFILER.eventhandler

+

Event handler to get mission end event.

+

PROFILER.fTime

+

Function time.

+

PROFILER.fTimeTotal

+

Total function time.

+

PROFILER.fileNamePrefix

+

Output file name prefix, e.g. "MooseProfiler".

+

PROFILER.fileNameSuffix

+

Output file name prefix, e.g. "txt"

+

PROFILER.getData(func)

+

Get data.

+

PROFILER.getfilename(ext)

+

Write info to output file.

+

PROFILER.hook(event)

+

Debug hook.

+

PROFILER.logUnknown

+

Log unknown functions. Default is off.

+

PROFILER.printCSV(data, runTimeGame)

+

Print csv file.

+

PROFILER.showInfo(runTimeGame, runTimeOS)

+

Write info to output file.

+

PROFILER.showTable(data, f, runTimeGame)

+

Show table.

+
+
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from PROFILER.DataDescription

PROFILER.Data.count

+

Number of function calls.

+

PROFILER.Data.func

+

The function name.

+

PROFILER.Data.line

+

The line number

+

PROFILER.Data.src

+

The source file.

+

PROFILER.Data.tm

+

Total time in seconds.

+
+
+ + +
+
+
+ +
+ +
+
+ +

PROFILER class.

+ +
+

Field(s)

+
+
+
+ + #string +PROFILER.ClassName + +

Name of the class.

+ +
+ +
+
+
+ + #table +PROFILER.Counters + +

Function counters.

+ +
+ +
+
+
+ + #number +PROFILER.ThreshCPS + +

Low calls per second threshold. Only write output if function has more calls per second than this value.

+ +
+ +
+
+
+ + #number +PROFILER.ThreshTtot + +

Total time threshold. Only write output if total function CPU time is more than this value.

+ +
+ +
+
+
+ + #number +PROFILER.TstartGame + +

Game start time timer.getTime().

+ +
+ +
+
+
+ + #number +PROFILER.TstartOS + +

OS real start time os.clock.

+ +
+ +
+
+
+ + #table +PROFILER.dInfo + +

Info.

+ +
+ +
+
+
+ + #table +PROFILER.eventhandler + +

Event handler to get mission end event.

+ +
+ +
+
+
+ + #table +PROFILER.fTime + +

Function time.

+ +
+ +
+
+
+ + #table +PROFILER.fTimeTotal + +

Total function time.

+ +
+ +
+
+
+ + #string +PROFILER.fileNamePrefix + +

Output file name prefix, e.g. "MooseProfiler".

+ +
+ +
+
+
+ + #string +PROFILER.fileNameSuffix + +

Output file name prefix, e.g. "txt"

+ +
+ +
+
+
+ + #boolean +PROFILER.logUnknown + +

Log unknown functions. Default is off.

+ +
+ +
+
+

Function(s)

+
+
+ + + +

Start profiler.

+ +
+
+

Defined in:

+
+

PROFILER

+
+

Parameters:

+
+
+

+ #number + Delay +

+
+
+ +

Delay in seconds before profiler is stated. Default is immediately.

+ +
+
+
+
+

+ #number + Duration +

+
+
+ +

Duration in (game) seconds before the profiler is stopped. Default is when mission ends.

+ +
+
+
+ +
+
+ +
+ + + +

Stop profiler.

+ +
+
+

Defined in:

+
+

PROFILER

+
+

Parameter:

+
+
+

+ #number + Delay +

+
+
+ +

Delay before stop in seconds.

+ +
+
+
+ +
+
+ +
+ + + +

Write text to log file.

+ +
+
+

Defined in:

+
+

PROFILER

+
+

Parameters:

+
+
+

+ #function + f +

+
+
+ +

The file.

+ +
+
+
+
+

+ #string + txt +

+
+
+ +

The text.

+ +
+
+
+ +
+
+ +
+ + + +

Get data.

+ +
+
+

Defined in:

+
+

PROFILER

+
+

Parameter:

+
+
+

+ #function + func +

+
+
+ +

Function.

+ +
+
+

Return values:

+
+
+

#string:

+
+
+ +

Function name.

+ +
+
+

#string:

+
+
+ +

Source file name.

+ +
+
+

#string:

+
+
+ +

Line number.

+ +
+
+

#number:

+
+
+ +

Function time in seconds.

+ +
+
+
+ +
+
+ +
+ + + +

Write info to output file.

+ +
+
+

Defined in:

+
+

PROFILER

+
+

Parameter:

+
+
+

+ #string + ext +

+
+
+ +

Extension.

+ +
+
+

Return value:

+
+
+

#string:

+
+
+ +

File name.

+ +
+
+
+ +
+
+ +
+ + + +

Debug hook.

+ +
+
+

Defined in:

+
+

PROFILER

+
+

Parameter:

+
+
+

+ #table + event +

+
+
+ +

Event.

+ +
+
+
+ +
+
+ +
+ + + +

Print csv file.

+ +
+
+

Defined in:

+
+

PROFILER

+
+

Parameters:

+
+
+

+ #table + data +

+
+
+ +

Data table.

+ +
+
+
+
+

+ #number + runTimeGame +

+
+
+ +

Game run time in seconds.

+ +
+
+
+ +
+
+ +
+ + + +

Write info to output file.

+ +
+
+

Defined in:

+
+

PROFILER

+
+

Parameters:

+
+
+

+ #number + runTimeGame +

+
+
+ +

Game time in seconds.

+ +
+
+
+
+

+ #number + runTimeOS +

+
+
+ +

OS time in seconds.

+ +
+
+
+ +
+
+ +
+ + + +

Show table.

+ +
+
+

Defined in:

+
+

PROFILER

+
+

Parameters:

+
+
+

+ #table + data +

+
+
+ +

Data table.

+ +
+
+
+
+

+ #function + f +

+
+
+ +

The file.

+ +
+
+
+
+

+ #number + runTimeGame +

+
+
+ +

Game run time in seconds.

+ +
+
+
+ +
+
+ +
+ +
+ +
+
+ +

Waypoint data.

+ +
+

Field(s)

+
+
+
+ + #number +PROFILER.Data.count + +

Number of function calls.

+ +
+ +
+
+
+ + #string +PROFILER.Data.func + +

The function name.

+ +
+ +
+
+
+ + #number +PROFILER.Data.line + +

The line number

+ +
+ +
+
+
+ + #string +PROFILER.Data.src + +

The source file.

+ +
+ +
+
+
+ + #number +PROFILER.Data.tm + +

Total time in seconds.

+ +
+ +
+
+

Function(s)

+
+
+ +
+
+ + +
+ + + + diff --git a/Documentation/Utils.html b/Documentation/Utils.html index 96ebed80f..084a6f79b 100644 --- a/Documentation/Utils.html +++ b/Documentation/Utils.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+
+
+
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+
+ +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1852,6 +1885,12 @@

UTILS.GetModulationName(Modulation)

Get the modulation name from its numerical value.

+ + + +

UTILS.GetOSTime()

+ +

Get OS time.

@@ -1968,7 +2007,7 @@ -

UTILS.MpsToKnots(knots, mps)

+

UTILS.MpsToKnots(mps)

Convert meters per second to knots.

@@ -2104,6 +2143,12 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte

UTILS.VecSubstract(a, b)

Calculate the difference between two 3D vectors by substracting the x,y,z components from each other.

+ + + +

UTILS.VecTranslate(a, distance, angle)

+ +

Translate 3D vector in the 2D (x,z) plane.

@@ -3402,6 +3447,39 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte + + + +
+ + + +

Get OS time.

+ + +

Needs os to be desanitized!

+ +
+
+

Defined in:

+
+

UTILS

+
+

Return value:

+
+
+

#number:

+
+
+ +

Os time in seconds.

+ +
+
+
+
@@ -4270,7 +4348,7 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte

Convert meters per second to knots.

@@ -4281,12 +4359,12 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte

UTILS

-

Parameters:

+

Parameter:

#number - knots + mps

@@ -4295,16 +4373,6 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
-
-
-

- mps -

-
-
-

-
-

Return value:

@@ -5441,6 +5509,79 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
+
+ + +
+ + + +

Translate 3D vector in the 2D (x,z) plane.

+ + +

y-component (usually altitude) unchanged.

+ +
+
+

Defined in:

+
+

UTILS

+
+

Parameters:

+
+
+

+ DCS#Vec3 + a +

+
+
+ +

Vector in 3D with x, y, z components.

+ +
+
+
+
+

+ #number + distance +

+
+
+ +

The distance to translate.

+ +
+
+
+
+

+ #number + angle +

+
+
+ +

Rotation angle in degrees.

+ +
+
+

Return value:

+
+
+

DCS#Vec3:

+
+
+ +

Vector rotated in the (x,z) plane.

+ +
+
+
+
diff --git a/Documentation/Wrapper.Airbase.html b/Documentation/Wrapper.Airbase.html index 9836c60f9..b6bc19a20 100644 --- a/Documentation/Wrapper.Airbase.html +++ b/Documentation/Wrapper.Airbase.html @@ -664,6 +664,17 @@

Core - Management of spotting logistics, that can be activated and deactivated upon command.

+

+ + +
+
+
+ Image + +
+

+

Core - Timer scheduler.

@@ -1173,6 +1184,17 @@

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

+

+ + +
+
+ +

+

Utils - Lua Profiler.

@@ -1239,6 +1261,17 @@

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

+

+ + +
+
+ +

+

Wrapper - Markers On the F10 map.

@@ -1372,7 +1405,7 @@ This is done at the beginning of the mission (when the mission starts).

The AIRBASE class does not contain a :New() method, rather it provides :Find() methods to retrieve the object reference using the DCS Airbase or the DCS AirbaseName.

-

Another thing to know is that AIRBASE objects do not "contain" the DCS Airbase object. +

Another thing to know is that AIRBASE objects do not "contain" the DCS Airbase object. The AIRBASE methods will reference the DCS Airbase object by name when it is needed during API execution. If the DCS Airbase object does not exist or is nil, the AIRBASE methods will return nil and log an exception in the DCS.log file.

@@ -1414,13 +1447,13 @@ is implemented in the AIRBASE class as AIRBASE.Get

AIRBASE.AirbaseID

- +

Airbase ID.

AIRBASE.AirbaseName

- +

Name of the airbase.

@@ -1487,6 +1520,12 @@ is implemented in the AIRBASE class as AIRBASE.Get

AIRBASE:GetAirbaseCategory()

Get category of airbase.

+ + + +

AIRBASE.GetAllAirbaseNames(coalition, category)

+ +

Get all airbase names of the current map.

@@ -1565,6 +1604,24 @@ is implemented in the AIRBASE class as AIRBASE.Get

AIRBASE:GetZone()

Get the airbase zone.

+ + + +

AIRBASE:IsAirdrome()

+ +

Check if airbase is an airdrome.

+ + + +

AIRBASE:IsHelipad()

+ +

Check if airbase is a helipad.

+ + + +

AIRBASE:IsShip()

+ +

Check if airbase is a ship.

@@ -1637,6 +1694,18 @@ is implemented in the AIRBASE class as AIRBASE.Get
  • AIRBASE.Normandy.Tangmere
  • AIRBASE.Normandy.Ford_AF
  • + + + +

    AIRBASE.NparkingTerminal

    + + + + + +

    AIRBASE.NparkingTotal

    + + @@ -1761,12 +1830,66 @@ is implemented in the AIRBASE class as AIRBASE.Get

    AIRBASE._CheckTerminalType(Term_Type, termtype)

    Helper function to check for the correct terminal type including "artificial" ones.

    + + + +

    AIRBASE:_GetParkingSpotByID(TerminalID)

    + +

    Get a table containing the coordinates, terminal index and terminal type of free parking spots at an airbase.

    + + + +

    AIRBASE:_InitParkingSpots()

    + +

    Get a table containing the coordinates, terminal index and terminal type of free parking spots at an airbase.

    AIRBASE.activerwyno

    Active runway number (forced).

    + + + +

    AIRBASE.category

    + +

    Airbase category.

    + + + +

    AIRBASE.descriptors

    + +

    DCS descriptors.

    + + + +

    AIRBASE.isAirdrome

    + +

    Airbase is an airdrome.

    + + + +

    AIRBASE.isHelipad

    + +

    Airbase is a helipad.

    + + + +

    AIRBASE.isShip

    + +

    Airbase is a ship.

    + + + +

    AIRBASE.parking

    + +

    Parking spot data.

    + + + +

    AIRBASE.parkingByID

    + +

    Parking spot data table with ID as key.

    @@ -1877,12 +2000,24 @@ is implemented in the AIRBASE class as AIRBASE.Get

    AIRBASE:GetClimbAngle()

    Returns the unit's climb or descent angle.

    + + + +

    AIRBASE:GetCoord()

    + +

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    AIRBASE:GetCoordinate()

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    + + + +

    AIRBASE:GetDCSObject()

    + +

    Returns the DCS object.

    @@ -2285,6 +2420,18 @@ is implemented in the AIRBASE class as AIRBASE.Get

    AIRBASE.__

    + + + +

    AIRBASE.coordinate

    + +

    Coordinate object.

    + + + +

    AIRBASE.pointvec3

    + +

    Point Vec3 object.

    @@ -2957,6 +3104,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    AIRBASE.ParkingSpot.TerminalType

    Type of the spot, i.e. for which type of aircraft it can be used.

    + + + +

    AIRBASE.ParkingSpot.Vec3

    + + @@ -3081,10 +3234,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #number AIRBASE.AirbaseID - +

    Airbase ID.

    @@ -3092,10 +3245,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #string AIRBASE.AirbaseName - +

    Name of the airbase.

    @@ -3108,6 +3261,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

    TODO: For ships we need a moving zone.

    +
    @@ -3155,10 +3311,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
  • AIRBASE.Caucasus.Mineralnye_Vody
  • AIRBASE.Caucasus.Nalchik
  • AIRBASE.Caucasus.Mozdok
  • -
  • AIRBASE.Caucasus.Beslan -
  • +
  • AIRBASE.Caucasus.Beslan
  • + @@ -3246,6 +3402,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
  • AIRBASE.Normandy.Ford_AF
  • + + + +
    +
    + + #table +AIRBASE.NparkingTerminal + + + +
    + +
    +
    +
    + + #number +AIRBASE.NparkingTotal + + +
    @@ -3385,6 +3563,83 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +
    +
    + + #number +AIRBASE.category + +

    Airbase category.

    + +
    + +
    +
    +
    + + #table +AIRBASE.descriptors + +

    DCS descriptors.

    + +
    + +
    +
    +
    + + #boolean +AIRBASE.isAirdrome + +

    Airbase is an airdrome.

    + +
    + +
    +
    +
    + + #boolean +AIRBASE.isHelipad + +

    Airbase is a helipad.

    + +
    + +
    +
    +
    + + #boolean +AIRBASE.isShip + +

    Airbase is a ship.

    + +
    + +
    +
    +
    + + #table +AIRBASE.parking + +

    Parking spot data.

    + +
    + +
    +
    +
    + + #table +AIRBASE.parkingByID + +

    Parking spot data table with ID as key.

    + +
    +

    Function(s)

    @@ -3439,7 +3694,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    -

    If true, the group is destroyed.

    +

    If true, the group is destroyed.

    @@ -3710,7 +3965,7 @@ The dimension of the spawned aircraft and of the potential obstacle are taken in
    -

    (Optional) Number of freeparking spots requested. Default is the number of aircraft in the group.

    +

    (Optional) Number of freeparking spots requested. Default is the number of aircraft in the group.

    @@ -3814,6 +4069,66 @@ The dimension of the spawned aircraft and of the potential obstacle are taken in + + + +
    + + + +

    Get all airbase names of the current map.

    + + +

    This includes ships and FARPS.

    + +
    +
    +

    Defined in:

    +
    +

    AIRBASE

    +
    +

    Parameters:

    +
    +
    +

    + DCS#Coalition + coalition +

    +
    +
    + +

    (Optional) Return only airbases belonging to the specified coalition. By default, all airbases of the map are returned.

    + +
    +
    +
    +
    +

    + #number + category +

    +
    +
    + +

    (Optional) Return only airbases of a certain category, e.g. Airbase.Category.FARP

    + +
    +
    +

    Return value:

    +
    +
    +

    #table:

    +
    +
    + +

    Table containing all airbase names of the current map.

    + +
    +
    +
    +
    @@ -4001,7 +4316,7 @@ The dimension of the spawned aircraft and of the potential obstacle are taken in
    -

    If true, spots are considered free even though TO_AC is true. Default is off which is saver to avoid spawning aircraft on top of each other. Option might be enabled for FARPS and ships.

    +

    If true, spots are considered free even though TO_AC is true. Default is off which is saver to avoid spawning aircraft on top of each other. Option might be enabled for FARPS and ships.

    @@ -4058,7 +4373,7 @@ The dimension of the spawned aircraft and of the potential obstacle are taken in
    -

    If true, spots are considered free even though TO_AC is true. Default is off which is saver to avoid spawning aircraft on top of each other. Option might be enabled for FARPS and ships.

    +

    If true, spots are considered free even though TO_AC is true. Default is off which is saver to avoid spawning aircraft on top of each other. Option might be enabled for FARPS and ships.

    @@ -4102,7 +4417,7 @@ The dimension of the spawned aircraft and of the potential obstacle are taken in
    -

    (Optional) If true, ships will get a negative sign as the unit ID might be the same as an airbase ID. Default off!

    +

    (Optional) If true, ships will get a negative sign as the unit ID might be the same as an airbase ID. Default off!

    @@ -4135,7 +4450,7 @@ The dimension of the spawned aircraft and of the potential obstacle are taken in + @@ -4812,6 +5294,28 @@ The dimension of the spawned aircraft and of the potential obstacle are taken in
  • AIRBASE.Normandy.Ford_AF
  • + + + +
    +
    + + #table +AIRBASE.NparkingTerminal + + + +
    + +
    +
    +
    + + #number +AIRBASE.NparkingTotal + + +
    @@ -4951,6 +5455,83 @@ The dimension of the spawned aircraft and of the potential obstacle are taken in + +
    +
    + + #number +AIRBASE.category + +

    Airbase category.

    + +
    + +
    +
    +
    + + #table +AIRBASE.descriptors + +

    DCS descriptors.

    + +
    + +
    +
    +
    + + #boolean +AIRBASE.isAirdrome + +

    Airbase is an airdrome.

    + +
    + +
    +
    +
    + + #boolean +AIRBASE.isHelipad + +

    Airbase is a helipad.

    + +
    + +
    +
    +
    + + #boolean +AIRBASE.isShip + +

    Airbase is a ship.

    + +
    + +
    +
    +
    + + #table +AIRBASE.parking + +

    Parking spot data.

    + +
    + +
    +
    +
    + + #table +AIRBASE.parkingByID + +

    Parking spot data table with ID as key.

    + +
    +

    Function(s)

    @@ -5482,6 +6063,36 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
    + + + +
    + + + +

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    + +
    + +

    The COORDINATE of the POSITIONABLE.

    + +
    +
    +
    +
    @@ -5512,6 +6123,39 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction. + + + +
    + + + +

    Returns the DCS object.

    + + +

    Polymorphic for other classes like UNIT, STATIC, GROUP, AIRBASE.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    DCS#Object:

    +
    +
    + +

    The DCS object.

    + +
    +
    +
    +
    @@ -6218,7 +6862,7 @@ Coordinates are dependent on the position of the maps origin.

    Return value:

    @@ -6493,24 +7137,16 @@ Coordinates are dependent on the position of the maps origin.

    -

    Return values:

    +

    Return value:

    -
    -

    DCS#Vec2:

    -
    -
    - -

    The 2D point vector of the POSITIONABLE.

    +
    +

    DCS#Vec2:

    +
    +
    + +

    The 2D point vector of the POSITIONABLE or #nil if it is not existing or alive.

    -
    -
    -

    #nil:

    -
    -
    - -

    The POSITIONABLE is not existing or alive.

    - -
    +
    @@ -6531,24 +7167,16 @@ Coordinates are dependent on the position of the maps origin.

    -

    Return values:

    +

    Return value:

    -
    -

    DCS#Vec3:

    -
    -
    - -

    The 3D point vector of the POSITIONABLE.

    +
    +

    DCS#Vec3:

    +
    +
    + +

    The 3D point vector of the POSITIONABLE or nil if it is not existing or alive.

    -
    -
    -

    #nil:

    -
    -
    - -

    The POSITIONABLE is not existing or alive.

    - -
    +
    @@ -8249,10 +8877,10 @@ Coordinates are dependent on the position of the maps origin.

    - + #number AIRBASE.AirbaseID - +

    Airbase ID.

    @@ -8260,10 +8888,10 @@ Coordinates are dependent on the position of the maps origin.

    - + #string AIRBASE.AirbaseName - +

    Name of the airbase.

    @@ -8276,6 +8904,9 @@ Coordinates are dependent on the position of the maps origin.

    + +

    TODO: For ships we need a moving zone.

    +
    @@ -8323,10 +8954,10 @@ Coordinates are dependent on the position of the maps origin.

  • AIRBASE.Caucasus.Mineralnye_Vody
  • AIRBASE.Caucasus.Nalchik
  • AIRBASE.Caucasus.Mozdok
  • -
  • AIRBASE.Caucasus.Beslan -
  • +
  • AIRBASE.Caucasus.Beslan
  • + @@ -8414,6 +9045,28 @@ Coordinates are dependent on the position of the maps origin.

  • AIRBASE.Normandy.Ford_AF
  • + + + +
    +
    + + #table +AIRBASE.NparkingTerminal + + + +
    + +
    +
    +
    + + #number +AIRBASE.NparkingTotal + + +
    @@ -8553,6 +9206,83 @@ Coordinates are dependent on the position of the maps origin.

    + +
    +
    + + #number +AIRBASE.category + +

    Airbase category.

    + +
    + +
    +
    +
    + + #table +AIRBASE.descriptors + +

    DCS descriptors.

    + +
    + +
    +
    +
    + + #boolean +AIRBASE.isAirdrome + +

    Airbase is an airdrome.

    + +
    + +
    +
    +
    + + #boolean +AIRBASE.isHelipad + +

    Airbase is a helipad.

    + +
    + +
    +
    +
    + + #boolean +AIRBASE.isShip + +

    Airbase is a ship.

    + +
    + +
    +
    +
    + + #table +AIRBASE.parking + +

    Parking spot data.

    + +
    + +
    +
    +
    + + #table +AIRBASE.parkingByID + +

    Parking spot data table with ID as key.

    + +
    +

    Function(s)

    @@ -9079,10 +9809,10 @@ If the Identifiable is alive, true is returned.

    - + #number AIRBASE.AirbaseID - +

    Airbase ID.

    @@ -9090,10 +9820,10 @@ If the Identifiable is alive, true is returned.

    - + #string AIRBASE.AirbaseName - +

    Name of the airbase.

    @@ -9106,6 +9836,9 @@ If the Identifiable is alive, true is returned.

    + +

    TODO: For ships we need a moving zone.

    +
    @@ -9153,10 +9886,10 @@ If the Identifiable is alive, true is returned.

  • AIRBASE.Caucasus.Mineralnye_Vody
  • AIRBASE.Caucasus.Nalchik
  • AIRBASE.Caucasus.Mozdok
  • -
  • AIRBASE.Caucasus.Beslan -
  • +
  • AIRBASE.Caucasus.Beslan
  • +
    @@ -9244,6 +9977,28 @@ If the Identifiable is alive, true is returned.

  • AIRBASE.Normandy.Ford_AF
  • + + + +
    +
    + + #table +AIRBASE.NparkingTerminal + + + +
    + +
    +
    +
    + + #number +AIRBASE.NparkingTotal + + +
    @@ -9383,6 +10138,83 @@ If the Identifiable is alive, true is returned.

    + +
    +
    + + #number +AIRBASE.category + +

    Airbase category.

    + +
    + +
    +
    +
    + + #table +AIRBASE.descriptors + +

    DCS descriptors.

    + +
    + +
    +
    +
    + + #boolean +AIRBASE.isAirdrome + +

    Airbase is an airdrome.

    + +
    + +
    +
    +
    + + #boolean +AIRBASE.isHelipad + +

    Airbase is a helipad.

    + +
    + +
    +
    +
    + + #boolean +AIRBASE.isShip + +

    Airbase is a ship.

    + +
    + +
    +
    +
    + + #table +AIRBASE.parking + +

    Parking spot data.

    + +
    + +
    +
    +
    + + #table +AIRBASE.parkingByID + +

    Parking spot data table with ID as key.

    + +
    +

    Function(s)

    @@ -9515,10 +10347,10 @@ If the Identifiable is alive, true is returned.

    - + #number AIRBASE.AirbaseID - +

    Airbase ID.

    @@ -9526,10 +10358,10 @@ If the Identifiable is alive, true is returned.

    - + #string AIRBASE.AirbaseName - +

    Name of the airbase.

    @@ -9542,6 +10374,9 @@ If the Identifiable is alive, true is returned.

    + +

    TODO: For ships we need a moving zone.

    +
    @@ -9589,10 +10424,10 @@ If the Identifiable is alive, true is returned.

  • AIRBASE.Caucasus.Mineralnye_Vody
  • AIRBASE.Caucasus.Nalchik
  • AIRBASE.Caucasus.Mozdok
  • -
  • AIRBASE.Caucasus.Beslan -
  • +
  • AIRBASE.Caucasus.Beslan
  • +
    @@ -9680,6 +10515,28 @@ If the Identifiable is alive, true is returned.

  • AIRBASE.Normandy.Ford_AF
  • + + + +
    +
    + + #table +AIRBASE.NparkingTerminal + + + +
    + +
    +
    +
    + + #number +AIRBASE.NparkingTotal + + +
    @@ -9819,6 +10676,83 @@ If the Identifiable is alive, true is returned.

    + +
    +
    + + #number +AIRBASE.category + +

    Airbase category.

    + +
    + +
    +
    +
    + + #table +AIRBASE.descriptors + +

    DCS descriptors.

    + +
    + +
    +
    +
    + + #boolean +AIRBASE.isAirdrome + +

    Airbase is an airdrome.

    + +
    + +
    +
    +
    + + #boolean +AIRBASE.isHelipad + +

    Airbase is a helipad.

    + +
    + +
    +
    +
    + + #boolean +AIRBASE.isShip + +

    Airbase is a ship.

    + +
    + +
    +
    +
    + + #table +AIRBASE.parking + +

    Parking spot data.

    + +
    + +
    +
    +
    + + #table +AIRBASE.parkingByID + +

    Parking spot data table with ID as key.

    + +
    +

    Function(s)

    @@ -12897,6 +13831,17 @@ BASE:TraceOnOff( false )

    Type of the spot, i.e. for which type of aircraft it can be used.

    +
    + + +
    +
    diff --git a/Documentation/Wrapper.Client.html b/Documentation/Wrapper.Client.html index eccc4ff4e..ea36255cb 100644 --- a/Documentation/Wrapper.Client.html +++ b/Documentation/Wrapper.Client.html @@ -664,6 +664,17 @@

    Core - Management of spotting logistics, that can be activated and deactivated upon command.

    +

    + + +
    +
    +
    + Image + +
    +

    +

    Core - Timer scheduler.

    @@ -1173,6 +1184,17 @@

    Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

    +

    + + +
    +
    + +

    +

    Utils - Lua Profiler.

    @@ -1239,6 +1261,17 @@

    Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

    +

    + + +
    +
    + +

    +

    Wrapper - Markers On the F10 map.

    @@ -2827,12 +2860,24 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return

    CLIENT:GetClimbAngle()

    Returns the unit's climb or descent angle.

    + + + +

    CLIENT:GetCoord()

    + +

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    CLIENT:GetCoordinate()

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    + + + +

    CLIENT:GetDCSObject()

    + +

    Returns the DCS object.

    @@ -3235,6 +3280,18 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return

    CLIENT.__

    + + + +

    CLIENT.coordinate

    + +

    Coordinate object.

    + + + +

    CLIENT.pointvec3

    + +

    Point Vec3 object.

    @@ -9060,24 +9117,16 @@ If at least one detection method is specified, only the methods -

    Return values:

    +

    Return value:

    -
    -

    #number:

    -
    -
    - -

    The controllable health value (unit or group average).

    +
    +

    #number:

    +
    +
    + +

    The controllable health value (unit or group average) or nil if the controllable does not exist.

    -
    -
    -

    #nil:

    -
    -
    - -

    The controllable is not existing or alive.

    - -
    +
    @@ -13562,7 +13611,7 @@ If the task is assigned to the controllable lead unit will be a FAC.

    -

    Frequency used to communicate with the FAC.

    +

    Frequency in MHz used to communicate with the FAC. Default 133 MHz.

    @@ -13575,7 +13624,7 @@ If the task is assigned to the controllable lead unit will be a FAC.

    -

    Modulation of radio for communication.

    +

    Modulation of radio for communication. Default 0=AM.

    @@ -15876,6 +15925,36 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction. + + + +
    + + + +

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    + +
    + +

    The COORDINATE of the POSITIONABLE.

    + +
    +
    +
    +
    @@ -15906,6 +15985,39 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction. + + + +
    + + + +

    Returns the DCS object.

    + + +

    Polymorphic for other classes like UNIT, STATIC, GROUP, AIRBASE.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    DCS#Object:

    +
    +
    + +

    The DCS object.

    + +
    +
    +
    +
    @@ -16612,7 +16724,7 @@ Coordinates are dependent on the position of the maps origin.

    Return value:

    @@ -16887,24 +16999,16 @@ Coordinates are dependent on the position of the maps origin.

    -

    Return values:

    +

    Return value:

    -
    -

    DCS#Vec2:

    -
    -
    - -

    The 2D point vector of the POSITIONABLE.

    +
    +

    DCS#Vec2:

    +
    +
    + +

    The 2D point vector of the POSITIONABLE or #nil if it is not existing or alive.

    -
    -
    -

    #nil:

    -
    -
    - -

    The POSITIONABLE is not existing or alive.

    - -
    +
    @@ -16925,24 +17029,16 @@ Coordinates are dependent on the position of the maps origin.

    -

    Return values:

    +

    Return value:

    -
    -

    DCS#Vec3:

    -
    -
    - -

    The 3D point vector of the POSITIONABLE.

    +
    +

    DCS#Vec3:

    +
    +
    + +

    The 3D point vector of the POSITIONABLE or nil if it is not existing or alive.

    -
    -
    -

    #nil:

    -
    -
    - -

    The POSITIONABLE is not existing or alive.

    - -
    +
    diff --git a/Documentation/Wrapper.Controllable.html b/Documentation/Wrapper.Controllable.html index dc4e8311f..ad92832b0 100644 --- a/Documentation/Wrapper.Controllable.html +++ b/Documentation/Wrapper.Controllable.html @@ -664,6 +664,17 @@

    Core - Management of spotting logistics, that can be activated and deactivated upon command.

    +

    + + +
    +
    +
    + Image + +
    +

    +

    Core - Timer scheduler.

    @@ -1173,6 +1184,17 @@

    Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

    +

    + + +
    +
    + +

    +

    Utils - Lua Profiler.

    @@ -1239,6 +1261,17 @@

    Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

    +

    + + +
    +
    + +

    +

    Wrapper - Markers On the F10 map.

    @@ -2475,12 +2508,24 @@ The method CONTROLLABLE.SetTaskWaypoi

    CONTROLLABLE:GetClimbAngle()

    Returns the unit's climb or descent angle.

    + + + +

    CONTROLLABLE:GetCoord()

    + +

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    CONTROLLABLE:GetCoordinate()

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    + + + +

    CONTROLLABLE:GetDCSObject()

    + +

    Returns the DCS object.

    @@ -2883,6 +2928,18 @@ The method CONTROLLABLE.SetTaskWaypoi

    CONTROLLABLE.__

    + + + +

    CONTROLLABLE.coordinate

    + +

    Coordinate object.

    + + + +

    CONTROLLABLE.pointvec3

    + +

    Point Vec3 object.

    @@ -5569,24 +5626,16 @@ If at least one detection method is specified, only the methods

    CONTROLLABLE

    -

    Return values:

    +

    Return value:

    -
    -

    #number:

    -
    -
    - -

    The controllable health value (unit or group average).

    +
    +

    #number:

    +
    +
    + +

    The controllable health value (unit or group average) or nil if the controllable does not exist.

    -
    -
    -

    #nil:

    -
    -
    - -

    The controllable is not existing or alive.

    - -
    +
    @@ -10071,7 +10120,7 @@ If the task is assigned to the controllable lead unit will be a FAC.

    -

    Frequency used to communicate with the FAC.

    +

    Frequency in MHz used to communicate with the FAC. Default 133 MHz.

    @@ -10084,7 +10133,7 @@ If the task is assigned to the controllable lead unit will be a FAC.

    -

    Modulation of radio for communication.

    +

    Modulation of radio for communication. Default 0=AM.

    @@ -12294,6 +12343,36 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction. + + + +
    + + + +

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    + +
    + +

    The COORDINATE of the POSITIONABLE.

    + +
    +
    +
    +
    @@ -12324,6 +12403,39 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction. + + + +
    + + + +

    Returns the DCS object.

    + + +

    Polymorphic for other classes like UNIT, STATIC, GROUP, AIRBASE.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    DCS#Object:

    +
    +
    + +

    The DCS object.

    + +
    +
    +
    +
    @@ -13030,7 +13142,7 @@ Coordinates are dependent on the position of the maps origin.

    Return value:

    @@ -13305,24 +13417,16 @@ Coordinates are dependent on the position of the maps origin.

    -

    Return values:

    +

    Return value:

    -
    -

    DCS#Vec2:

    -
    -
    - -

    The 2D point vector of the POSITIONABLE.

    +
    +

    DCS#Vec2:

    +
    +
    + +

    The 2D point vector of the POSITIONABLE or #nil if it is not existing or alive.

    -
    -
    -

    #nil:

    -
    -
    - -

    The POSITIONABLE is not existing or alive.

    - -
    +
    @@ -13343,24 +13447,16 @@ Coordinates are dependent on the position of the maps origin.

    -

    Return values:

    +

    Return value:

    -
    -

    DCS#Vec3:

    -
    -
    - -

    The 3D point vector of the POSITIONABLE.

    +
    +

    DCS#Vec3:

    +
    +
    + +

    The 3D point vector of the POSITIONABLE or nil if it is not existing or alive.

    -
    -
    -

    #nil:

    -
    -
    - -

    The POSITIONABLE is not existing or alive.

    - -
    +
    diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index cb1b9d64e..7f0fb2f8e 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -664,6 +664,17 @@

    Core - Management of spotting logistics, that can be activated and deactivated upon command.

    +

    + + +
    +
    +
    + Image + +
    +

    +

    Core - Timer scheduler.

    @@ -1173,6 +1184,17 @@

    Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

    +

    + + +
    +
    + +

    +

    Utils - Lua Profiler.

    @@ -1239,6 +1261,17 @@

    Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

    +

    + + +
    +
    + +

    +

    Wrapper - Markers On the F10 map.

    @@ -1820,6 +1853,12 @@ amount of fuel in the group.

    GROUP:GetTemplateRoutePoints()

    Returns the group template route.points[] (the waypoints) from the DATABASE (_DATABASE object).

    + + + +

    GROUP:GetThreatLevel()

    + +

    Get threat level of the group.

    @@ -2060,6 +2099,12 @@ amount of fuel in the group.

    GROUP:IsHelicopter()

    Returns if the DCS Group contains Helicopters.

    + + + +

    GROUP:IsInZone(Zone)

    + +

    Check if any unit of a group is inside a Zone.

    @@ -3102,12 +3147,24 @@ amount of fuel in the group.

    GROUP:GetClimbAngle()

    Returns the unit's climb or descent angle.

    + + + +

    GROUP:GetCoord()

    + +

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    GROUP:GetCoordinate()

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    + + + +

    GROUP:GetDCSObject()

    + +

    Returns the DCS object.

    @@ -3510,6 +3567,18 @@ amount of fuel in the group.

    GROUP.__

    + + + +

    GROUP.coordinate

    + +

    Coordinate object.

    + + + +

    GROUP.pointvec3

    + +

    Point Vec3 object.

    @@ -4570,6 +4639,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    GROUP

    +

    Return value:

    +
    +
    +

    #number:

    +
    +
    + +

    Number between 0 and 10.

    + +
    +
    @@ -6159,6 +6239,36 @@ amount of fuel in the group.

    + + + +
    + + + +

    Get threat level of the group.

    + +
    +
    +

    Defined in:

    +
    +

    GROUP

    +
    +

    Return value:

    +
    +
    +

    #number:

    +
    +
    + +

    Max threat level (a number between 0 and 10).

    + +
    +
    +
    +
    @@ -7342,6 +7452,50 @@ If the first Wrapper.Unit of the group is inacti + + + +
    + + + +

    Check if any unit of a group is inside a Zone.

    + +
    +
    +

    Defined in:

    +
    +

    GROUP

    +
    +

    Parameter:

    +
    +
    +

    + Core.Zone#ZONE_BASE + Zone +

    +
    +
    + +

    The zone to test.

    + +
    +
    +

    Return value:

    +
    +
    +

    #boolean:

    +
    +
    + +

    Returns true if at least one unit is inside the zone or false if no unit is inside.

    + +
    +
    +
    +
    @@ -10373,24 +10527,16 @@ If at least one detection method is specified, only the methods -

    Return values:

    +

    Return value:

    -
    -

    #number:

    -
    -
    - -

    The controllable health value (unit or group average).

    +
    +

    #number:

    +
    +
    + +

    The controllable health value (unit or group average) or nil if the controllable does not exist.

    -
    -
    -

    #nil:

    -
    -
    - -

    The controllable is not existing or alive.

    - -
    +
    @@ -14875,7 +15021,7 @@ If the task is assigned to the controllable lead unit will be a FAC.

    -

    Frequency used to communicate with the FAC.

    +

    Frequency in MHz used to communicate with the FAC. Default 133 MHz.

    @@ -14888,7 +15034,7 @@ If the task is assigned to the controllable lead unit will be a FAC.

    -

    Modulation of radio for communication.

    +

    Modulation of radio for communication. Default 0=AM.

    @@ -17186,6 +17332,36 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction. + + + +
    + + + +

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    + +
    + +

    The COORDINATE of the POSITIONABLE.

    + +
    +
    +
    +
    @@ -17216,6 +17392,39 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction. + + + +
    + + + +

    Returns the DCS object.

    + + +

    Polymorphic for other classes like UNIT, STATIC, GROUP, AIRBASE.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    DCS#Object:

    +
    +
    + +

    The DCS object.

    + +
    +
    +
    +
    @@ -17922,7 +18131,7 @@ Coordinates are dependent on the position of the maps origin.

    Return value:

    @@ -18197,24 +18406,16 @@ Coordinates are dependent on the position of the maps origin.

    -

    Return values:

    +

    Return value:

    -
    -

    DCS#Vec2:

    -
    -
    - -

    The 2D point vector of the POSITIONABLE.

    +
    +

    DCS#Vec2:

    +
    +
    + +

    The 2D point vector of the POSITIONABLE or #nil if it is not existing or alive.

    -
    -
    -

    #nil:

    -
    -
    - -

    The POSITIONABLE is not existing or alive.

    - -
    +
    @@ -18235,24 +18436,16 @@ Coordinates are dependent on the position of the maps origin.

    -

    Return values:

    +

    Return value:

    -
    -

    DCS#Vec3:

    -
    -
    - -

    The 3D point vector of the POSITIONABLE.

    +
    +

    DCS#Vec3:

    +
    +
    + +

    The 3D point vector of the POSITIONABLE or nil if it is not existing or alive.

    -
    -
    -

    #nil:

    -
    -
    - -

    The POSITIONABLE is not existing or alive.

    - -
    +
    diff --git a/Documentation/Wrapper.Identifiable.html b/Documentation/Wrapper.Identifiable.html index b1445efd3..82ae8b83e 100644 --- a/Documentation/Wrapper.Identifiable.html +++ b/Documentation/Wrapper.Identifiable.html @@ -664,6 +664,17 @@

    Core - Management of spotting logistics, that can be activated and deactivated upon command.

    +

    + + +
    +
    +
    + Image + +
    +

    +

    Core - Timer scheduler.

    @@ -1173,6 +1184,17 @@

    Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

    +

    + + +
    +
    + +

    +

    Utils - Lua Profiler.

    @@ -1239,6 +1261,17 @@

    Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

    +

    + + +
    +
    + +

    +

    Wrapper - Markers On the F10 map.

    diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html new file mode 100644 index 000000000..4293ca73f --- /dev/null +++ b/Documentation/Wrapper.Marker.html @@ -0,0 +1,9587 @@ + + + + + + + + + + + + + + + +
    +

    + +

    +
    +
    + + +Banner Image +
    +
    +

    Module Wrapper.Marker

    +
    +
    + +

    Wrapper - Markers On the F10 map.

    + + + +

    Main Features:

    + +
      +
    • Convenient handling of markers via multiple user API functions.
    • +
    • Update text and position of marker easily via scripting.
    • +
    • Delay creation and removal of markers via (optional) parameters.
    • +
    • Retrieve data such as text and coordinate.
    • +
    • Marker specific FSM events when a marker is added, removed or changed.
    • +
    • Additional FSM events when marker text or position is changed.
    • +
    + +
    + +

    Author: funkyfranky

    + +
    +

    Global(s)

    +
    + + + + + +

    Global MARKER

    +

    Just because...

    +
    +
    +
    +
    + + #MARKER +MARKER + +

    Just because...

    + + + +
    + +

    Banner Image

    + +

    The MARKER Class Idea

    + +

    The MARKER class simplifies creating, updating and removing of markers on the F10 map.

    + +

    Create a Marker

    + +
    -- Create a MARKER object at Batumi with a trivial text.
    +local Coordinate=AIRBASE:FindByName("Batumi"):GetCoordinate()
    +mymarker=MARKER:New(Coordinate, "I am Batumi Airfield")
    +
    + +

    Now this does not show the marker yet. We still need to specifiy to whom it is shown. There are several options, i.e. +show the marker to everyone, to a speficic coaliton only, or only to a specific group.

    + +

    For Everyone

    + +

    If the marker should be visible to everyone, you can use the :ToAll() function.

    + +
    mymarker=MARKER:New(Coordinate, "I am Batumi Airfield"):ToAll()
    +
    + +

    For a Coaliton

    + +

    If the maker should be visible to a specific coalition, you can use the :ToCoalition() function.

    + +
    mymarker=MARKER:New(Coordinate, "I am Batumi Airfield"):ToCoaliton(coaliton.side.BLUE)
    +
    + +

    To Blue Coaliton

    + +

    To Red Coalition

    + +

    This would show the marker only to the Blue coaliton.

    + +

    For a Group

    + + +

    Removing a Marker

    + + +

    Updating a Marker

    + +

    The marker text and coordinate can be updated easily as shown below.

    + +

    However, note that updateing involves to remove and recreate the marker if either text or its coordinate is changed. +This is a DCS scripting engine limitation.

    + +

    Update Text

    + +

    If you created a marker "mymarker" as shown above, you can update the dispayed test by

    + +
    mymarker:UpdateText("I am the new text at Batumi")
    +
    + +

    The update can also be delayed by, e.g. 90 seconds, using

    + +
    mymarker:UpdateText("I am the new text at Batumi", 90)
    +
    + +

    Update Coordinate

    + +

    If you created a marker "mymarker" as shown above, you can update its coordinate on the F10 map by

    + +
    mymarker:UpdateCoordinate(NewCoordinate)
    +
    + +

    The update can also be delayed by, e.g. 60 seconds, using

    + +
    mymarker:UpdateCoordinate(NewCoordinate, 60)
    +
    + +

    Retrieve Data

    + +

    The important data as the displayed text and the coordinate of the marker can be retrieved easily.

    + +

    Text

    + +
    local text=mymarker:GetText()
    +env.info("Marker Text = " .. text)
    +
    + +

    Coordinate

    + +
    local Coordinate=mymarker:GetCoordinate()
    +env.info("Marker Coordinate LL DSM = " .. Coordinate:ToStringLLDMS())
    +
    + + +

    FSM Events

    + +

    Moose creates addditonal events, so called FSM event, when markers are added, changed, removed, and text or the coordianteis updated.

    + +

    These events can be captured and used for processing via OnAfter functions as shown below.

    + +

    Added

    + +

    Changed

    + +

    Removed

    + +

    TextUpdate

    + +

    CoordUpdate

    + + +

    Examples

    + + + +
    + +
    +
    + + + + + +

    Global _MARKERID

    +

    Marker ID.

    +
    +
    +
    +
    + + #number +_MARKERID + +

    Marker ID.

    + + +

    Running number.

    + +
    + +
    +

    Type(s)

    + +
    + MARKER +, extends Core.Fsm#FSM +, extends Core.Base#BASE +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Fields and Methods inherited from MARKERDescription

    MARKER:Added(EventData)

    +

    Triggers the FSM event "Added".

    +

    MARKER:Changed(EventData)

    +

    Triggers the FSM event "Changed".

    +

    MARKER.ClassName

    +

    Name of the class.

    +

    MARKER:CoordUpdate(Coordinate)

    +

    Triggers the FSM event "CoordUpdate".

    +

    MARKER.Debug

    +

    Debug mode. Messages to all about status.

    +

    MARKER:GetCoordinate()

    +

    Get position of the marker.

    +

    MARKER:GetText()

    +

    Get text that is displayed in the marker panel.

    +

    MARKER:IsInvisible()

    +

    Check if marker is currently invisible on the F10 map.

    +

    MARKER:IsVisible()

    +

    Check if marker is currently visible on the F10 map.

    +

    MARKER:Message(Text)

    +

    Set message that is displayed on screen if the marker is added.

    +

    MARKER:New(Coordinate, Text)

    +

    Create a new MARKER class object.

    +

    MARKER:OnAfterAdded(From, Event, To, EventData)

    +

    On after "Added" event user function.

    +

    MARKER:OnAfterChanged(From, Event, To, EventData)

    +

    On after "Changed" event user function.

    +

    MARKER:OnAfterCoordUpdate(From, Event, To, Coordinate)

    +

    On after "CoordUpdate" event user function.

    +

    MARKER:OnAfterRemoved(From, Event, To, EventData)

    +

    On after "Removed" event user function.

    +

    MARKER:OnAfterTextUpdate(From, Event, To, Text)

    +

    On after "TextUpdate" event user function.

    +

    MARKER:OnEventMarkAdded(EventData)

    +

    Event function when a MARKER is added.

    +

    MARKER:OnEventMarkChange(EventData)

    +

    Event function when a MARKER changed.

    +

    MARKER:OnEventMarkRemoved(EventData)

    +

    Event function when a MARKER is removed.

    +

    MARKER:ReadOnly()

    +

    Marker is readonly.

    +

    MARKER:Refresh(Delay)

    +

    Refresh the marker.

    +

    MARKER:Remove(Delay)

    +

    Remove a marker.

    +

    MARKER:Removed(EventData)

    +

    Triggers the FSM event "Removed".

    +

    MARKER:SetText(Text)

    +

    Set text that is displayed in the marker panel.

    +

    MARKER:TextUpdate(Text)

    +

    Triggers the FSM event "TextUpdate".

    +

    MARKER:ToAll(Delay)

    +

    Place marker visible for everyone.

    +

    MARKER:ToBlue(Delay)

    +

    Place marker visible for the blue coalition only.

    +

    MARKER:ToCoalition(Coalition, Delay)

    +

    Place marker visible for a specific coalition only.

    +

    MARKER:ToGroup(Group, Delay)

    +

    Place marker visible for a specific group only.

    +

    MARKER:ToNeutral(Delay)

    +

    Place marker visible for the neutral coalition only.

    +

    MARKER:ToRed(Delay)

    +

    Place marker visible for the blue coalition only.

    +

    MARKER:UpdateCoordinate(Coordinate, Delay)

    +

    Update the coordinate where the marker is displayed.

    +

    MARKER:UpdateText(Text, Delay)

    +

    Update the text displayed on the mark panel.

    +

    MARKER:__Added(EventData)

    +

    Triggers the delayed FSM event "Added".

    +

    MARKER:__Changed(EventData)

    +

    Triggers the delayed FSM event "Changed".

    +

    MARKER:__CoordUpdate(Coordinate)

    +

    Triggers the delayed FSM event "CoordUpdate".

    +

    MARKER:__Removed(EventData)

    +

    Triggers the delayed FSM event "Removed".

    +

    MARKER:__TextUpdate(Text)

    +

    Triggers the delayed FSM event "TextUpdate".

    +

    MARKER.coalition

    +

    Coalition to which the marker is displayed.

    +

    MARKER.coordinate

    +

    Coordinate of the mark.

    +

    MARKER.groupid

    + +

    MARKER.groupname

    + +

    MARKER.lid

    +

    Class id string for output to DCS log file.

    +

    MARKER.message

    +

    Message dispayed when the mark is added.

    +

    MARKER.mid

    +

    Marker ID.

    +

    MARKER.myid

    + +

    MARKER:onafterAdded(From, Event, To, EventData)

    +

    On after "Added" event.

    +

    MARKER:onafterChanged(From, Event, To, EventData)

    +

    On after "Changed" event.

    +

    MARKER:onafterCoordUpdate(From, Event, To, Coordinate)

    +

    On after "CoordUpdate" event.

    +

    MARKER:onafterRemoved(From, Event, To, EventData)

    +

    On after "Removed" event.

    +

    MARKER:onafterTextUpdate(From, Event, To, Text)

    +

    On after "TextUpdate" event.

    +

    MARKER.readonly

    +

    Marker is read-only.

    +

    MARKER.shown

    + +

    MARKER.text

    +

    Text displayed in the mark panel.

    +

    MARKER.toall

    + +

    MARKER.tocoaliton

    + +

    MARKER.togroup

    + +

    MARKER.version

    +

    Marker class version.

    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Fields and Methods inherited from FSMDescription

    MARKER:AddEndState(State)

    +

    Adds an End state.

    +

    MARKER:AddProcess(From, Event, Process, ReturnEvents)

    +

    Set the default Process template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

    +

    MARKER:AddScore(State, ScoreText, Score)

    +

    Adds a score for the FSM to be achieved.

    +

    MARKER:AddScoreProcess(From, Event, State, ScoreText, Score)

    +

    Adds a score for the FSM_PROCESS to be achieved.

    +

    MARKER:AddTransition(From, Event, To)

    +

    Add a new transition rule to the FSM.

    +

    MARKER.CallScheduler

    +

    Call scheduler.

    +

    MARKER.ClassName

    +

    Name of the class.

    +

    MARKER.Events

    + +

    MARKER:GetCurrentState()

    +

    Get current state.

    +

    MARKER:GetEndStates()

    +

    Returns the End states.

    +

    MARKER:GetProcess(From, Event)

    + +

    MARKER:GetProcesses()

    +

    Returns a table of the SubFSM rules defined within the FSM.

    +

    MARKER:GetScores(Scores)

    +

    Returns a table with the scores defined.

    +

    MARKER:GetStartState()

    +

    Returns the start state of the FSM.

    +

    MARKER:GetState()

    +

    Get current state.

    +

    MARKER:GetSubs()

    +

    Returns a table with the Subs defined.

    +

    MARKER:GetTransitions()

    +

    Returns a table of the transition rules defined within the FSM.

    +

    MARKER:Is(State, If)

    +

    Check if FSM is in state.

    +

    MARKER:LoadCallBacks(CallBackTable)

    +

    Load call backs.

    +

    MARKER:New()

    +

    Creates a new FSM object.

    +

    MARKER.Scores

    +

    Scores.

    +

    MARKER:SetProcess(From, Event, Fsm)

    + +

    MARKER:SetStartState(State)

    +

    Sets the start state of the FSM.

    +

    MARKER._EndStates

    + +

    MARKER._EventSchedules

    + +

    MARKER._Processes

    + +

    MARKER._Scores

    + +

    MARKER._StartState

    + +

    MARKER._Transitions

    + +

    MARKER:_add_to_map(Map, Event)

    +

    Add to map.

    +

    MARKER:_call_handler(step, trigger, params, EventName)

    +

    Call handler.

    +

    MARKER:_create_transition(EventName)

    +

    Create transition.

    +

    MARKER:_delayed_transition(EventName)

    +

    Delayed transition.

    +

    MARKER:_eventmap(Events, EventStructure)

    +

    Event map.

    +

    MARKER:_gosub(ParentFrom, ParentEvent)

    +

    Go sub.

    +

    MARKER:_handler(EventName, ...)

    +

    Handler.

    +

    MARKER:_isendstate(Current)

    +

    Is end state.

    +

    MARKER:_submap(subs, sub, name)

    +

    Sub maps.

    +

    MARKER:can(e)

    +

    Check if can do an event.

    +

    MARKER:cannot(e)

    +

    Check if cannot do an event.

    +

    MARKER.current

    +

    Current state name.

    +

    MARKER.endstates

    + +

    MARKER:is(State, If, state)

    +

    Check if FSM is in state.

    +

    MARKER.options

    +

    Options.

    +

    MARKER.subs

    +

    Subs.

    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Fields and Methods inherited from BASEDescription

    MARKER.ClassID

    +

    The ID number of the class.

    +

    MARKER.ClassName

    +

    The name of the class.

    +

    MARKER.ClassNameAndID

    +

    The name of the class concatenated with the ID number of the class.

    +

    MARKER:ClearState(Object, StateName)

    +

    Clear the state of an object.

    +

    MARKER:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

    +

    Creation of a Birth Event.

    +

    MARKER:CreateEventCrash(EventTime, Initiator)

    +

    Creation of a Crash Event.

    +

    MARKER:CreateEventDead(EventTime, Initiator)

    +

    Creation of a Dead Event.

    +

    MARKER:CreateEventRemoveUnit(EventTime, Initiator)

    +

    Creation of a Remove Unit Event.

    +

    MARKER:CreateEventTakeoff(EventTime, Initiator)

    +

    Creation of a Takeoff Event.

    +

    MARKER:E(Arguments)

    +

    Log an exception which will be traced always.

    +

    MARKER:EventDispatcher()

    +

    Returns the event dispatcher

    +

    MARKER:EventRemoveAll()

    +

    Remove all subscribed events

    +

    MARKER:F(Arguments)

    +

    Trace a function call.

    +

    MARKER:F2(Arguments)

    +

    Trace a function call level 2.

    +

    MARKER:F3(Arguments)

    +

    Trace a function call level 3.

    +

    MARKER:GetClassID()

    +

    Get the ClassID of the class instance.

    +

    MARKER:GetClassName()

    +

    Get the ClassName of the class instance.

    +

    MARKER:GetClassNameAndID()

    +

    Get the ClassName + ClassID of the class instance.

    +

    MARKER:GetEventPriority()

    +

    Get the Class Event processing Priority.

    +

    MARKER:GetParent(Child, FromClass)

    +

    This is the worker method to retrieve the Parent class.

    +

    MARKER:GetState(Object, Key)

    +

    Get a Value given a Key from the Object.

    +

    MARKER:HandleEvent(Event, EventFunction)

    +

    Subscribe to a DCS Event.

    +

    MARKER:I(Arguments)

    +

    Log an information which will be traced always.

    +

    MARKER:Inherit(Child, Parent)

    +

    This is the worker method to inherit from a parent class.

    +

    MARKER:IsInstanceOf(ClassName)

    +

    This is the worker method to check if an object is an (sub)instance of a class.

    +

    MARKER:IsTrace()

    +

    Enquires if tracing is on (for the class).

    +

    MARKER:New()

    +

    BASE constructor.

    +

    MARKER:OnEvent(EventData)

    +

    Occurs when an object is completely destroyed.

    +

    MARKER:OnEventBaseCaptured(EventData)

    +

    Occurs when a ground unit captures either an airbase or a farp.

    +

    MARKER:OnEventBirth(EventData)

    +

    Occurs when any object is spawned into the mission.

    +

    MARKER:OnEventCrash(EventData)

    +

    Occurs when any aircraft crashes into the ground and is completely destroyed.

    +

    MARKER:OnEventDead(EventData)

    +

    Occurs when an object is dead.

    +

    MARKER:OnEventDetailedFailure(EventData)

    +

    Unknown precisely what creates this event, likely tied into newer damage model.

    +

    MARKER:OnEventEjection(EventData)

    +

    Occurs when a pilot ejects from an aircraft +initiator : The unit that has ejected

    +

    MARKER:OnEventEngineShutdown(EventData)

    +

    Occurs when any aircraft shuts down its engines.

    +

    MARKER:OnEventEngineStartup(EventData)

    +

    Occurs when any aircraft starts its engines.

    +

    MARKER:OnEventHit(EventData)

    +

    Occurs whenever an object is hit by a weapon.

    +

    MARKER:OnEventHumanFailure(EventData)

    +

    Occurs when any system fails on a human controlled aircraft.

    +

    MARKER:OnEventKill(EventData)

    +

    Occurs on the death of a unit.

    +

    MARKER:OnEventLand(EventData)

    +

    Occurs when an aircraft lands at an airbase, farp or ship +initiator : The unit that has landed +place: Object that the unit landed on.

    +

    MARKER:OnEventLandingAfterEjection(EventData)

    +

    Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

    +

    MARKER:OnEventMarkAdded(EventData)

    +

    Occurs when a new mark was added.

    +

    MARKER:OnEventMarkChange(EventData)

    +

    Occurs when a mark text was changed.

    +

    MARKER:OnEventMarkRemoved(EventData)

    +

    Occurs when a mark was removed.

    +

    MARKER:OnEventMissionEnd(EventData)

    +

    Occurs when a mission ends

    +

    MARKER:OnEventMissionStart(EventData)

    +

    Occurs when a mission starts

    +

    MARKER:OnEventPilotDead(EventData)

    +

    Occurs when the pilot of an aircraft is killed.

    +

    MARKER:OnEventPlayerEnterUnit(EventData)

    +

    Occurs when any player assumes direct control of a unit.

    +

    MARKER:OnEventPlayerLeaveUnit(EventData)

    +

    Occurs when any player relieves control of a unit to the AI.

    +

    MARKER:OnEventRefueling(EventData)

    +

    Occurs when an aircraft connects with a tanker and begins taking on fuel.

    +

    MARKER:OnEventRefuelingStop(EventData)

    +

    Occurs when an aircraft is finished taking fuel.

    +

    MARKER:OnEventScore(EventData)

    +

    Occurs when any modification to the "Score" as seen on the debrief menu would occur.

    +

    MARKER:OnEventShootingEnd(EventData)

    +

    Occurs when any unit stops firing its weapon.

    +

    MARKER:OnEventShootingStart(EventData)

    +

    Occurs when any unit begins firing a weapon that has a high rate of fire.

    +

    MARKER:OnEventShot(EventData)

    +

    Occurs whenever any unit in a mission fires a weapon.

    +

    MARKER:OnEventTakeoff(EventData)

    +

    Occurs when an aircraft takes off from an airbase, farp, or ship.

    +

    MARKER:OnEventUnitLost(EventData)

    +

    Occurs when the game thinks an object is destroyed.

    +

    MARKER:ScheduleOnce(Start, SchedulerFunction, ...)

    +

    Schedule a new time event.

    +

    MARKER:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

    +

    Schedule a new time event.

    +

    MARKER:ScheduleStop(SchedulerFunction)

    +

    Stops the Schedule.

    +

    MARKER.Scheduler

    + +

    MARKER:SetEventPriority(EventPriority)

    +

    Set the Class Event processing Priority.

    +

    MARKER:SetState(Object, Key, Value)

    +

    Set a state or property of the Object given a Key and a Value.

    +

    MARKER:T(Arguments)

    +

    Trace a function logic level 1.

    +

    MARKER:T2(Arguments)

    +

    Trace a function logic level 2.

    +

    MARKER:T3(Arguments)

    +

    Trace a function logic level 3.

    +

    MARKER:TraceAll(TraceAll)

    +

    Trace all methods in MOOSE

    +

    MARKER:TraceClass(Class)

    +

    Set tracing for a class

    +

    MARKER:TraceClassMethod(Class, Method)

    +

    Set tracing for a specific method of class

    +

    MARKER:TraceLevel(Level)

    +

    Set trace level

    +

    MARKER:TraceOff()

    +

    Set trace off.

    +

    MARKER:TraceOn()

    +

    Set trace on.

    +

    MARKER: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.

    +

    MARKER:UnHandleEvent(Event)

    +

    UnSubscribe to a DCS event.

    +

    MARKER._

    + +

    MARKER:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    +

    Trace a function call.

    +

    MARKER:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    +

    Trace a function logic.

    +

    MARKER.__

    + +

    MARKER:onEvent(event)

    + +
    +
    + + +
    +
    +
    + +
    + +
    +
    + +

    Marker class.

    + +
    +

    Field(s)

    +
    +
    +
    + + #string +MARKER.ClassName + +

    Name of the class.

    + +
    + +
    +
    +
    + + #boolean +MARKER.Debug + +

    Debug mode. Messages to all about status.

    + +
    + +
    +
    +
    + + #number +MARKER.coalition + +

    Coalition to which the marker is displayed.

    + +
    + +
    +
    +
    + + Core.Point#COORDINATE +MARKER.coordinate + +

    Coordinate of the mark.

    + +
    + +
    +
    +
    + + #string +MARKER.lid + +

    Class id string for output to DCS log file.

    + +
    + +
    +
    +
    + + #string +MARKER.message + +

    Message dispayed when the mark is added.

    + +
    + +
    +
    +
    + + #number +MARKER.mid + +

    Marker ID.

    + +
    + +
    +
    +
    + + +MARKER.myid + + + +
    + +
    +
    +
    + + #boolean +MARKER.readonly + +

    Marker is read-only.

    + +
    + +
    +
    +
    + + #boolean +MARKER.shown + + + +
    + +
    +
    +
    + + #string +MARKER.text + +

    Text displayed in the mark panel.

    + +
    + +
    +
    +
    + + #boolean +MARKER.toall + + + +
    + +
    +
    +
    + + #boolean +MARKER.tocoaliton + + + +
    + +
    +
    +
    + + #boolean +MARKER.togroup + + + +
    + +
    +
    +
    + + #string +MARKER.version + +

    Marker class version.

    + +
    + +
    +
    +

    Function(s)

    +
    +
    + + + +

    Triggers the FSM event "Added".

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    Event data table.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Triggers the FSM event "Changed".

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    Event data table.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Triggers the FSM event "CoordUpdate".

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + Core.Point#COORDINATE + Coordinate +

    +
    +
    + +

    The new Coordinate.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Get position of the marker.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Return value:

    +
    + +
    + +

    The coordinate of the marker.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Get text that is displayed in the marker panel.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Return value:

    +
    +
    +

    #string:

    +
    +
    + +

    Marker text.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Check if marker is currently invisible on the F10 map.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Return value:

    +
    +
    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + + + +

    Check if marker is currently visible on the F10 map.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Return value:

    +
    +
    +

    #boolean:

    +
    +
    + +

    True if the marker is currently visible.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Set message that is displayed on screen if the marker is added.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + #string + Text +

    +
    +
    + +

    Message displayed when the marker is added.

    + +
    +
    +

    Return value:

    +
    +
    +

    #MARKER:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Create a new MARKER class object.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameters:

    +
    +
    +

    + Core.Point#COORDINATE + Coordinate +

    +
    +
    + +

    Coordinate where to place the marker.

    + +
    +
    +
    +
    +

    + #string + Text +

    +
    +
    + +

    Text displayed on the mark panel.

    + +
    +
    +

    Return value:

    +
    +
    +

    #MARKER:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + + + +

    On after "Added" event user function.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameters:

    +
    +
    +

    + #string + From +

    +
    +
    + +

    From state.

    + +
    +
    +
    +
    +

    + #string + Event +

    +
    +
    + +

    Event.

    + +
    +
    +
    +
    +

    + #string + To +

    +
    +
    + +

    To state.

    + +
    +
    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    Event data table.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    On after "Changed" event user function.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameters:

    +
    +
    +

    + #string + From +

    +
    +
    + +

    From state.

    + +
    +
    +
    +
    +

    + #string + Event +

    +
    +
    + +

    Event.

    + +
    +
    +
    +
    +

    + #string + To +

    +
    +
    + +

    To state.

    + +
    +
    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    Event data table.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    On after "CoordUpdate" event user function.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameters:

    +
    +
    +

    + #string + From +

    +
    +
    + +

    From state.

    + +
    +
    +
    +
    +

    + #string + Event +

    +
    +
    + +

    Event.

    + +
    +
    +
    +
    +

    + #string + To +

    +
    +
    + +

    To state.

    + +
    +
    +
    +
    +

    + Core.Point#COORDINATE + Coordinate +

    +
    +
    + +

    The updated Coordinate.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    On after "Removed" event user function.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameters:

    +
    +
    +

    + #string + From +

    +
    +
    + +

    From state.

    + +
    +
    +
    +
    +

    + #string + Event +

    +
    +
    + +

    Event.

    + +
    +
    +
    +
    +

    + #string + To +

    +
    +
    + +

    To state.

    + +
    +
    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    Event data table.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    On after "TextUpdate" event user function.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameters:

    +
    +
    +

    + #string + From +

    +
    +
    + +

    From state.

    + +
    +
    +
    +
    +

    + #string + Event +

    +
    +
    + +

    Event.

    + +
    +
    +
    +
    +

    + #string + To +

    +
    +
    + +

    To state.

    + +
    +
    +
    +
    +

    + #string + Text +

    +
    +
    + +

    The new text.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Event function when a MARKER is added.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + + + +

    Event function when a MARKER changed.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + + + +

    Event function when a MARKER is removed.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + + + +

    Marker is readonly.

    + + +

    Text cannot be changed and marker cannot be removed.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Return value:

    +
    +
    +

    #MARKER:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Refresh the marker.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + #number + Delay +

    +
    +
    + +

    (Optional) Delay in seconds, before the marker is created.

    + +
    +
    +

    Return value:

    +
    +
    +

    #MARKER:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Remove a marker.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + #number + Delay +

    +
    +
    + +

    (Optional) Delay in seconds, before the marker is removed.

    + +
    +
    +

    Return value:

    +
    +
    +

    #MARKER:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Triggers the FSM event "Removed".

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    Event data table.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Set text that is displayed in the marker panel.

    + + +

    Note this does not show the marker.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + #string + Text +

    +
    +
    + +

    Marker text. Default is an empty sting "".

    + +
    +
    +

    Return value:

    +
    +
    +

    #MARKER:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Triggers the FSM event "TextUpdate".

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + #string + Text +

    +
    +
    + +

    The new text.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Place marker visible for everyone.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + #number + Delay +

    +
    +
    + +

    (Optional) Delay in seconds, before the marker is created.

    + +
    +
    +

    Return value:

    +
    +
    +

    #MARKER:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Place marker visible for the blue coalition only.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + #number + Delay +

    +
    +
    + +

    (Optional) Delay in seconds, before the marker is created.

    + +
    +
    +

    Return value:

    +
    +
    +

    #MARKER:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Place marker visible for a specific coalition only.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameters:

    +
    +
    +

    + #number + Coalition +

    +
    +
    + +

    Coalition 1=Red, 2=Blue, 0=Neutral. See coaliton.side.RED.

    + +
    +
    +
    +
    +

    + #number + Delay +

    +
    +
    + +

    (Optional) Delay in seconds, before the marker is created.

    + +
    +
    +

    Return value:

    +
    +
    +

    #MARKER:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Place marker visible for a specific group only.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameters:

    +
    +
    +

    + Wrapper.Group#GROUP + Group +

    +
    +
    + +

    The group to which the marker is displayed.

    + +
    +
    +
    +
    +

    + #number + Delay +

    +
    +
    + +

    (Optional) Delay in seconds, before the marker is created.

    + +
    +
    +

    Return value:

    +
    +
    +

    #MARKER:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Place marker visible for the neutral coalition only.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + #number + Delay +

    +
    +
    + +

    (Optional) Delay in seconds, before the marker is created.

    + +
    +
    +

    Return value:

    +
    +
    +

    #MARKER:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Place marker visible for the blue coalition only.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + #number + Delay +

    +
    +
    + +

    (Optional) Delay in seconds, before the marker is created.

    + +
    +
    +

    Return value:

    +
    +
    +

    #MARKER:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Update the coordinate where the marker is displayed.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameters:

    +
    +
    +

    + Core.Point#COORDINATE + Coordinate +

    +
    +
    + +

    The new coordinate.

    + +
    +
    +
    +
    +

    + #number + Delay +

    +
    +
    + +

    (Optional) Delay in seconds, before the marker is created.

    + +
    +
    +

    Return value:

    +
    +
    +

    #MARKER:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Update the text displayed on the mark panel.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameters:

    +
    +
    +

    + #string + Text +

    +
    +
    + +

    Updated text.

    + +
    +
    +
    +
    +

    + #number + Delay +

    +
    +
    + +

    (Optional) Delay in seconds, before the marker is created.

    + +
    +
    +

    Return value:

    +
    +
    +

    #MARKER:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Triggers the delayed FSM event "Added".

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    Event data table.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Triggers the delayed FSM event "Changed".

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    Event data table.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Triggers the delayed FSM event "CoordUpdate".

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + Core.Point#COORDINATE + Coordinate +

    +
    +
    + +

    The updated Coordinate.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Triggers the delayed FSM event "Removed".

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    Event data table.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Triggers the delayed FSM event "TextUpdate".

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameter:

    +
    +
    +

    + #string + Text +

    +
    +
    + +

    The new text.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    On after "Added" event.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameters:

    +
    +
    +

    + #string + From +

    +
    +
    + +

    From state.

    + +
    +
    +
    +
    +

    + #string + Event +

    +
    +
    + +

    Event.

    + +
    +
    +
    +
    +

    + #string + To +

    +
    +
    + +

    To state.

    + +
    +
    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    Event data table.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    On after "Changed" event.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameters:

    +
    +
    +

    + #string + From +

    +
    +
    + +

    From state.

    + +
    +
    +
    +
    +

    + #string + Event +

    +
    +
    + +

    Event.

    + +
    +
    +
    +
    +

    + #string + To +

    +
    +
    + +

    To state.

    + +
    +
    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    Event data table.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    On after "CoordUpdate" event.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameters:

    +
    +
    +

    + #string + From +

    +
    +
    + +

    From state.

    + +
    +
    +
    +
    +

    + #string + Event +

    +
    +
    + +

    Event.

    + +
    +
    +
    +
    +

    + #string + To +

    +
    +
    + +

    To state.

    + +
    +
    +
    +
    +

    + Core.Point#COORDINATE + Coordinate +

    +
    +
    + +

    The updated coordinates.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    On after "Removed" event.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameters:

    +
    +
    +

    + #string + From +

    +
    +
    + +

    From state.

    + +
    +
    +
    +
    +

    + #string + Event +

    +
    +
    + +

    Event.

    + +
    +
    +
    +
    +

    + #string + To +

    +
    +
    + +

    To state.

    + +
    +
    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    Event data table.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    On after "TextUpdate" event.

    + +
    +
    +

    Defined in:

    +
    +

    MARKER

    +
    +

    Parameters:

    +
    +
    +

    + #string + From +

    +
    +
    + +

    From state.

    + +
    +
    +
    +
    +

    + #string + Event +

    +
    +
    + +

    Event.

    + +
    +
    +
    +
    +

    + #string + To +

    +
    +
    + +

    To state.

    + +
    +
    +
    +
    +

    + #string + Text +

    +
    +
    + +

    The updated text, displayed in the mark panel.

    + +
    +
    +
    + +
    +
    + +
    +

    Field(s)

    +
    +
    +
    + + #string +MARKER.ClassName + +

    Name of the class.

    + +
    + +
    +
    +
    + + #boolean +MARKER.Debug + +

    Debug mode. Messages to all about status.

    + +
    + +
    +
    +
    + + #number +MARKER.coalition + +

    Coalition to which the marker is displayed.

    + +
    + +
    +
    +
    + + Core.Point#COORDINATE +MARKER.coordinate + +

    Coordinate of the mark.

    + +
    + +
    +
    +
    + + #string +MARKER.lid + +

    Class id string for output to DCS log file.

    + +
    + +
    +
    +
    + + #string +MARKER.message + +

    Message dispayed when the mark is added.

    + +
    + +
    +
    +
    + + #number +MARKER.mid + +

    Marker ID.

    + +
    + +
    +
    +
    + + +MARKER.myid + + + +
    + +
    +
    +
    + + #boolean +MARKER.readonly + +

    Marker is read-only.

    + +
    + +
    +
    +
    + + #boolean +MARKER.shown + + + +
    + +
    +
    +
    + + #string +MARKER.text + +

    Text displayed in the mark panel.

    + +
    + +
    +
    +
    + + #boolean +MARKER.toall + + + +
    + +
    +
    +
    + + #boolean +MARKER.tocoaliton + + + +
    + +
    +
    +
    + + #boolean +MARKER.togroup + + + +
    + +
    +
    +
    + + #string +MARKER.version + +

    Marker class version.

    + +
    + +
    +
    +

    Function(s)

    +
    +
    + + + +

    Adds an End state.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + #string + State +

    +
    +
    + +

    The FSM state.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Set the default 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:

    + +

    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:

    +
    + +
    + +

    The SubFSM.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Adds a score for the FSM to be achieved.

    + +
    +
    +

    Defined in:

    + +

    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

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Adds a score for the FSM_PROCESS to be achieved.

    + +
    +
    +

    Defined in:

    + +

    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

    + +
    +
    +
    + +
    +
    + +
    + + + +

    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:

    + +

    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.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Get current state.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    #string:

    +
    +
    + +

    Current FSM state.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Returns the End states.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    #table:

    +
    +
    + +

    End states.

    + +
    +
    +
    + +
    +
    + +
    + + + + + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + From +

    +
    +
    +

    +
    +
    +
    +
    +

    + Event +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + + + +

    Returns a table of the SubFSM rules defined within the FSM.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    #table:

    +
    +
    + +

    Sub processes.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Returns a table with the scores defined.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + #table + Scores +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + + + +

    Returns the start state of the FSM.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    #string:

    +
    +
    + +

    A string containing the start state.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Get current state.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    #string:

    +
    +
    + +

    Current FSM state.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Returns a table with the Subs defined.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    #table:

    +
    +
    + +

    Sub processes.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Returns a table of the transition rules defined within the FSM.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    #table:

    +
    +
    + +

    Transitions.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Check if FSM is in state.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + #string + State +

    +
    +
    + +

    State name.

    + +
    +
    +
    +
    +

    + #boolean + If +

    +
    +
    + +

    true, FSM is in this state.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Load call backs.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + #table + CallBackTable +

    +
    +
    + +

    Table of call backs.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Creates a new FSM object.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    #FSM:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + + + + + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + From +

    +
    +
    +

    +
    +
    +
    +
    +

    + Event +

    +
    +
    +

    +
    +
    +
    +
    +

    + Fsm +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + + + +

    Sets the start state of the FSM.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + #string + State +

    +
    +
    + +

    A string defining the start state.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Add to map.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + #table + Map +

    +
    +
    + +

    Map.

    + +
    +
    +
    +
    +

    + #table + Event +

    +
    +
    + +

    Event table.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Call handler.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + #string + step +

    +
    +
    + +

    Step "onafter", "onbefore", "onenter", "onleave".

    + +
    +
    +
    +
    +

    + #string + trigger +

    +
    +
    + +

    Trigger.

    + +
    +
    +
    +
    +

    + #table + params +

    +
    +
    + +

    Parameters.

    + +
    +
    +
    +
    +

    + #string + EventName +

    +
    +
    + +

    Event name.

    + +
    +
    +

    Return value:

    +
    +
    +
    +
    + +

    Value.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Create transition.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + #string + EventName +

    +
    +
    + +

    Event name.

    + +
    +
    +

    Return value:

    +
    +
    +

    #function:

    +
    +
    + +

    Function.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Delayed transition.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + #string + EventName +

    +
    +
    + +

    Event name.

    + +
    +
    +

    Return value:

    +
    +
    +

    #function:

    +
    +
    + +

    Function.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Event map.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + #table + Events +

    +
    +
    + +

    Events.

    + +
    +
    +
    +
    +

    + #table + EventStructure +

    +
    +
    + +

    Event structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Go sub.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + #string + ParentFrom +

    +
    +
    + +

    Parent from state.

    + +
    +
    +
    +
    +

    + #string + ParentEvent +

    +
    +
    + +

    Parent event name.

    + +
    +
    +

    Return value:

    +
    +
    +

    #table:

    +
    +
    + +

    Subs.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Handler.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + #string + EventName +

    +
    +
    + +

    Event name.

    + +
    +
    +
    +
    +

    + ... +

    +
    +
    + +

    Arguments.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Is end state.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + #string + Current +

    +
    +
    + +

    Current state name.

    + +
    +
    +

    Return values:

    +
    +
    +

    #table:

    +
    +
    + +

    FSM parent.

    + +
    +
    +

    #string:

    +
    +
    + +

    Event name.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Sub maps.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + #table + subs +

    +
    +
    + +

    Subs.

    + +
    +
    +
    +
    +

    + #table + sub +

    +
    +
    + +

    Sub.

    + +
    +
    +
    +
    +

    + #string + name +

    +
    +
    + +

    Name.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Check if can do an event.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + #string + e +

    +
    +
    + +

    Event name.

    + +
    +
    +

    Return values:

    +
    +
    +

    #boolean:

    +
    +
    + +

    If true, FSM can do the event.

    + +
    +
    +

    #string:

    +
    +
    + +

    To state.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Check if cannot do an event.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + #string + e +

    +
    +
    + +

    Event name.

    + +
    +
    +

    Return value:

    +
    +
    +

    #boolean:

    +
    +
    + +

    If true, FSM cannot do the event.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Check if FSM is in state.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + #string + State +

    +
    +
    + +

    State name.

    + +
    +
    +
    +
    +

    + #boolean + If +

    +
    +
    + +

    true, FSM is in this state.

    + +
    +
    +
    +
    +

    + state +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    +

    Field(s)

    +
    +
    +
    + + #string +MARKER.ClassName + +

    Name of the class.

    + +
    + +
    +
    +
    + + #boolean +MARKER.Debug + +

    Debug mode. Messages to all about status.

    + +
    + +
    +
    +
    + + #number +MARKER.coalition + +

    Coalition to which the marker is displayed.

    + +
    + +
    +
    +
    + + Core.Point#COORDINATE +MARKER.coordinate + +

    Coordinate of the mark.

    + +
    + +
    +
    +
    + + #string +MARKER.lid + +

    Class id string for output to DCS log file.

    + +
    + +
    +
    +
    + + #string +MARKER.message + +

    Message dispayed when the mark is added.

    + +
    + +
    +
    +
    + + #number +MARKER.mid + +

    Marker ID.

    + +
    + +
    +
    +
    + + +MARKER.myid + + + +
    + +
    +
    +
    + + #boolean +MARKER.readonly + +

    Marker is read-only.

    + +
    + +
    +
    +
    + + #boolean +MARKER.shown + + + +
    + +
    +
    +
    + + #string +MARKER.text + +

    Text displayed in the mark panel.

    + +
    + +
    +
    +
    + + #boolean +MARKER.toall + + + +
    + +
    +
    +
    + + #boolean +MARKER.tocoaliton + + + +
    + +
    +
    +
    + + #boolean +MARKER.togroup + + + +
    + +
    +
    +
    + + #string +MARKER.version + +

    Marker class version.

    + +
    + +
    +
    +

    Function(s)

    +
    +
    + + + +

    Clear the state of an object.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + Object +

    +
    +
    + +

    The object that holds the Value set by the Key.

    + +
    +
    +
    +
    +

    + StateName +

    +
    +
    + +

    The key that is should be cleared.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Creation of a Birth Event.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + DCS#Time + EventTime +

    +
    +
    + +

    The time stamp of the event.

    + +
    +
    +
    +
    +

    + DCS#Object + Initiator +

    +
    +
    + +

    The initiating object of the event.

    + +
    +
    +
    +
    +

    + #string + IniUnitName +

    +
    +
    + +

    The initiating unit name.

    + +
    +
    +
    +
    +

    + place +

    +
    +
    +

    +
    +
    +
    +
    +

    + subplace +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + + + +

    Creation of a Crash Event.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + DCS#Time + EventTime +

    +
    +
    + +

    The time stamp of the event.

    + +
    +
    +
    +
    +

    + DCS#Object + Initiator +

    +
    +
    + +

    The initiating object of the event.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Creation of a Dead Event.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + DCS#Time + EventTime +

    +
    +
    + +

    The time stamp of the event.

    + +
    +
    +
    +
    +

    + DCS#Object + Initiator +

    +
    +
    + +

    The initiating object of the event.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Creation of a Remove Unit Event.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + DCS#Time + EventTime +

    +
    +
    + +

    The time stamp of the event.

    + +
    +
    +
    +
    +

    + DCS#Object + Initiator +

    +
    +
    + +

    The initiating object of the event.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Creation of a Takeoff Event.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + DCS#Time + EventTime +

    +
    +
    + +

    The time stamp of the event.

    + +
    +
    +
    +
    +

    + DCS#Object + Initiator +

    +
    +
    + +

    The initiating object of the event.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Log an exception which will be traced always.

    + + +

    Can be anywhere within the function logic.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Returns the event dispatcher

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    + +
    + + + +
    +
    +
    + +
    +
    + +
    + + + +

    Remove all subscribed events

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    #BASE:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + + + +

    Trace a function call.

    + + +

    Must be at the beginning of the function logic.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Trace a function call level 2.

    + + +

    Must be at the beginning of the function logic.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Trace a function call level 3.

    + + +

    Must be at the beginning of the function logic.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Get the ClassID of the class instance.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    #string:

    +
    +
    + +

    The ClassID of the class instance.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Get the ClassName of the class instance.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    #string:

    +
    +
    + +

    The ClassName of the class instance.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Get the ClassName + ClassID of the class instance.

    + + +

    The ClassName + ClassID is formatted as '%s#%09d'.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    #string:

    +
    +
    + +

    The ClassName + ClassID of the class instance.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Get the Class Event processing Priority.

    + + +

    The Event processing Priority is a number from 1 to 10, +reflecting the order of the classes subscribed to the Event to be processed.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    #number:

    +
    +
    + +

    The Event processing Priority.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    This is the worker method to retrieve the Parent class.

    + + +

    Note that the Parent class must be passed to call the parent class method.

    + +
    self:GetParent(self):ParentMethod()
    +
    +
    +
    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + #BASE + Child +

    +
    +
    + +

    This is the Child class from which the Parent class needs to be retrieved.

    + +
    +
    +
    +
    +

    + #BASE + FromClass +

    +
    +
    + +

    (Optional) The class from which to get the parent.

    + +
    +
    +

    Return value:

    +
    +
    +

    #BASE:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + + + +

    Get a Value given a Key from the Object.

    + + +

    Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + Object +

    +
    +
    + +

    The object that holds the Value set by the Key.

    + +
    +
    +
    +
    +

    + Key +

    +
    +
    + +

    The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

    + +
    +
    +

    Return value:

    +
    +
    +
    +
    + +

    The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Subscribe to a DCS Event.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + Core.Event#EVENTS + Event +

    +
    +
    +

    +
    +
    +
    +
    +

    + #function + EventFunction +

    +
    +
    + +

    (optional) The function to be called when the event occurs for the unit.

    + +
    +
    +

    Return value:

    +
    +
    +

    #BASE:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + + + +

    Log an information which will be traced always.

    + + +

    Can be anywhere within the function logic.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    This is the worker method to inherit from a parent class.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + Child +

    +
    +
    + +

    is the Child class that inherits.

    + +
    +
    +
    +
    +

    + #BASE + Parent +

    +
    +
    + +

    is the Parent class that the Child inherits from.

    + +
    +
    +

    Return value:

    +
    +
    +

    #BASE:

    +
    +
    + +

    Child

    + +
    +
    +
    + +
    +
    + +
    + + + +

    This is the worker method to check if an object is an (sub)instance of a class.

    + + + +

    Examples:

    + +
      +
    • ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true

    • +
    • ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true

    • +
    • ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true

    • +
    • ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true

    • +
    • ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

    • +
    + + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + ClassName +

    +
    +
    + +

    is the name of the class or the class itself to run the check against

    + +
    +
    +

    Return value:

    +
    +
    +

    #boolean:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + + + +

    Enquires if tracing is on (for the class).

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    #boolean:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + + + +

    BASE constructor.

    + + + +

    This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.

    + +
    function EVENT:New()
    +  local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
    +  return self
    +end
    +  
    +
    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    #BASE:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when an object is completely destroyed.

    + + +

    initiator : The unit that is was destroyed.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when a ground unit captures either an airbase or a farp.

    + + +

    initiator : The unit that captured the base +place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when any object is spawned into the mission.

    + + +

    initiator : The unit that was spawned

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when any aircraft crashes into the ground and is completely destroyed.

    + + +

    initiator : The unit that has crashed

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when an object is dead.

    + + +

    initiator : The unit that is dead.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Unknown precisely what creates this event, likely tied into newer damage model.

    + + +

    Will update this page when new information become available.

    + +
      +
    • initiator: The unit that had the failure.
    • +
    + + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when a pilot ejects from an aircraft +initiator : The unit that has ejected

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when any aircraft shuts down its engines.

    + + +

    initiator : The unit that is stopping its engines.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when any aircraft starts its engines.

    + + +

    initiator : The unit that is starting its engines.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs whenever an object is hit by a weapon.

    + + +

    initiator : The unit object the fired the weapon +weapon: Weapon object that hit the target +target: The Object that was hit.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when any system fails on a human controlled aircraft.

    + + +

    initiator : The unit that had the failure

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs on the death of a unit.

    + + +

    Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs.

    + +
      +
    • initiator: The unit that killed the target
    • +
    • target: Target Object
    • +
    • weapon: Weapon Object
    • +
    + + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when an aircraft lands at an airbase, farp or ship +initiator : The unit that has landed +place: Object that the unit landed on.

    + + +

    Can be an Airbase Object, FARP, or Ships

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

    + + +

    Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker.

    + +
      +
    • initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
    • +
    • place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
    • +
    • subplace: is always 0 for unknown reasons.
    • +
    + + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when a new mark was added.

    + + +

    MarkID: ID of the mark.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when a mark text was changed.

    + + +

    MarkID: ID of the mark.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when a mark was removed.

    + + +

    MarkID: ID of the mark.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when a mission ends

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when a mission starts

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when the pilot of an aircraft is killed.

    + + +

    Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. +initiator : The unit that the pilot has died in.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when any player assumes direct control of a unit.

    + + +

    initiator : The unit that is being taken control of.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when any player relieves control of a unit to the AI.

    + + +

    initiator : The unit that the player left.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when an aircraft connects with a tanker and begins taking on fuel.

    + + +

    initiator : The unit that is receiving fuel.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when an aircraft is finished taking fuel.

    + + +

    initiator : The unit that was receiving fuel.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when any modification to the "Score" as seen on the debrief menu would occur.

    + + +

    There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when any unit stops firing its weapon.

    + + +

    Event will always correspond with a shooting start event. +initiator : The unit that was doing the shooting.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when any unit begins firing a weapon that has a high rate of fire.

    + + +

    Most common with aircraft cannons (GAU-8), autocannons, and machine guns. +initiator : The unit that is doing the shooting. +target: The unit that is being targeted.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs whenever any unit in a mission fires a weapon.

    + + +

    But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when an aircraft takes off from an airbase, farp, or ship.

    + + +

    initiator : The unit that tookoff +place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Occurs when the game thinks an object is destroyed.

    + + + +
      +
    • initiator: The unit that is was destroyed.
    • +
    + + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Schedule a new time event.

    + + +

    Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + #number + Start +

    +
    +
    + +

    Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

    + +
    +
    +
    +
    +

    + #function + SchedulerFunction +

    +
    +
    + +

    The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

    + +
    +
    +
    +
    +

    + #table + ... +

    +
    +
    + +

    Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

    + +
    +
    +

    Return value:

    +
    +
    +

    #number:

    +
    +
    + +

    The ScheduleID of the planned schedule.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Schedule a new time event.

    + + +

    Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + #number + Start +

    +
    +
    + +

    Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

    + +
    +
    +
    +
    +

    + #number + Repeat +

    +
    +
    + +

    Specifies the interval in seconds when the scheduler will call the event function.

    + +
    +
    +
    +
    +

    + #number + RandomizeFactor +

    +
    +
    + +

    Specifies a randomization factor between 0 and 1 to randomize the Repeat.

    + +
    +
    +
    +
    +

    + #number + Stop +

    +
    +
    + +

    Specifies the amount of seconds when the scheduler will be stopped.

    + +
    +
    +
    +
    +

    + #function + SchedulerFunction +

    +
    +
    + +

    The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

    + +
    +
    +
    +
    +

    + #table + ... +

    +
    +
    + +

    Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

    + +
    +
    +

    Return value:

    +
    +
    +

    #number:

    +
    +
    + +

    The ScheduleID of the planned schedule.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Stops the Schedule.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + #function + SchedulerFunction +

    +
    +
    + +

    The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Set the Class Event processing Priority.

    + + +

    The Event processing Priority is a number from 1 to 10, +reflecting the order of the classes subscribed to the Event to be processed.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + #number + EventPriority +

    +
    +
    + +

    The Event processing Priority.

    + +
    +
    +

    Return value:

    +
    +
    +

    #BASE:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Set a state or property of the Object given a Key and a Value.

    + + +

    Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + Object +

    +
    +
    + +

    The object that will hold the Value set by the Key.

    + +
    +
    +
    +
    +

    + Key +

    +
    +
    + +

    The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

    + +
    +
    +
    +
    +

    + Value +

    +
    +
    + +

    The value to is stored in the object.

    + +
    +
    +

    Return value:

    +
    +
    +
    +
    + +

    The Value set.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Trace a function logic level 1.

    + + +

    Can be anywhere within the function logic.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Trace a function logic level 2.

    + + +

    Can be anywhere within the function logic.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Trace a function logic level 3.

    + + +

    Can be anywhere within the function logic.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Trace all methods in MOOSE

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + #boolean + TraceAll +

    +
    +
    + +

    true = trace all methods in MOOSE.

    + +
    +
    +
    + +
    +
    + +
    + + + +

    Set tracing for a class

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + #string + Class +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + + + +

    Set tracing for a specific method of class

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + #string + Class +

    +
    +
    +

    +
    +
    +
    +
    +

    + #string + Method +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + + + +

    Set trace level

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + #number + Level +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + + + +

    Set trace off.

    + +
    +
    +

    Defined in:

    + +

    Usage:

    +
    -- Switch the tracing Off
    +BASE:TraceOff()
    + +
    + +
    +
    + +
    + + + +

    Set trace on.

    + +
    +
    +

    Defined in:

    + +

    Usage:

    +
    -- Switch the tracing On
    +BASE:TraceOn()
    + +
    + +
    +
    + +
    + + + +

    Set trace on or off +Note that when trace is off, no BASE.Debug statement is performed, increasing performance! +When Moose is loaded statically, (as one file), tracing is switched off by default.

    + + +

    So tracing must be switched on manually in your mission if you are using Moose statically. +When moose is loading dynamically (for moose class development), tracing is switched on by default.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + #boolean + TraceOnOff +

    +
    +
    + +

    Switch the tracing on or off.

    + +
    +
    +

    Usage:

    +
    -- Switch the tracing On
    +BASE:TraceOnOff( true )
    +
    +-- Switch the tracing Off
    +BASE:TraceOnOff( false )
    + +
    + +
    +
    + +
    + + + +

    UnSubscribe to a DCS event.

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTS + Event +

    +
    +
    +

    +
    +
    +

    Return value:

    +
    +
    +

    #BASE:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + + + +

    Trace a function call.

    + + +

    This function is private.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    +
    +

    + DebugInfoCurrentParam +

    +
    +
    +

    +
    +
    +
    +
    +

    + DebugInfoFromParam +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + + + +

    Trace a function logic.

    + +
    +
    +

    Defined in:

    + +

    Parameters:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    +
    +

    + DebugInfoCurrentParam +

    +
    +
    +

    +
    +
    +
    +
    +

    + DebugInfoFromParam +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + + + + + + +

    TODO: Complete DCS#Event structure.
    +- The main event handling function... This function captures all events generated for the class. + @param #BASE self + @param DCS#Event event

    + +
    +
    +

    Defined in:

    + +

    Parameter:

    +
    +
    +

    + event +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + +
    +
    + + +
    + + + + diff --git a/Documentation/Wrapper.Object.html b/Documentation/Wrapper.Object.html index f7c116312..82038dcb5 100644 --- a/Documentation/Wrapper.Object.html +++ b/Documentation/Wrapper.Object.html @@ -664,6 +664,17 @@

    Core - Management of spotting logistics, that can be activated and deactivated upon command.

    +

    + + +
    +
    +
    + Image + +
    +

    +

    Core - Timer scheduler.

    @@ -1173,6 +1184,17 @@

    Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

    +

    + + +
    +
    + +

    +

    Utils - Lua Profiler.

    @@ -1239,6 +1261,17 @@

    Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

    +

    + + +
    +
    + +

    +

    Wrapper - Markers On the F10 map.

    diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index c04dacc55..5ddbcd3f1 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -664,6 +664,17 @@

    Core - Management of spotting logistics, that can be activated and deactivated upon command.

    +

    + + +
    +
    +
    + Image + +
    +

    +

    Core - Timer scheduler.

    @@ -1173,6 +1184,17 @@

    Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

    +

    + + +
    +
    + +

    +

    Utils - Lua Profiler.

    @@ -1239,6 +1261,17 @@

    Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

    +

    + + +
    +
    + +

    +

    Wrapper - Markers On the F10 map.

    @@ -1515,12 +1548,24 @@ The method POSITIONABLE.GetVelocity()

    POSITIONABLE:GetClimbAngle()

    Returns the unit's climb or descent angle.

    + + + +

    POSITIONABLE:GetCoord()

    + +

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    POSITIONABLE:GetCoordinate()

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    + + + +

    POSITIONABLE:GetDCSObject()

    + +

    Returns the DCS object.

    @@ -1923,6 +1968,18 @@ The method POSITIONABLE.GetVelocity()

    POSITIONABLE.__

    + + + +

    POSITIONABLE.coordinate

    + +

    Coordinate object.

    + + + +

    POSITIONABLE.pointvec3

    + +

    Point Vec3 object.

    @@ -3252,6 +3309,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
    +
    + + Core.Point#COORDINATE +POSITIONABLE.coordinate + +

    Coordinate object.

    + +
    + +
    +
    +
    + + Core.Point#POINT_VEC3 +POSITIONABLE.pointvec3 + +

    Point Vec3 object.

    +
    @@ -3785,6 +3864,36 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction. + + + +
    + + + +

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    + +
    +
    +

    Defined in:

    +
    +

    POSITIONABLE

    +
    +

    Return value:

    +
    + +
    + +

    The COORDINATE of the POSITIONABLE.

    + +
    +
    +
    +
    @@ -3815,6 +3924,39 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction. + + + +
    + + + +

    Returns the DCS object.

    + + +

    Polymorphic for other classes like UNIT, STATIC, GROUP, AIRBASE.

    + +
    +
    +

    Defined in:

    +
    +

    POSITIONABLE

    +
    +

    Return value:

    +
    +
    +

    DCS#Object:

    +
    +
    + +

    The DCS object.

    + +
    +
    +
    +
    @@ -4521,7 +4663,7 @@ Coordinates are dependent on the position of the maps origin.

    Return value:

    @@ -4796,24 +4938,16 @@ Coordinates are dependent on the position of the maps origin.

    POSITIONABLE

    -

    Return values:

    +

    Return value:

    -
    -

    DCS#Vec2:

    -
    -
    - -

    The 2D point vector of the POSITIONABLE.

    +
    +

    DCS#Vec2:

    +
    +
    + +

    The 2D point vector of the POSITIONABLE or #nil if it is not existing or alive.

    -
    -
    -

    #nil:

    -
    -
    - -

    The POSITIONABLE is not existing or alive.

    - -
    +
    @@ -4834,24 +4968,16 @@ Coordinates are dependent on the position of the maps origin.

    POSITIONABLE

    -

    Return values:

    +

    Return value:

    -
    -

    DCS#Vec3:

    -
    -
    - -

    The 3D point vector of the POSITIONABLE.

    +
    +

    DCS#Vec3:

    +
    +
    + +

    The 3D point vector of the POSITIONABLE or nil if it is not existing or alive.

    -
    -
    -

    #nil:

    -
    -
    - -

    The POSITIONABLE is not existing or alive.

    - -
    +
    @@ -6590,6 +6716,28 @@ Coordinates are dependent on the position of the maps origin.

    + + + +
    +
    + + Core.Point#COORDINATE +POSITIONABLE.coordinate + +

    Coordinate object.

    + +
    + +
    +
    +
    + + Core.Point#POINT_VEC3 +POSITIONABLE.pointvec3 + +

    Point Vec3 object.

    +
    @@ -7156,6 +7304,28 @@ If the Identifiable is alive, true is returned.

    + + + +
    +
    + + Core.Point#COORDINATE +POSITIONABLE.coordinate + +

    Coordinate object.

    + +
    + +
    +
    +
    + + Core.Point#POINT_VEC3 +POSITIONABLE.pointvec3 + +

    Point Vec3 object.

    +
    @@ -7328,6 +7498,28 @@ If the Identifiable is alive, true is returned.

    + + + +
    +
    + + Core.Point#COORDINATE +POSITIONABLE.coordinate + +

    Coordinate object.

    + +
    + +
    +
    +
    + + Core.Point#POINT_VEC3 +POSITIONABLE.pointvec3 + +

    Point Vec3 object.

    +
    diff --git a/Documentation/Wrapper.Scenery.html b/Documentation/Wrapper.Scenery.html index a81be3423..1656f1c0f 100644 --- a/Documentation/Wrapper.Scenery.html +++ b/Documentation/Wrapper.Scenery.html @@ -664,6 +664,17 @@

    Core - Management of spotting logistics, that can be activated and deactivated upon command.

    +

    + + +
    +
    +
    + Image + +
    +

    +

    Core - Timer scheduler.

    @@ -1173,6 +1184,17 @@

    Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

    +

    + + +
    +
    + +

    +

    Utils - Lua Profiler.

    @@ -1239,6 +1261,17 @@

    Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

    +

    + + +
    +
    + +

    +

    Wrapper - Markers On the F10 map.

    @@ -1506,12 +1539,24 @@

    SCENERY:GetClimbAngle()

    Returns the unit's climb or descent angle.

    + + + +

    SCENERY:GetCoord()

    + +

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    SCENERY:GetCoordinate()

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    + + + +

    SCENERY:GetDCSObject()

    + +

    Returns the DCS object.

    @@ -1914,6 +1959,18 @@

    SCENERY.__

    + + + +

    SCENERY.coordinate

    + +

    Coordinate object.

    + + + +

    SCENERY.pointvec3

    + +

    Point Vec3 object.

    @@ -3209,6 +3266,36 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction. + + + +
    + + + +

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    + +
    + +

    The COORDINATE of the POSITIONABLE.

    + +
    +
    +
    +
    @@ -3239,6 +3326,39 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction. + + + +
    + + + +

    Returns the DCS object.

    + + +

    Polymorphic for other classes like UNIT, STATIC, GROUP, AIRBASE.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    DCS#Object:

    +
    +
    + +

    The DCS object.

    + +
    +
    +
    +
    @@ -3945,7 +4065,7 @@ Coordinates are dependent on the position of the maps origin.

    Return value:

    @@ -4220,24 +4340,16 @@ Coordinates are dependent on the position of the maps origin.

    -

    Return values:

    +

    Return value:

    -
    -

    DCS#Vec2:

    -
    -
    - -

    The 2D point vector of the POSITIONABLE.

    +
    +

    DCS#Vec2:

    +
    +
    + +

    The 2D point vector of the POSITIONABLE or #nil if it is not existing or alive.

    -
    -
    -

    #nil:

    -
    -
    - -

    The POSITIONABLE is not existing or alive.

    - -
    +
    @@ -4258,24 +4370,16 @@ Coordinates are dependent on the position of the maps origin.

    -

    Return values:

    +

    Return value:

    -
    -

    DCS#Vec3:

    -
    -
    - -

    The 3D point vector of the POSITIONABLE.

    +
    +

    DCS#Vec3:

    +
    +
    + +

    The 3D point vector of the POSITIONABLE or nil if it is not existing or alive.

    -
    -
    -

    #nil:

    -
    -
    - -

    The POSITIONABLE is not existing or alive.

    - -
    +
    diff --git a/Documentation/Wrapper.Static.html b/Documentation/Wrapper.Static.html index 6bb48bccb..c654d566a 100644 --- a/Documentation/Wrapper.Static.html +++ b/Documentation/Wrapper.Static.html @@ -664,6 +664,17 @@

    Core - Management of spotting logistics, that can be activated and deactivated upon command.

    +

    + + +
    +
    +
    + Image + +
    +

    +

    Core - Timer scheduler.

    @@ -1173,6 +1184,17 @@

    Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

    +

    + + +
    +
    + +

    +

    Utils - Lua Profiler.

    @@ -1239,6 +1261,17 @@

    Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

    +

    + + +
    +
    + +

    +

    Wrapper - Markers On the F10 map.

    @@ -1575,12 +1608,24 @@ If the DCS Static object does not exist or is nil, the STATIC methods will retur

    STATIC:GetClimbAngle()

    Returns the unit's climb or descent angle.

    + + + +

    STATIC:GetCoord()

    + +

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    STATIC:GetCoordinate()

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    + + + +

    STATIC:GetDCSObject()

    + +

    Returns the DCS object.

    @@ -1983,6 +2028,18 @@ If the DCS Static object does not exist or is nil, the STATIC methods will retur

    STATIC.__

    + + + +

    STATIC.coordinate

    + +

    Coordinate object.

    + + + +

    STATIC.pointvec3

    + +

    Point Vec3 object.

    @@ -3657,6 +3714,36 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction. + + + +
    + + + +

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    + +
    + +

    The COORDINATE of the POSITIONABLE.

    + +
    +
    +
    +
    @@ -3687,6 +3774,39 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction. + + + +
    + + + +

    Returns the DCS object.

    + + +

    Polymorphic for other classes like UNIT, STATIC, GROUP, AIRBASE.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    DCS#Object:

    +
    +
    + +

    The DCS object.

    + +
    +
    +
    +
    @@ -4393,7 +4513,7 @@ Coordinates are dependent on the position of the maps origin.

    Return value:

    @@ -4668,24 +4788,16 @@ Coordinates are dependent on the position of the maps origin.

    -

    Return values:

    +

    Return value:

    -
    -

    DCS#Vec2:

    -
    -
    - -

    The 2D point vector of the POSITIONABLE.

    +
    +

    DCS#Vec2:

    +
    +
    + +

    The 2D point vector of the POSITIONABLE or #nil if it is not existing or alive.

    -
    -
    -

    #nil:

    -
    -
    - -

    The POSITIONABLE is not existing or alive.

    - -
    +
    @@ -4706,24 +4818,16 @@ Coordinates are dependent on the position of the maps origin.

    -

    Return values:

    +

    Return value:

    -
    -

    DCS#Vec3:

    -
    -
    - -

    The 3D point vector of the POSITIONABLE.

    +
    +

    DCS#Vec3:

    +
    +
    + +

    The 3D point vector of the POSITIONABLE or nil if it is not existing or alive.

    -
    -
    -

    #nil:

    -
    -
    - -

    The POSITIONABLE is not existing or alive.

    - -
    +
    diff --git a/Documentation/Wrapper.Unit.html b/Documentation/Wrapper.Unit.html index 71da25e65..8c3d360ff 100644 --- a/Documentation/Wrapper.Unit.html +++ b/Documentation/Wrapper.Unit.html @@ -664,6 +664,17 @@

    Core - Management of spotting logistics, that can be activated and deactivated upon command.

    +

    + + +
    +
    +
    + Image + +
    +

    +

    Core - Timer scheduler.

    @@ -1173,6 +1184,17 @@

    Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

    +

    + + +
    +
    + +

    +

    Utils - Lua Profiler.

    @@ -1239,6 +1261,17 @@

    Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

    +

    + + +
    +
    + +

    +

    Wrapper - Markers On the F10 map.

    @@ -2666,12 +2699,24 @@ If you want to obtain the complete 3D position including ori�

    UNIT:GetClimbAngle()

    Returns the unit's climb or descent angle.

    + + + +

    UNIT:GetCoord()

    + +

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    UNIT:GetCoordinate()

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    + + + +

    UNIT:GetDCSObject()

    + +

    Returns the DCS object.

    @@ -3074,6 +3119,18 @@ If you want to obtain the complete 3D position including ori�

    UNIT.__

    + + + +

    UNIT.coordinate

    + +

    Coordinate object.

    + + + +

    UNIT.pointvec3

    + +

    Point Vec3 object.

    @@ -7738,24 +7795,16 @@ If at least one detection method is specified, only the methods -

    Return values:

    +

    Return value:

    -
    -

    #number:

    -
    -
    - -

    The controllable health value (unit or group average).

    +
    +

    #number:

    +
    +
    + +

    The controllable health value (unit or group average) or nil if the controllable does not exist.

    -
    -
    -

    #nil:

    -
    -
    - -

    The controllable is not existing or alive.

    - -
    +
    @@ -12240,7 +12289,7 @@ If the task is assigned to the controllable lead unit will be a FAC.

    -

    Frequency used to communicate with the FAC.

    +

    Frequency in MHz used to communicate with the FAC. Default 133 MHz.

    @@ -12253,7 +12302,7 @@ If the task is assigned to the controllable lead unit will be a FAC.

    -

    Modulation of radio for communication.

    +

    Modulation of radio for communication. Default 0=AM.

    @@ -14419,6 +14468,36 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction. + + + +
    + + + +

    Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    + +
    + +

    The COORDINATE of the POSITIONABLE.

    + +
    +
    +
    +
    @@ -14449,6 +14528,39 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction. + + + +
    + + + +

    Returns the DCS object.

    + + +

    Polymorphic for other classes like UNIT, STATIC, GROUP, AIRBASE.

    + +
    +
    +

    Defined in:

    + +

    Return value:

    +
    +
    +

    DCS#Object:

    +
    +
    + +

    The DCS object.

    + +
    +
    +
    +
    @@ -15155,7 +15267,7 @@ Coordinates are dependent on the position of the maps origin.

    Return value:

    @@ -15430,24 +15542,16 @@ Coordinates are dependent on the position of the maps origin.

    -

    Return values:

    +

    Return value:

    -
    -

    DCS#Vec2:

    -
    -
    - -

    The 2D point vector of the POSITIONABLE.

    +
    +

    DCS#Vec2:

    +
    +
    + +

    The 2D point vector of the POSITIONABLE or #nil if it is not existing or alive.

    -
    -
    -

    #nil:

    -
    -
    - -

    The POSITIONABLE is not existing or alive.

    - -
    +
    @@ -15468,24 +15572,16 @@ Coordinates are dependent on the position of the maps origin.

    -

    Return values:

    +

    Return value:

    -
    -

    DCS#Vec3:

    -
    -
    - -

    The 3D point vector of the POSITIONABLE.

    +
    +

    DCS#Vec3:

    +
    +
    + +

    The 3D point vector of the POSITIONABLE or nil if it is not existing or alive.

    -
    -
    -

    #nil:

    -
    -
    - -

    The POSITIONABLE is not existing or alive.

    - -
    +
    diff --git a/Documentation/index.html b/Documentation/index.html index 0e1dbd97f..c026aab87 100644 --- a/Documentation/index.html +++ b/Documentation/index.html @@ -664,6 +664,17 @@

    Core - Management of spotting logistics, that can be activated and deactivated upon command.

    +

    + + +
    +
    +
    + Image + +
    +

    +

    Core - Timer scheduler.

    @@ -1173,6 +1184,17 @@

    Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

    +

    + + +
    +
    + +

    +

    Utils - Lua Profiler.

    @@ -1239,6 +1261,17 @@

    Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

    +

    + + +
    +
    + +

    +

    Wrapper - Markers On the F10 map.

    @@ -2008,6 +2041,18 @@

    Core - Management of spotting logistics, that can be activated and deactivated upon command.

    +

    + + + +
    +
    + Image +
    +
    + +

    +

    Core - Timer scheduler.

    @@ -2563,6 +2608,18 @@

    Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

    +

    + + + +
    +
    + Image +
    +
    + +

    +

    Utils - Lua Profiler.

    @@ -2635,6 +2692,18 @@

    Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

    +

    + + + +
    +
    + Image +
    +
    + +

    +

    Wrapper - Markers On the F10 map.

    diff --git a/Documentation/routines.html b/Documentation/routines.html index 9bc4d9603..bd30e87c8 100644 --- a/Documentation/routines.html +++ b/Documentation/routines.html @@ -664,6 +664,17 @@

    Core - Management of spotting logistics, that can be activated and deactivated upon command.

    +

    + + +
    +
    +
    + Image + +
    +

    +

    Core - Timer scheduler.

    @@ -1173,6 +1184,17 @@

    Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.

    +

    + + +
    +
    + +

    +

    Utils - Lua Profiler.

    @@ -1239,6 +1261,17 @@

    Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.

    +

    + + +
    +
    + +

    +

    Wrapper - Markers On the F10 map.