diff --git a/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua b/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua index 588a6c32a..14ee3a766 100644 --- a/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua +++ b/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua @@ -1,23 +1,34 @@ ---- **Functional (wIP)** -- Models the process to capture a Zone for a Coalition, which is guarded by another Coalition. +--- **Functional** -- (WIP R2.3) Models the process to capture a Zone for a Coalition, which is guarded by another Coalition. -- -- ==== -- +-- ![Banner Image](..\Presentations\ZONE_CAPTURE_COALITION\Dia1.JPG) +-- +-- === +-- +-- ### Contributions: **Millertime**: Concept -- ### Author: **Sven Van de Velde (FlightControl)** -- -- ==== -- -- @module ZoneCaptureCoalition -do -- ZoneGoal +do -- ZONE_CAPTURE_COALITION --- @type ZONE_CAPTURE_COALITION -- @extends Functional.ZoneGoalCoalition#ZONE_GOAL_COALITION - --- # ZONE_CAPTURE_COALITION class, extends @{ZoneGoalCoalition#ZONE_GOAL_COALITION} + --- # ZONE\_CAPTURE\_COALITION class, extends @{ZoneGoalCoalition#ZONE_GOAL_COALITION} -- -- Models the process to capture a Zone for a Coalition, which is guarded by another Coalition. -- + -- --- + -- + -- ![Banner Image](..\Presentations\ZONE_CAPTURE_COALITION\Dia1.JPG) + -- + -- --- + -- -- The Zone is initially **Guarded** by the __owning coalition__, which is the coalition that initially occupies the zone with units of its coalition. -- Once units of an other coalition are entering the Zone, the state will change to **Attacked**. As long as these units remain in the zone, the state keeps set to Attacked. -- When all units are destroyed in the Zone, the state will change to **Empty**, which expresses that the Zone is empty, and can be captured. @@ -25,20 +36,20 @@ do -- ZoneGoal -- -- Event handlers can be defined by the mission designer to action on the state transitions. -- - -- ## 1. ZONE_CAPTURE_COALITION constructor + -- ## 1. ZONE\_CAPTURE\_COALITION constructor -- - -- * @{#ZONE_CAPTURE_COALITION.New}(): Creates a new ZONE_CAPTURE_COALITION object. + -- * @{#ZONE_CAPTURE_COALITION.New}(): Creates a new ZONE\_CAPTURE\_COALITION object. -- - -- ## 2. ZONE_CAPTURE_COALITION is a finite state machine (FSM). + -- ## 2. ZONE\_CAPTURE\_COALITION is a finite state machine (FSM). -- - -- ### 2.1 ZONE_CAPTURE_COALITION States + -- ### 2.1 ZONE\_CAPTURE\_COALITION States -- -- * **Captured**: The Zone has been captured by an other coalition. -- * **Attacked**: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone. -- * **Guarded**: The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone. -- * **Empty**: The Zone is empty. There is not valid unit in the Zone. -- - -- ### 2.2 ZONE_CAPTURE_COALITION Events + -- ### 2.2 ZONE\_CAPTURE\_COALITION Events -- -- * **Capture**: The Zone has been captured by an other coalition. -- * **Attack**: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone. @@ -73,7 +84,7 @@ do -- ZoneGoal do - --- Captured State Handler OnLeave for ZONE_CAPTURE_COALITION + --- Captured State Handler OnLeave for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] OnLeaveCaptured -- @param #ZONE_CAPTURE_COALITION self -- @param #string From @@ -81,7 +92,7 @@ do -- ZoneGoal -- @param #string To -- @return #boolean - --- Captured State Handler OnEnter for ZONE_CAPTURE_COALITION + --- Captured State Handler OnEnter for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] OnEnterCaptured -- @param #ZONE_CAPTURE_COALITION self -- @param #string From @@ -93,7 +104,7 @@ do -- ZoneGoal do - --- Attacked State Handler OnLeave for ZONE_CAPTURE_COALITION + --- Attacked State Handler OnLeave for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] OnLeaveAttacked -- @param #ZONE_CAPTURE_COALITION self -- @param #string From @@ -101,7 +112,7 @@ do -- ZoneGoal -- @param #string To -- @return #boolean - --- Attacked State Handler OnEnter for ZONE_CAPTURE_COALITION + --- Attacked State Handler OnEnter for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] OnEnterAttacked -- @param #ZONE_CAPTURE_COALITION self -- @param #string From @@ -112,7 +123,7 @@ do -- ZoneGoal do - --- Guarded State Handler OnLeave for ZONE_CAPTURE_COALITION + --- Guarded State Handler OnLeave for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] OnLeaveGuarded -- @param #ZONE_CAPTURE_COALITION self -- @param #string From @@ -120,7 +131,7 @@ do -- ZoneGoal -- @param #string To -- @return #boolean - --- Guarded State Handler OnEnter for ZONE_CAPTURE_COALITION + --- Guarded State Handler OnEnter for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] OnEnterGuarded -- @param #ZONE_CAPTURE_COALITION self -- @param #string From @@ -132,7 +143,7 @@ do -- ZoneGoal do - --- Empty State Handler OnLeave for ZONE_CAPTURE_COALITION + --- Empty State Handler OnLeave for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] OnLeaveEmpty -- @param #ZONE_CAPTURE_COALITION self -- @param #string From @@ -140,7 +151,7 @@ do -- ZoneGoal -- @param #string To -- @return #boolean - --- Empty State Handler OnEnter for ZONE_CAPTURE_COALITION + --- Empty State Handler OnEnter for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] OnEnterEmpty -- @param #ZONE_CAPTURE_COALITION self -- @param #string From @@ -151,7 +162,7 @@ do -- ZoneGoal self:AddTransition( "*", "Guard", "Guarded" ) - --- Guard Handler OnBefore for ZONE_CAPTURE_COALITION + --- Guard Handler OnBefore for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] OnBeforeGuard -- @param #ZONE_CAPTURE_COALITION self -- @param #string From @@ -159,25 +170,25 @@ do -- ZoneGoal -- @param #string To -- @return #boolean - --- Guard Handler OnAfter for ZONE_CAPTURE_COALITION + --- Guard Handler OnAfter for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] OnAfterGuard -- @param #ZONE_CAPTURE_COALITION self -- @param #string From -- @param #string Event -- @param #string To - --- Guard Trigger for ZONE_CAPTURE_COALITION + --- Guard Trigger for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] Guard -- @param #ZONE_CAPTURE_COALITION self - --- Guard Asynchronous Trigger for ZONE_CAPTURE_COALITION + --- Guard Asynchronous Trigger for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] __Guard -- @param #ZONE_CAPTURE_COALITION self -- @param #number Delay self:AddTransition( "*", "Empty", "Empty" ) - --- Empty Handler OnBefore for ZONE_CAPTURE_COALITION + --- Empty Handler OnBefore for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] OnBeforeEmpty -- @param #ZONE_CAPTURE_COALITION self -- @param #string From @@ -185,18 +196,18 @@ do -- ZoneGoal -- @param #string To -- @return #boolean - --- Empty Handler OnAfter for ZONE_CAPTURE_COALITION + --- Empty Handler OnAfter for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] OnAfterEmpty -- @param #ZONE_CAPTURE_COALITION self -- @param #string From -- @param #string Event -- @param #string To - --- Empty Trigger for ZONE_CAPTURE_COALITION + --- Empty Trigger for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] Empty -- @param #ZONE_CAPTURE_COALITION self - --- Empty Asynchronous Trigger for ZONE_CAPTURE_COALITION + --- Empty Asynchronous Trigger for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] __Empty -- @param #ZONE_CAPTURE_COALITION self -- @param #number Delay @@ -204,7 +215,7 @@ do -- ZoneGoal self:AddTransition( { "Guarded", "Empty" }, "Attack", "Attacked" ) - --- Attack Handler OnBefore for ZONE_CAPTURE_COALITION + --- Attack Handler OnBefore for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] OnBeforeAttack -- @param #ZONE_CAPTURE_COALITION self -- @param #string From @@ -212,25 +223,25 @@ do -- ZoneGoal -- @param #string To -- @return #boolean - --- Attack Handler OnAfter for ZONE_CAPTURE_COALITION + --- Attack Handler OnAfter for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] OnAfterAttack -- @param #ZONE_CAPTURE_COALITION self -- @param #string From -- @param #string Event -- @param #string To - --- Attack Trigger for ZONE_CAPTURE_COALITION + --- Attack Trigger for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] Attack -- @param #ZONE_CAPTURE_COALITION self - --- Attack Asynchronous Trigger for ZONE_CAPTURE_COALITION + --- Attack Asynchronous Trigger for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] __Attack -- @param #ZONE_CAPTURE_COALITION self -- @param #number Delay self:AddTransition( { "Guarded", "Attacked", "Empty" }, "Capture", "Captured" ) - --- Capture Handler OnBefore for ZONE_CAPTURE_COALITION + --- Capture Handler OnBefore for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] OnBeforeCapture -- @param #ZONE_CAPTURE_COALITION self -- @param #string From @@ -238,18 +249,18 @@ do -- ZoneGoal -- @param #string To -- @return #boolean - --- Capture Handler OnAfter for ZONE_CAPTURE_COALITION + --- Capture Handler OnAfter for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] OnAfterCapture -- @param #ZONE_CAPTURE_COALITION self -- @param #string From -- @param #string Event -- @param #string To - --- Capture Trigger for ZONE_CAPTURE_COALITION + --- Capture Trigger for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] Capture -- @param #ZONE_CAPTURE_COALITION self - --- Capture Asynchronous Trigger for ZONE_CAPTURE_COALITION + --- Capture Asynchronous Trigger for ZONE\_CAPTURE\_COALITION -- @function [parent=#ZONE_CAPTURE_COALITION] __Capture -- @param #ZONE_CAPTURE_COALITION self -- @param #number Delay diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html index 7f628be39..24cc7973c 100644 --- a/docs/Documentation/Cargo.html +++ b/docs/Documentation/Cargo.html @@ -2270,6 +2270,7 @@ The amount of seconds to delay the action.

