From fb6bb635c687cde3e387d90bed3ca98b312f9fa4 Mon Sep 17 00:00:00 2001 From: Grey-Echo Date: Sat, 22 Apr 2017 11:35:14 +0200 Subject: [PATCH] Documentation Update --- docs/Documentation/AI_Designate.html | 77 +++++++ docs/Documentation/AI_Patrol.html | 3 + docs/Documentation/Base.html | 31 +++ docs/Documentation/Detection.html | 3 +- docs/Documentation/Fsm.html | 3 +- docs/Documentation/Movement.html | 4 + docs/Documentation/Set.html | 248 ++++++++++++++++++++++ docs/Documentation/Spawn.html | 14 +- docs/Documentation/Spot.html | 300 +++++++++++++++++++++++++-- 9 files changed, 653 insertions(+), 30 deletions(-) diff --git a/docs/Documentation/AI_Designate.html b/docs/Documentation/AI_Designate.html index b551f163f..e8948271c 100644 --- a/docs/Documentation/AI_Designate.html +++ b/docs/Documentation/AI_Designate.html @@ -154,6 +154,12 @@ each detected set of potential targets can be lased or smoked...

AI_DESIGNATE.LaserCodes + + + + AI_DESIGNATE.LaserCodesUsed + + @@ -328,6 +334,12 @@ each detected set of potential targets can be lased or smoked...

AI_DESIGNATE:onafterLaseOn(From, Event, To, AttackGroup, Index, Duration) + + + + AI_DESIGNATE:onafterLasing(From, Event, To, AttackGroup, Index, Duration) + + @@ -512,6 +524,20 @@ One laser code can be given or an sequence of laser codes through an table...

+ +
+
+ + + +AI_DESIGNATE.LaserCodesUsed + +
+
+ + +
@@ -1315,6 +1341,57 @@ number> LaserCodes

#AI_DESIGNATE:

+ +
+
+
+ + +AI_DESIGNATE:onafterLasing(From, Event, To, AttackGroup, Index, Duration) + +
+
+ + + +

Parameters

+
    +
  • + +

    From :

    + +
    • +
  • + +

    Event :

    + +
    • +
  • + +

    To :

    + +
    • +
  • + +

    AttackGroup :

    + +
    • +
  • + +

    Index :

    + +
    • +
  • + +

    Duration :

    + +
    • +
+

Return value

+ +

#AI_DESIGNATE:

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

This table contains the targets detected during patrol.

+
diff --git a/docs/Documentation/Base.html b/docs/Documentation/Base.html index 30a860472..2a7c7a64b 100644 --- a/docs/Documentation/Base.html +++ b/docs/Documentation/Base.html @@ -312,6 +312,12 @@ YYYY-MM-DD: CLASS:NewFunction( Params ) added

BASE:OnEventCrash(EventData)

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

+ + + + BASE:OnEventDead(EventData) + +

Occurs when an object is dead.

@@ -1398,6 +1404,31 @@ The EventData structure.

+ +BASE:OnEventDead(EventData) + +
+
+ +

Occurs when an object is dead.

+ + +

initiator : The unit that is dead.

+ +

Parameter

+ +
+
+
+
+ BASE:OnEventEjection(EventData) diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html index f5ebc18d1..5989a6901 100644 --- a/docs/Documentation/Detection.html +++ b/docs/Documentation/Detection.html @@ -2187,6 +2187,7 @@ self

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

- #number + DETECTION_BASE.DetectionInterval diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html index 7d9bc4a08..9b6918395 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,7 +1921,6 @@ A string defining the start state.

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

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

+ +

Contains the counter how many units are currently alive

+
diff --git a/docs/Documentation/Set.html b/docs/Documentation/Set.html index a74f207e9..29ad4f438 100644 --- a/docs/Documentation/Set.html +++ b/docs/Documentation/Set.html @@ -349,6 +349,18 @@ SET_BASE.Filter + + + + SET_BASE:FilterCrashes() + +

Starts the filtering of the Crash events for the collection.

+ + + + SET_BASE:FilterDeads() + +

Starts the filtering of the Dead events for the collection.

