Module AI_Balancer
-Single-Player:No / Multi-Player:Yes / AI:Yes / Human:No / Types:All -- AI Balancing will replace in multi player missions
+ AI -- AI Balancing will replace in multi player missions
non-occupied human slots with AI groups, in order to provide an engaging simulation environment,
even when there are hardly any players in the mission.
-
API CHANGE HISTORY
- -The underlying change log documents the API changes.
- - -Please read this carefully. The following notation is used:
- --
-
- Added parts are expressed in bold type face. -
- Removed parts are expressed in italic type face. -
Hereby the change log:
- -2017-01-17: There is still a problem with AI being destroyed, but not respawned. Need to check further upon that.
- -2017-01-08: AI_BALANCER:InitSpawnInterval( Earliest, Latest ) added.
- -- -
AUTHORS and CONTRIBUTIONS
- +Author: Sven Van de Velde (FlightControl)
Contributions:
-
-
- Dutch_Baron: Working together with James has resulted in the creation of the AI_BALANCER class. James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-) -
- SNAFU: Had a couple of mails with the guys to validate, if the same concept in the GCI/CAP script could be reworked within MOOSE. None of the script code has been used however within the new AI_BALANCER moose class. +
- Dutch_Baron: Working together with James has resulted in the creation of the AI_BALANCER class.
Authors:
+ +James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-)
--
-
- FlightControl: Framework Design & Programming and Documentation. -
Global(s)
diff --git a/docs/Documentation/AI_Cap.html b/docs/Documentation/AI_Cap.html index 8536cb291..aba7baf7d 100644 --- a/docs/Documentation/AI_Cap.html +++ b/docs/Documentation/AI_Cap.html @@ -100,7 +100,7 @@Module AI_Cap
-AI - Execute Combat Air Patrol (CAP).
+AI -- Execute Combat Air Patrol (CAP).
-
API CHANGE HISTORY
- -The underlying change log documents the API changes. Please read this carefully. The following notation is used:
- --
-
- Added parts are expressed in bold type face. -
- Removed parts are expressed in italic type face. -
Hereby the change log:
- -2017-01-15: Initial class and API.
- -- -
AUTHORS and CONTRIBUTIONS
+Author: Sven Van de Velde (FlightControl)
Contributions:
@@ -161,11 +146,7 @@Authors:
- --
-
- FlightControl: Concept, Design & Programming. -
Global(s)
diff --git a/docs/Documentation/AI_Cas.html b/docs/Documentation/AI_Cas.html index 1ae0d9720..edc7a604c 100644 --- a/docs/Documentation/AI_Cas.html +++ b/docs/Documentation/AI_Cas.html @@ -134,7 +134,8 @@-
AUTHORS and CONTRIBUTIONS
+ +Author: Sven Van de Velde (FlightControl)
Contributions:
@@ -144,11 +145,7 @@Authors:
- --
-
- FlightControl: Concept, Design & Programming. -
Global(s)
diff --git a/docs/Documentation/AI_Formation.html b/docs/Documentation/AI_Formation.html index f80dc8eab..1bdf733af 100644 --- a/docs/Documentation/AI_Formation.html +++ b/docs/Documentation/AI_Formation.html @@ -100,7 +100,7 @@Module AI_Formation
-AI -- (R2.1) Build large formations of AI Groups flying together.
+AI -- Build large formations of AI Groups flying together.
@@ -160,16 +160,12 @@ The purpose of the class is to:-
AUTHORS and CONTRIBUTIONS
+Author: Sven Van de Velde (FlightControl)
Contributions:
-Authors:
- --
-
- FlightControl: Concept, Design & Programming. - -
+
Global(s)
Type AIRBASE
CLIENT class, extends Unit#UNIT
+ +Clients are those Units defined within the Mission Editor that have the skillset defined as Client or Player.
+ + +Note that clients are NOT the same as Units, they are NOT necessarily alive. +The CLIENT class is a wrapper class to handle the DCS Unit objects that have the skillset defined as Client or Player:
+ +-
+
- Wraps the DCS Unit objects with skill level set to Player or Client. +
- Support all DCS Unit APIs. +
- Enhance with Unit specific APIs not in the DCS Group API set. +
- When player joins Unit, execute alive init logic. +
- Handles messages to players. +
- Manage the "state" of the DCS Unit. +
Clients are being used by the MISSION class to follow players and register their successes.
+ +CLIENT reference methods
+ +For each DCS Unit having skill level Player or Client, a CLIENT wrapper object (instance) will be created within the _DATABASE object. +This is done at the beginning of the mission (when the mission starts).
+ +The CLIENT class does not contain a :New() method, rather it provides :Find() methods to retrieve the object reference +using the DCS Unit or the DCS UnitName.
+ +Another thing to know is that CLIENT objects do not "contain" the DCS Unit object. +The CLIENT methods will reference the DCS Unit object by name when it is needed during API execution. +If the DCS Unit object does not exist or is nil, the CLIENT methods will return nil and log an exception in the DCS.log file.
+ +The CLIENT class provides the following functions to retrieve quickly the relevant CLIENT instance:
+ +-
+
- CLIENT.Find(): Find a CLIENT instance from the _DATABASE object using a DCS Unit object. +
- CLIENT.FindByName(): Find a CLIENT instance from the _DATABASE object using a DCS Unit name. +
IMPORTANT: ONE SHOULD NEVER SANATIZE these CLIENT OBJECT REFERENCES! (make the CLIENT object references nil).
-
-
- - - #string - -CLIENT.ClassName - - -
- - - - - -
-
-
- - - #boolean - -CLIENT.ClientAlive - - -
- - - -
-
@@ -574,19 +523,6 @@ Create a function that will be called when a player joins the slot.
-
-
-
-
- - - -CLIENT.ClientName - - -
- - - -
-
@@ -899,34 +835,6 @@ is the identifier of the message when displayed with intervals.
-
-
-
-
- - - - -CLIENT.Messages - - -
- - - - - -
-
-
- - - - -CLIENT.ONBOARDSIDE - - -
- - - -
-
@@ -1111,20 +1019,6 @@ self
-
-
-
-
- - - - -CLIENT._Tasks - - -
- - - -
Module CommandCenter
-A COMMANDCENTER is the owner of multiple missions within MOOSE.
+Tasking -- A COMMANDCENTER is the owner of multiple missions within MOOSE.
A COMMANDCENTER governs multiple missions, the tasking and the reporting.
++ +
Author: Sven Van de Velde (FlightControl)
+ +Contributions:
+ ++ +
Global(s)
| CONTROLLABLE |
+CONTROLLABLE class, extends Positionable#POSITIONABLE+CONTROLLABLE is a wrapper class to handle the "DCS Controllable objects", which are Groups and Units: + +
|
Type CONTROLLABLE
| CONTROLLABLE.ClassName | -- - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CONTROLLABLE:ClearTasks() |
Clear all tasks from the controllable. @@ -715,12 +584,6 @@ This is different from the EnRoute tasks, where the targets of the task need to | CONTROLLABLE:WayPointFunction(WayPoint, WayPointIndex, WayPointFunction, ...) |
Registers a waypoint function that will be executed when the controllable moves over the WayPoint. - |
- ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CONTROLLABLE.WayPointFunctions | -- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| IDENTIFIABLE |
+IDENTIFIABLE class, extends Object#OBJECT+The IDENTIFIABLE class is a wrapper class to handle the DCS Identifiable objects: + +
|
Type IDENTIFIABLE
| IDENTIFIABLE.ClassName | -- - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| IDENTIFIABLE:GetCallsign() |
Gets the CallSign of the IDENTIFIABLE, which is a blank by default. @@ -238,6 +215,27 @@IDENTIFIABLE class, extends Object#OBJECT+ +The IDENTIFIABLE class is a wrapper class to handle the DCS Identifiable objects: + +
IDENTIFIABLE constructor+ +The IDENTIFIABLE class provides the following functions to construct a IDENTIFIABLE instance: + +
Type
|
| OBJECT |
+OBJECT class, extends Base#BASE+OBJECT handles the DCS Object objects: + +
|
Type OBJECT
| OBJECT.ClassName | -- - | -||
| OBJECT:Destroy() |
Destroys the OBJECT. @@ -194,6 +177,27 @@OBJECT class, extends Base#BASE+ +OBJECT handles the DCS Object objects: + +
OBJECT constructor:+ +The OBJECT class provides the following functions to construct a OBJECT instance: + +
Type
-
- | ||
| SCENERY |
+SCENERY class, extends Positionable#POSITIONABLE+Scenery objects are defined on the map. |
Type SCENERY
| SCENERY.ClassName | -- - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SCENERY:GetDCSObject() |
@@ -163,6 +157,18 @@ The Scenery#SCENERY class is a wrapper cla
SCENERY class, extends Positionable#POSITIONABLE+ +Scenery objects are defined on the map. + + +The Scenery#SCENERY class is a wrapper class to handle the DCS Scenery objects: + +
Type
|
| SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) | - | - -
| SPAWN.uncontrolled | -- |
Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.
--
@@ -2575,9 +2566,6 @@ when nothing was spawned.
-
-
By default, no InitLimit
--
@@ -2613,7 +2601,7 @@ when nothing was spawned.
- - #number + SPAWN.SpawnMaxGroups @@ -2630,7 +2618,7 @@ when nothing was spawned.
- - #number + SPAWN.SpawnMaxUnitsAlive @@ -2958,7 +2946,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
- - #boolean + SPAWN.SpawnUnControlled @@ -3548,20 +3536,6 @@ True = Continue Scheduler - -
- - - - -SPAWN.uncontrolled - - -
- - - -
- Added parts are expressed in bold type face. -
- Removed parts are expressed in italic type face. -
- FlightControl: Design & Programming -
-
+ #number
SPAWNSTATIC.SpawnIndex
diff --git a/docs/Documentation/Spot.html b/docs/Documentation/Spot.html
index 018cdd833..181cbd720 100644
--- a/docs/Documentation/Spot.html
+++ b/docs/Documentation/Spot.html
@@ -100,7 +100,7 @@
Module
-SpotCore 2.1 -- Management of SPOT logistics, that can be transported from and to transportation carriers.
+Core -- Management of SPOT logistics, that can be transported from and to transportation carriers.
@@ -135,8 +135,7 @@
-AUTHORS and CONTRIBUTIONS
- +Author: Sven Van de Velde (FlightControl)
Contributions:
-
@@ -145,12 +144,7 @@
- Wingthor: Beta Testing
Authors:
- --
-
- FlightControl: Design & Programming -
Global(s)
@@ -766,6 +760,7 @@ true if it is lasing- + SPOT.ScheduleID @@ -779,6 +774,7 @@ true if it is lasing
- + SPOT.SpotIR @@ -792,6 +788,7 @@ true if it is lasing
- + SPOT.SpotLaser @@ -805,6 +802,7 @@ true if it is lasing
-
+
SPOT.Target
diff --git a/docs/Documentation/Static.html b/docs/Documentation/Static.html
index 25c4ef050..e8dbd6dcd 100644
--- a/docs/Documentation/Static.html
+++ b/docs/Documentation/Static.html
@@ -100,39 +100,17 @@
Module
-StaticThis module contains the STATIC class.
+Wrapper -- STATIC wraps the DCS StaticObject class.
-1) Static#STATIC class, extends Positionable#POSITIONABLE
-Statics are Static Units defined within the Mission Editor. -Note that Statics are almost the same as Units, but they don't have a controller. -The Static#STATIC class is a wrapper class to handle the DCS Static objects:
+
--
-
- Wraps the DCS Static objects. -
- Support all DCS Static APIs. -
- Enhance with Static specific APIs not in the DCS API set. -
Author: Sven Van de Velde (FlightControl)
-1.1) STATIC reference methods
-For each DCS Static will have a STATIC wrapper object (instance) within the _DATABASE object. -This is done at the beginning of the mission (when the mission starts).
+Contributions:
-The STATIC class does not contain a :New() method, rather it provides :Find() methods to retrieve the object reference -using the Static Name.
- -Another thing to know is that STATIC objects do not "contain" the DCS Static object. -The STATIc methods will reference the DCS Static object by name when it is needed during API execution. -If the DCS Static object does not exist or is nil, the STATIC methods will return nil and log an exception in the DCS.log file.
- -The STATIc class provides the following functions to retrieve quickly the relevant STATIC instance:
- --
-
- STATIC.FindByName(): Find a STATIC instance from the _DATABASE object using a DCS Static name. -
IMPORTANT: ONE SHOULD NEVER SANATIZE these STATIC OBJECT REFERENCES! (make the STATIC object references nil).
+
Global(s)
@@ -140,19 +118,15 @@ If the DCS Static object does not exist or is nil, the STATIC methods will returSTATIC + STATIC class, extends Positionable#POSITIONABLE
+Statics are Static Units defined within the Mission Editor.
-
-
Module SpawnStatic
-(R2.1) Core -- Spawn dynamically new STATICs in your missions.
+Core -- Spawn dynamically new STATICs in your missions.
@@ -128,28 +128,10 @@
-
API CHANGE HISTORY
- -The underlying change log documents the API changes. Please read this carefully. The following notation is used:
- --
-
Hereby the change log:
- -- -
AUTHORS and CONTRIBUTIONS
- +Author: Sven Van de Velde (FlightControl)
Contributions:
-Authors:
- --
-
Global(s)
@@ -449,6 +431,7 @@ ptional) The name of the new static.Type STATIC
| STATIC.ClassName | -- - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| STATIC:FindByName(StaticName, RaiseError) |
Finds a STATIC from the _DATABASE using the relevant Static Name. @@ -195,6 +169,39 @@ If the DCS Static object does not exist or is nil, the STATIC methods will returSTATIC class, extends Positionable#POSITIONABLE+ +Statics are Static Units defined within the Mission Editor. + + +Note that Statics are almost the same as Units, but they don't have a controller. +The Static#STATIC class is a wrapper class to handle the DCS Static objects: + +
STATIC reference methods+ +For each DCS Static will have a STATIC wrapper object (instance) within the _DATABASE object. +This is done at the beginning of the mission (when the mission starts). + +The STATIC class does not contain a :New() method, rather it provides :Find() methods to retrieve the object reference +using the Static Name. + +Another thing to know is that STATIC objects do not "contain" the DCS Static object. +The STATIc methods will reference the DCS Static object by name when it is needed during API execution. +If the DCS Static object does not exist or is nil, the STATIC methods will return nil and log an exception in the DCS.log file. + +The STATIc class provides the following functions to retrieve quickly the relevant STATIC instance: + +
IMPORTANT: ONE SHOULD NEVER SANATIZE these STATIC OBJECT REFERENCES! (make the STATIC object references nil). Type
|
| TASK_A2A |
+TASK_A2A class, extends Task#TASK+The TASK_A2A class defines Air To Air tasks for a Set of Target Units, +based on the tasking capabilities defined in Task#TASK. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TASK_A2A.ClassName | -- - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TASK_A2A:GetPlannedMenuText() |
@@ -345,6 +299,31 @@ The TASK_A2A is implemented using a Stat
TASK_A2A class, extends Task#TASK+ +The TASK_A2A class defines Air To Air tasks for a Set of Target Units, +based on the tasking capabilities defined in Task#TASK. + + +The TASK_A2A is implemented using a Fsm#FSM_TASK, and has the following statuses: + +
1.1) Set the scoring of achievements in an A2A attack.+ +Scoring or penalties can be given in the following circumstances: + +
|