+ CARGO_CRATE.CargoCarrier @@ -3805,7 +3806,6 @@ The range till cargo will board.

- #number CARGO_UNIT.RunCount diff --git a/docs/Documentation/Designate.html b/docs/Documentation/Designate.html index d11296b29..0df1c3540 100644 --- a/docs/Documentation/Designate.html +++ b/docs/Documentation/Designate.html @@ -1161,6 +1161,7 @@ function below will use the range 1-7 just in case

+ DESIGNATE.LaserCodes diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html index 8d7c02982..b6e1a9ed4 100644 --- a/docs/Documentation/Detection.html +++ b/docs/Documentation/Detection.html @@ -2470,7 +2470,6 @@ The index of the DetectedItem.

- #number DETECTION_BASE.DetectedItemCount @@ -4062,7 +4061,7 @@ Return false to cancel Transition.

- #number + DETECTION_BASE.RefreshTimeInterval diff --git a/docs/Documentation/Point.html b/docs/Documentation/Point.html index 71741434e..c08621bf2 100644 --- a/docs/Documentation/Point.html +++ b/docs/Documentation/Point.html @@ -3496,7 +3496,6 @@ The y coordinate.

- POINT_VEC2.z diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html index 610cc27d5..c777276f0 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -2309,9 +2309,6 @@ The group that was spawned. You can use this group for further actions.