@@ -715,6 +727,24 @@ SET_GROUP:AddInDatabase(Event)

Handles the Database to check on an event (birth) that the Object was added in the Database.

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

Iterate the SET_GROUP and return true if all the Wrapper.Group#GROUP are completely in the Core.Zone#ZONE

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

@@ -799,6 +829,14 @@ SET_GROUP:New()

Creates a new SET_GROUP object, building a set of groups belonging to a coalitions, categories, countries, types or with defined prefix names.

+ + + + 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 +mission designer to add a dedicated method

@@ -1856,6 +1894,42 @@ Count

+ +
+
+
+ + +SET_BASE:FilterCrashes() + +
+
+ +

Starts the filtering of the Crash events for the collection.

+ +

Return value

+ +

#SET_BASE: +self

+ +
+
+
+
+ + +SET_BASE:FilterDeads() + +
+
+ +

Starts the filtering of the Dead events for the collection.

+ +

Return value

+ +

#SET_BASE: +self

+
@@ -3412,6 +3486,135 @@ The GROUP

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

Iterate the SET_GROUP and return true if all the Wrapper.Group#GROUP are completely in the Core.Zone#ZONE

+ +

Parameters

+
    +
  • + +

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

    + +
    • +
  • + +

    Zone :

    + +
    • +
+

Return value

+ +

#boolean: +true if all the Wrapper.Group#GROUP are completly in the Core.Zone#ZONE, false otherwise

+ +

Usage:

+ 
local MyZone = ZONE:New("Zone1")
+local MySetGroup = SET_GROUP:New()
+MySetGroup:AddGroupsByName({"Group1", "Group2"})
+
+if MySetGroup:AllCompletelyInZone(MyZone) then
+  MESSAGE:New("All the SET's GROUP are in zone !", 10):ToAll()
+else
+  MESSAGE:New("Some or all SET's GROUP are outside zone !", 10):ToAll()
+end
+ +
+
+
+
+ + +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

+ +

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 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:AnyCompletelyInZone(MyZone) then
+  MESSAGE:New("At least one GROUP is completely in zone !", 10):ToAll()
+else
+  MESSAGE:New("No GROUP is completely in zone !", 10):ToAll()
+end
+ +
+
+
+
+ + +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

+ +

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 has at least one UNIT in zone !", 10):ToAll()
+else
+  MESSAGE:New("No UNIT of any GROUP is in zone !", 10):ToAll()
+end
+ +
+
+
+
+ SET_GROUP:FilterCategories(Categories) @@ -3836,6 +4039,51 @@ DBObject = SET_GROUP:New()
+ +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 +mission designer to add a dedicated method

+ +

Parameters

+
    +
  • + +

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

    + +
    • +
  • + +

    Zone :

    + +
    • +
+

Return value

+ +

#boolean: +true if no Wrapper.Group#GROUP is inside the Core.Zone#ZONE in any way, false otherwise.

+ +

Usage:

+ 
local MyZone = ZONE:New("Zone1")
+local MySetGroup = SET_GROUP:New()
+MySetGroup:AddGroupsByName({"Group1", "Group2"})
+
+if MySetGroup:NoneInZone(MyZone) then
+  MESSAGE:New("No GROUP is completely in zone !", 10):ToAll()
+else
+  MESSAGE:New("No UNIT of any GROUP is in zone !", 10):ToAll()
+end
+ +
+
+
+
+ SET_GROUP:RemoveGroupsByName(RemoveGroupNames) diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html index 896cf233e..088a3a7ad 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -2113,6 +2113,9 @@ 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.

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

+ +

By default, no InitLimit

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

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

- + #number SPAWN.SpawnMaxUnitsAlive @@ -2963,7 +2969,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
- + #boolean SPAWN.SpawnUnControlled @@ -2987,7 +2993,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 ) -

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

+

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

diff --git a/docs/Documentation/Spot.html b/docs/Documentation/Spot.html index a9450d82c..220a12388 100644 --- a/docs/Documentation/Spot.html +++ b/docs/Documentation/Spot.html @@ -138,15 +138,21 @@

Type SPOT

