diff --git a/docs/Documentation/AI_Patrol.html b/docs/Documentation/AI_Patrol.html index d80d5e9ce..3f3376551 100644 --- a/docs/Documentation/AI_Patrol.html +++ b/docs/Documentation/AI_Patrol.html @@ -951,9 +951,6 @@ Use the method AIPATROLZONE.M - -

This table contains the targets detected during patrol.

-
diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html index 2b21da531..c4e5754c6 100644 --- a/docs/Documentation/Cargo.html +++ b/docs/Documentation/Cargo.html @@ -2847,7 +2847,6 @@ The range till cargo will board.

- CARGO_UNIT.CargoCarrier diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html index 5989a6901..f5ebc18d1 100644 --- a/docs/Documentation/Detection.html +++ b/docs/Documentation/Detection.html @@ -2187,7 +2187,6 @@ self

- #number DETECTION_BASE.DetectedItemMax @@ -2301,7 +2300,7 @@ self

- + #number DETECTION_BASE.DetectionInterval diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html index 9b6918395..7d9bc4a08 100644 --- a/docs/Documentation/Fsm.html +++ b/docs/Documentation/Fsm.html @@ -1622,7 +1622,7 @@ A string defining the start state.

- #string + FSM._StartState @@ -1921,6 +1921,7 @@ A string defining the start state.

+ FSM.current diff --git a/docs/Documentation/Group.html b/docs/Documentation/Group.html index 7404cd7ba..e415e93ed 100644 --- a/docs/Documentation/Group.html +++ b/docs/Documentation/Group.html @@ -190,6 +190,12 @@ GROUP:CopyRoute(Begin, End, Randomize, Radius)

Return the route of a group by using the Database#DATABASE class.

+ + + + GROUP:CountInZone(Zone) + +

Returns the number of UNITs that are in the Zone

@@ -680,6 +686,33 @@ When randomization is on, the randomization is within the radius.

+ +GROUP:CountInZone(Zone) + +
+
+ +

Returns the number of UNITs that are in the Zone

+ +

Parameter

+ +

Return value

+ +

#number: +The number of UNITs that are in the Zone

+ +
+
+
+
+ GROUP:Destroy() diff --git a/docs/Documentation/Movement.html b/docs/Documentation/Movement.html index 6199b647b..6c410e890 100644 --- a/docs/Documentation/Movement.html +++ b/docs/Documentation/Movement.html @@ -213,7 +213,6 @@ on defined intervals (currently every minute).

- #number MOVEMENT.AliveUnits @@ -222,9 +221,6 @@ on defined intervals (currently every minute).

- -

Contains the counter how many units are currently alive

-
diff --git a/docs/Documentation/Positionable.html b/docs/Documentation/Positionable.html index 2d0a62858..d14bdc539 100644 --- a/docs/Documentation/Positionable.html +++ b/docs/Documentation/Positionable.html @@ -1208,6 +1208,7 @@ self

+ Core.Spot#SPOT POSITIONABLE.Spot diff --git a/docs/Documentation/Set.html b/docs/Documentation/Set.html index 29ad4f438..e66aac85e 100644 --- a/docs/Documentation/Set.html +++ b/docs/Documentation/Set.html @@ -739,12 +739,32 @@ SET_GROUP:AnyCompletelyInZone(ZoneObject, Zone)

Iterate the SET_GROUP and return true if at least one of the Wrapper.Group#GROUP is completely inside the Core.Zone#ZONE

+ + + + SET_GROUP:AnyInZone(ZoneObject, Zone) + +

Iterate the SET_GROUP and return true if at least one #UNIT of one GROUP of the SET_GROUP is in ZONE

SET_GROUP:AnyPartlyInZone(ZoneObject, Zone) -

Iterate the SET_GROUP and return true if at least one #UNIT of one GROUP of the SET_GROUP is in ZONE

+

Iterate the SET_GROUP and return true if at least one GROUP of the SET_GROUP is partly in ZONE.

+ + + + SET_GROUP:CountInZone(ZoneObject, Zone) + +

Iterate the SETGROUP and count how many GROUPs are completely in the Zone +That could easily be done with SETGROUP:ForEachGroupCompletelyInZone(), but this function +provides an easy to use shortcut...

+ + + + SET_GROUP:CountUnitInZone(ZoneObject, Zone) + +

Iterate the SET_GROUP and count how many UNITs are completely in the Zone

@@ -3572,13 +3592,13 @@ end
- -SET_GROUP:AnyPartlyInZone(ZoneObject, Zone) + +SET_GROUP:AnyInZone(ZoneObject, Zone)
-

Iterate the SET_GROUP and return true if at least one #UNIT of one GROUP of the SET_GROUP is in ZONE