- -

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

-
@@ -2987,6 +2984,9 @@ when nothing was spawned.

+ +

Overwrite unit names by default with group name.

+
@@ -3001,6 +3001,9 @@ when nothing was spawned.

+ +

By default, no InitLimit

+
@@ -3036,7 +3039,7 @@ when nothing was spawned.

- + #number SPAWN.SpawnMaxGroups @@ -3053,7 +3056,7 @@ when nothing was spawned.

- + #number SPAWN.SpawnMaxUnitsAlive @@ -3381,7 +3384,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
- #boolean + SPAWN.SpawnUnControlled @@ -3405,7 +3408,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 ) -

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

+

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

diff --git a/docs/Documentation/Spot.html b/docs/Documentation/Spot.html index 3978fd2d6..ff1b042ec 100644 --- a/docs/Documentation/Spot.html +++ b/docs/Documentation/Spot.html @@ -776,6 +776,7 @@ true if it is lasing

+ SPOT.ScheduleID @@ -789,6 +790,7 @@ true if it is lasing

+ SPOT.SpotIR @@ -802,6 +804,7 @@ true if it is lasing

+ SPOT.SpotLaser @@ -815,6 +818,7 @@ true if it is lasing

+ SPOT.Target diff --git a/docs/Documentation/ZoneCaptureCoalition.html b/docs/Documentation/ZoneCaptureCoalition.html index df2c4377e..1aac7fba6 100644 --- a/docs/Documentation/ZoneCaptureCoalition.html +++ b/docs/Documentation/ZoneCaptureCoalition.html @@ -116,12 +116,17 @@