- - - - + + + + + + + + @@ -165,6 +171,36 @@ + + + + + + + + + + + + + + + + + + + + @@ -189,6 +225,18 @@ + + + + + + + + @@ -233,20 +281,6 @@
- #string - -SPOT.ClassName - -
-
- - - -
-
-
-
- SPOT:IsLasing() @@ -260,6 +294,32 @@

#boolean: true if it is lasing

+ +
+
+
+ + +SPOT:LaseOff() + +
+
+ +

LaseOff Trigger for SPOT

+ +
+
+
+
+ + +SPOT:LaseOn() + +
+
+ +

LaseOn Trigger for SPOT

+
@@ -324,6 +384,161 @@ true if it is lasing

#SPOT:

+ +
+
+
+ + +SPOT:OnAfterLaseOff(From, Event, To) + +
+
+ +

LaseOff Handler OnAfter for SPOT

+ +

Parameters

+
    +
  • + +

    #string From :

    + +
    • +
  • + +

    #string Event :

    + +
    • +
  • + +

    #string To :

    + +
    • +
+
+
+
+
+ + +SPOT:OnAfterLaseOn(From, Event, To) + +
+
+ +

LaseOn Handler OnAfter for SPOT

+ +

Parameters

+
    +
  • + +

    #string From :

    + +
    • +
  • + +

    #string Event :

    + +
    • +
  • + +

    #string To :

    + +
    • +
+
+
+
+
+ + +SPOT:OnBeforeLaseOff(From, Event, To) + +
+
+ +

LaseOff Handler OnBefore for SPOT

+ +

Parameters

+
    +
  • + +

    #string From :

    + +
    • +
  • + +

    #string Event :

    + +
    • +
  • + +

    #string To :

    + +
    • +
+

Return value

+ +

#boolean:

+ + +
+
+
+
+ + +SPOT:OnBeforeLaseOn(From, Event, To) + +
+
+ +

LaseOn Handler OnBefore for SPOT

+ +

Parameters

+
    +
  • + +

    #string From :

    + +
    • +
  • + +

    #string Event :

    + +
    • +
  • + +

    #string To :

    + +
    • +
+

Return value

+ +

#boolean:

+ + +
+
+
+
+ + +SPOT:OnEventDead(EventData) + +
+
+ + + +

Parameter

+
@@ -343,7 +558,6 @@ true if it is lasing

- SPOT.ScheduleID @@ -357,7 +571,6 @@ true if it is lasing

- SPOT.Spot @@ -371,7 +584,6 @@ true if it is lasing

- SPOT.Target @@ -380,6 +592,48 @@ true if it is lasing

+ +
+
+
+ + +SPOT:__LaseOff(Delay) + +
+
+ +

LaseOff Asynchronous Trigger for SPOT

+ +

Parameter

+
    +
  • + +

    #number Delay :

    + +
    • +
+
+
+
+
+ + +SPOT:__LaseOn(Delay) + +
+
+ +

LaseOn Asynchronous Trigger for SPOT

+ +

Parameter

+
    +
  • + +

    #number Delay :

    + +
    • +
SPOT.ClassName - -
SPOT:IsLasing()

Check if the SPOT is lasing

+
SPOT:LaseOff() +

LaseOff Trigger for SPOT

+
SPOT:LaseOn() +

LaseOn Trigger for SPOT
SPOT:New(Recce, LaserCode, Duration)

SPOT Constructor.

+
SPOT:OnAfterLaseOff(From, Event, To) +

LaseOff Handler OnAfter for SPOT

+
SPOT:OnAfterLaseOn(From, Event, To) +

LaseOn Handler OnAfter for SPOT

+
SPOT:OnBeforeLaseOff(From, Event, To) +

LaseOff Handler OnBefore for SPOT

+
SPOT:OnBeforeLaseOn(From, Event, To) +

LaseOn Handler OnBefore for SPOT

+
SPOT:OnEventDead(EventData) +
SPOT.Target +
SPOT:__LaseOff(Delay) +

LaseOff Asynchronous Trigger for SPOT

+
SPOT:__LaseOn(Delay) +

LaseOn Asynchronous Trigger for SPOT