+

Iterate the SET_GROUP and return true if at least one #UNIT of one GROUP of the SET_GROUP is in ZONE

Parameters

    @@ -3615,6 +3635,132 @@ end
    + +SET_GROUP:AnyPartlyInZone(ZoneObject, Zone) + +
    +
    + +

    Iterate the SET_GROUP and return true if at least one GROUP of the SET_GROUP is partly in ZONE.

    + + +

    Will return false if a GROUP is fully in the ZONE

    + +

    Parameters

    +
      +
    • + +

      Core.Zone#ZONE ZoneObject : +The Zone to be tested for.

      + +
      • +
    • + +

      Zone :

      + +
      • +
    +

    Return value

    + +

    #boolean: +true if at least one of the Wrapper.Group#GROUP is partly or completly inside the Core.Zone#ZONE, false otherwise.

    + +

    Usage:

    + 
    local MyZone = ZONE:New("Zone1")
+local MySetGroup = SET_GROUP:New()
+MySetGroup:AddGroupsByName({"Group1", "Group2"})
+
+if MySetGroup:AnyPartlyInZone(MyZone) then
+  MESSAGE:New("At least one GROUP is partially in the zone, but none are fully in it !", 10):ToAll()
+else
+  MESSAGE:New("No GROUP are in zone, or one (or more) GROUP is completely in it !", 10):ToAll()
+end
    + +
    +
    +
    +
    + + +SET_GROUP:CountInZone(ZoneObject, Zone) + +
    +
    + +

    Iterate the SETGROUP and count how many GROUPs are completely in the Zone +That could easily be done with SETGROUP:ForEachGroupCompletelyInZone(), but this function +provides an easy to use shortcut...

    + +

    Parameters

    +
      +
    • + +

      Core.Zone#ZONE ZoneObject : +The Zone to be tested for.

      + +
      • +
    • + +

      Zone :

      + +
      • +
    +

    Return value

    + +

    #number: +the number of GROUPs completely in the Zone

    + +

    Usage:

    + 
    local MyZone = ZONE:New("Zone1")
+local MySetGroup = SET_GROUP:New()
+MySetGroup:AddGroupsByName({"Group1", "Group2"})
+
+MESSAGE:New("There are " .. MySetGroup:CountInZone(MyZone) .. " GROUPs in the Zone !", 10):ToAll()
    + +
    +
    +
    +
    + + +SET_GROUP:CountUnitInZone(ZoneObject, Zone) + +
    +
    + +

    Iterate the SET_GROUP and count how many UNITs are completely in the Zone

    + +

    Parameters

    +
      +
    • + +

      Core.Zone#ZONE ZoneObject : +The Zone to be tested for.

      + +
      • +
    • + +

      Zone :

      + +
      • +
    +

    Return value

    + +

    #number: +the number of GROUPs completely in the Zone

    + +

    Usage:

    + 
    local MyZone = ZONE:New("Zone1")
+local MySetGroup = SET_GROUP:New()
+MySetGroup:AddGroupsByName({"Group1", "Group2"})
+
+MESSAGE:New("There are " .. MySetGroup:CountUnitInZone(MyZone) .. " UNITs in the Zone !", 10):ToAll()
    + +
    +
    +
    +
    + SET_GROUP:FilterCategories(Categories) diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html index 088a3a7ad..d7bf6b172 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -812,6 +812,12 @@ and any spaces before and after the resulting name are removed.

    SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) + + + + SPAWN.uncontrolled + + @@ -2113,9 +2119,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.

    -
@@ -2586,9 +2589,6 @@ when nothing was spawned.

- -

By default, no InitLimit

-
@@ -2624,7 +2624,7 @@ when nothing was spawned.

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

- #number + SPAWN.SpawnMaxUnitsAlive @@ -2993,7 +2993,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.

@@ -3559,6 +3559,20 @@ True = Continue Scheduler

+ +
+
+
+ + + +SPAWN.uncontrolled + +
+
+ + +
diff --git a/docs/Documentation/SpawnStatic.html b/docs/Documentation/SpawnStatic.html index 23a722fcf..50d0ec61a 100644 --- a/docs/Documentation/SpawnStatic.html +++ b/docs/Documentation/SpawnStatic.html @@ -444,7 +444,6 @@ ptional) The name of the new static.

- #number SPAWNSTATIC.SpawnIndex diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html index 73897fb41..0d3a4ee9b 100644 --- a/docs/Documentation/Task_Cargo.html +++ b/docs/Documentation/Task_Cargo.html @@ -453,7 +453,7 @@ based on the tasking capabilities defined in Task#TA
- Core.Cargo#CARGO_GROUP + FSM_PROCESS.Cargo