Module ZoneCaptureCoalition

-

Functional (wIP) -- Models the process to capture a Zone for a Coalition, which is guarded by another Coalition.

+

Functional -- (WIP R2.3) Models the process to capture a Zone for a Coalition, which is guarded by another Coalition.

+

Banner Image

+ +
+ +

Contributions: Millertime: Concept

Author: Sven Van de Velde (FlightControl)

@@ -132,7 +137,7 @@ ZONE_CAPTURE_COALITION -

ZONECAPTURECOALITION class, extends ZoneGoalCoalition#ZONEGOALCOALITION

+

ZONE_CAPTURE_COALITION class, extends ZoneGoalCoalition#ZONEGOALCOALITION

Models the process to capture a Zone for a Coalition, which is guarded by another Coalition.

@@ -143,25 +148,25 @@ ZONE_CAPTURE_COALITION:Attack() -

Attack Trigger for ZONECAPTURECOALITION

+

Attack Trigger for ZONE_CAPTURE_COALITION

ZONE_CAPTURE_COALITION:Capture() -

Capture Trigger for ZONECAPTURECOALITION

+

Capture Trigger for ZONE_CAPTURE_COALITION

ZONE_CAPTURE_COALITION:Empty() -

Empty Trigger for ZONECAPTURECOALITION

+

Empty Trigger for ZONE_CAPTURE_COALITION

ZONE_CAPTURE_COALITION:Guard() -

Guard Trigger for ZONECAPTURECOALITION

+

Guard Trigger for ZONE_CAPTURE_COALITION

@@ -215,49 +220,49 @@ ZONE_CAPTURE_COALITION:OnAfterAttack(From, Event, To) -

Attack Handler OnAfter for ZONECAPTURECOALITION

+

Attack Handler OnAfter for ZONE_CAPTURE_COALITION

ZONE_CAPTURE_COALITION:OnAfterCapture(From, Event, To) -

Capture Handler OnAfter for ZONECAPTURECOALITION

+

Capture Handler OnAfter for ZONE_CAPTURE_COALITION

ZONE_CAPTURE_COALITION:OnAfterEmpty(From, Event, To) -

Empty Handler OnAfter for ZONECAPTURECOALITION

+

Empty Handler OnAfter for ZONE_CAPTURE_COALITION

ZONE_CAPTURE_COALITION:OnAfterGuard(From, Event, To) -

Guard Handler OnAfter for ZONECAPTURECOALITION

+

Guard Handler OnAfter for ZONE_CAPTURE_COALITION

ZONE_CAPTURE_COALITION:OnBeforeAttack(From, Event, To) -

Attack Handler OnBefore for ZONECAPTURECOALITION

+

Attack Handler OnBefore for ZONE_CAPTURE_COALITION

ZONE_CAPTURE_COALITION:OnBeforeCapture(From, Event, To) -

Capture Handler OnBefore for ZONECAPTURECOALITION

+

Capture Handler OnBefore for ZONE_CAPTURE_COALITION

ZONE_CAPTURE_COALITION:OnBeforeEmpty(From, Event, To) -

Empty Handler OnBefore for ZONECAPTURECOALITION

+

Empty Handler OnBefore for ZONE_CAPTURE_COALITION

ZONE_CAPTURE_COALITION:OnBeforeGuard(From, Event, To) -

Guard Handler OnBefore for ZONECAPTURECOALITION

+

Guard Handler OnBefore for ZONE_CAPTURE_COALITION

@@ -287,25 +292,25 @@ ZONE_CAPTURE_COALITION:__Attack(Delay) -

Attack Asynchronous Trigger for ZONECAPTURECOALITION

+

Attack Asynchronous Trigger for ZONE_CAPTURE_COALITION

ZONE_CAPTURE_COALITION:__Capture(Delay) -

Capture Asynchronous Trigger for ZONECAPTURECOALITION

+

Capture Asynchronous Trigger for ZONE_CAPTURE_COALITION

ZONE_CAPTURE_COALITION:__Empty(Delay) -

Empty Asynchronous Trigger for ZONECAPTURECOALITION

+

Empty Asynchronous Trigger for ZONE_CAPTURE_COALITION

ZONE_CAPTURE_COALITION:__Guard(Delay) -

Guard Asynchronous Trigger for ZONECAPTURECOALITION

+

Guard Asynchronous Trigger for ZONE_CAPTURE_COALITION

@@ -351,12 +356,18 @@
-

ZONECAPTURECOALITION class, extends ZoneGoalCoalition#ZONEGOALCOALITION

+

ZONE_CAPTURE_COALITION class, extends ZoneGoalCoalition#ZONEGOALCOALITION

Models the process to capture a Zone for a Coalition, which is guarded by another Coalition.

+
+ +

Banner Image

+ +
+

The Zone is initially Guarded by the owning coalition, which is the coalition that initially occupies the zone with units of its coalition. Once units of an other coalition are entering the Zone, the state will change to Attacked. As long as these units remain in the zone, the state keeps set to Attacked. When all units are destroyed in the Zone, the state will change to Empty, which expresses that the Zone is empty, and can be captured. @@ -364,15 +375,15 @@ When units of the other coalition are in the Zone, and no other units of the own

Event handlers can be defined by the mission designer to action on the state transitions.

-

1. ZONECAPTURECOALITION constructor

+

1. ZONE_CAPTURE_COALITION constructor

-

2. ZONECAPTURECOALITION is a finite state machine (FSM).

+

2. ZONE_CAPTURE_COALITION is a finite state machine (FSM).

-

2.1 ZONECAPTURECOALITION States

+

2.1 ZONE_CAPTURE_COALITION States

  • Captured: The Zone has been captured by an other coalition.
    • @@ -381,7 +392,7 @@ When units of the other coalition are in the Zone, and no other units of the own
  • Empty: The Zone is empty. There is not valid unit in the Zone.
-

2.2 ZONECAPTURECOALITION Events

+

2.2 ZONE_CAPTURE_COALITION Events

  • Capture: The Zone has been captured by an other coalition.
    • @@ -406,7 +417,7 @@ When units of the other coalition are in the Zone, and no other units of the own
-

Attack Trigger for ZONECAPTURECOALITION

+

Attack Trigger for ZONE_CAPTURE_COALITION

@@ -419,7 +430,7 @@ When units of the other coalition are in the Zone, and no other units of the own
-

Capture Trigger for ZONECAPTURECOALITION

+

Capture Trigger for ZONE_CAPTURE_COALITION

@@ -432,7 +443,7 @@ When units of the other coalition are in the Zone, and no other units of the own
-

Empty Trigger for ZONECAPTURECOALITION

+

Empty Trigger for ZONE_CAPTURE_COALITION

@@ -445,7 +456,7 @@ When units of the other coalition are in the Zone, and no other units of the own
-

Guard Trigger for ZONECAPTURECOALITION

+

Guard Trigger for ZONE_CAPTURE_COALITION

@@ -592,7 +603,7 @@ The initial coalition owning the zone.

-

Attack Handler OnAfter for ZONECAPTURECOALITION

+

Attack Handler OnAfter for ZONE_CAPTURE_COALITION

Parameters

    @@ -623,7 +634,7 @@ The initial coalition owning the zone.

-

Capture Handler OnAfter for ZONECAPTURECOALITION

+

Capture Handler OnAfter for ZONE_CAPTURE_COALITION

Parameters

    @@ -654,7 +665,7 @@ The initial coalition owning the zone.

-

Empty Handler OnAfter for ZONECAPTURECOALITION

+

Empty Handler OnAfter for ZONE_CAPTURE_COALITION

Parameters

    @@ -685,7 +696,7 @@ The initial coalition owning the zone.

-

Guard Handler OnAfter for ZONECAPTURECOALITION

+

Guard Handler OnAfter for ZONE_CAPTURE_COALITION

Parameters

    @@ -716,7 +727,7 @@ The initial coalition owning the zone.

-

Attack Handler OnBefore for ZONECAPTURECOALITION

+

Attack Handler OnBefore for ZONE_CAPTURE_COALITION

Parameters

    @@ -752,7 +763,7 @@ The initial coalition owning the zone.

-

Capture Handler OnBefore for ZONECAPTURECOALITION

+

Capture Handler OnBefore for ZONE_CAPTURE_COALITION

Parameters