- - #number AI_A2A.IdleCount @@ -584,78 +583,6 @@ - -
-
-
- - - -AI_A2A:ManageDamage(PatrolDamageTreshold) - - -
-
-
-
When the AI is damaged beyond a certain treshold, it is required that the AI returns to the home base.
- - -However, damage cannot be foreseen early on. -Therefore, when the damage treshold is reached, -the AI will return immediately to the home base (RTB). -Note that for groups, the average damage of the complete group will be calculated. -So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage treshold will be 0.25.
- -Parameter
--
-
-
-
-
- -#number PatrolDamageTreshold: -The treshold in percentage (between 0 and 1) when the AI is considered to be damaged.
-
Return value
- -#AI_A2A: -self
- -
- -
-
-
-
-
- - - -AI_A2A:ManageFuel(PatrolFuelTresholdPercentage, PatrolOutOfFuelOrbitTime) - - -
-
-
-
When the AI is out of fuel, it is required that a new AI is started, before the old AI can return to the home base.
- - -Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated. -When the fuel treshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targetted to the AI_A2A. -Once the time is finished, the old AI will return to the base.
- -Parameters
--
-
-
-
-
- -#number PatrolFuelTresholdPercentage: -The treshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.
- -
-
-
- -#number PatrolOutOfFuelOrbitTime: -The amount of seconds the out of fuel AIControllable will orbit before returning to the base.
-
Return value
- -#AI_A2A: -self
- -
-
-
-
@@ -1436,6 +1363,40 @@ self
- + +AI_A2A:SetDamageTreshold(PatrolDamageTreshold) + + +
-
+
+
When the AI is damaged beyond a certain treshold, it is required that the AI returns to the home base.
+ + +However, damage cannot be foreseen early on. +Therefore, when the damage treshold is reached, +the AI will return immediately to the home base (RTB). +Note that for groups, the average damage of the complete group will be calculated. +So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage treshold will be 0.25.
+ +Parameter
+-
+
-
+
+
+ +#number PatrolDamageTreshold: +The treshold in percentage (between 0 and 1) when the AI is considered to be damaged.
+
Return value
+ +#AI_A2A: +self
+ +
+ -
+
+
- + AI_A2A:SetDispatcher(Dispatcher) @@ -1457,6 +1418,44 @@ self
- + +AI_A2A:SetFuelTreshold(PatrolFuelTresholdPercentage, PatrolOutOfFuelOrbitTime) + + +
-
+
+
When the AI is out of fuel, it is required that a new AI is started, before the old AI can return to the home base.
+ + +Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated. +When the fuel treshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targetted to the AI_A2A. +Once the time is finished, the old AI will return to the base.
+ +Parameters
+-
+
-
+
+
+ +#number PatrolFuelTresholdPercentage: +The treshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.
+ -
+
+
+ +#number PatrolOutOfFuelOrbitTime: +The amount of seconds the out of fuel AIControllable will orbit before returning to the base.
+
Return value
+ +#AI_A2A: +self
+ +
+ -
+
+
-
+
AI_A2A:SetHomeAirbase(HomeAirbase)
diff --git a/docs/Documentation/AI_A2A_Dispatcher.html b/docs/Documentation/AI_A2A_Dispatcher.html
index 1d27effd0..3067788d2 100644
--- a/docs/Documentation/AI_A2A_Dispatcher.html
+++ b/docs/Documentation/AI_A2A_Dispatcher.html
@@ -288,7 +288,7 @@ Per one, two, three, four?
AI_A2A_GCICAP - AI_A2A_GCICAP class, extends AI#AIA2ADISPATCHER
+AI_A2A_GCICAP class, extends AIA2ADispatcher#AIA2ADISPATCHER
@@ -602,6 +602,18 @@ Per one, two, three, four?
AI_A2A_DISPATCHER:SetBorderZone(BorderZone) Define a border area to simulate a cold war scenario.
++ +AI_A2A_DISPATCHER:SetDefaultDamageTreshold(DamageTreshold) ++ +Set the default damage treshold when defenders will RTB.
++ AI_A2A_DISPATCHER:SetDefaultFuelTreshold(FuelTreshold) ++ Set the default fuel treshold when defenders will RTB or Refuel in the air.
@@ -855,9 +867,15 @@ Per one, two, three, four? - +AI_A2A_GCICAP:New(<, GroupingRadius, EWRPrefixes, TemplatePrefixes, CAPPrefixes, CapLimit, EngageRadius) +AI_A2A_GCICAP:New(EWRPrefixes, TemplatePrefixes, CapPrefixes, CapLimit, GroupingRadius, EngageRadius, GciRadius) AIA2AGCICAP constructor.
++ AI_A2A_GCICAP:NewWithBorder(EWRPrefixes, TemplatePrefixes, BorderPrefix, CapPrefixes, CapLimit, GroupingRadius, EngageRadius, GciRadius) ++ AIA2AGCICAP constructor with border.
@@ -1119,16 +1137,7 @@ while defining which plane types are being used by the squadron and how many res - AIA2ADISPATCHER.SetSquadronTakeoffFromRunway() will spawn new aircraft at the runway at the airfield.
-The default landing method is to spawn new aircraft directly in the air. -The default takeoff method can be set for ALL squadrons that don't have an individual takeoff method configured.
- --
-
- AIA2ADISPATCHER.SetDefaultTakeoff() is the generic configuration method to control takeoff by default from the air, hot, cold or from the runway. See the method for further details. -
- AIA2ADISPATCHER.SetDefaultTakeoffInAir() will spawn by default new aircraft from the squadron directly in the air. -
- AIA2ADISPATCHER.SetDefaultTakeoffFromParkingCold() will spawn by default new aircraft in without running engines at a parking spot at the airfield. -
- AIA2ADISPATCHER.SetDefaultTakeoffFromParkingHot() will spawn by default new aircraft in with running engines at a parking spot at the airfield. -
- AIA2ADISPATCHER.SetDefaultTakeoffFromRunway() will spawn by default new aircraft at the runway at the airfield. -
The default landing method is to spawn new aircraft directly in the air.
Use these methods to fine-tune for specific airfields that are known to create bottlenecks, or have reduced airbase efficiency. The more and the longer aircraft need to taxi at an airfield, the more risk there is that:
@@ -1171,15 +1180,6 @@ And for a couple of squadrons overrides this default method.- AIA2ADISPATCHER.SetSquadronLandingAtEngineShutdown() will despawn the returning aircraft when the aircraft has returned to its parking spot and has turned off its engines.
-The default landing method can be set for ALL squadrons that don't have an individual landing method configured.
- --
-
- AIA2ADISPATCHER.SetDefaultLanding() is the generic configuration method to control by default landing, namely despawn the aircraft near the airfield in the air, right after landing, or at engine shutdown. -
- AIA2ADISPATCHER.SetDefaultLandingNearAirbase() will despawn by default the returning aircraft in the air when near the airfield. -
- AIA2ADISPATCHER.SetDefaultLandingAtRunway() will despawn by default the returning aircraft directly after landing at the runway. -
- AIA2ADISPATCHER.SetDefaultLandingAtEngineShutdown() will despawn by default the returning aircraft when the aircraft has returned to its parking spot and has turned off its engines. -
You can use these methods to minimize the airbase coodination overhead and to increase the airbase efficiency. When there are lots of aircraft returning for landing, at the same airbase, the takeoff process will be halted, which can cause a complete failure of the A2A defense system, as no new CAP or GCI planes can takeoff. @@ -1216,11 +1216,7 @@ a GCI needs to be started, the GCI flights will be grouped as follows: Group 1 o
The grouping value is set for a Squadron, and can be dynamically adjusted during mission execution, so to adjust the defense flights grouping when the tactical situation changes.
-The default grouping value can be set for ALL squadrons that don't have an individual grouping value configured.
- -Use the method AIA2ADISPATCHER.SetDefaultGrouping() to set the default grouping of spawned airplanes for all squadrons.
- -6.4. Balance or setup effectiveness of the air defenses in case of GCI
+6.4. Overhead and Balance the effectiveness of the air defenses in case of GCI
The effectiveness can be set with the overhead parameter. This is a number that is used to calculate the amount of Units that dispatching command will allocate to GCI in surplus of detected amount of units. The default value of the overhead parameter is 1.0, which means equal balance.
@@ -1246,10 +1242,6 @@ multiplied by the Overhead and rounded up to the smallest integer.The overhead value is set for a Squadron, and can be dynamically adjusted during mission execution, so to adjust the defense overhead when the tactical situation changes.
-The default overhead value can be set for ALL squadrons that don't have an individual overhead value configured.
- -Use the AIA2ADISPATCHER.SetDefaultOverhead() method can be used to set the default the defense strength for ALL squadrons.
-7. Setup a squadron for CAP
7.1. Set the CAP zones
@@ -1355,9 +1347,70 @@ too short will mean that the intruders may have alraedy passed the ideal interce Use the method AIA2ADISPATCHER.SetTacticalDisplay() to switch on the tactical display panel. The default will not show this panel. Note that there may be some performance impact if this panel is shown. -10. Q & A:
+10. Defaults settings.
-10.1. Which countries will be selected for each coalition?
+This provides a good overview of the different parameters that are setup or hardcoded by default. +For some default settings, a method is available that allows you to tweak the defaults.
+ +10.1. Default takeoff method.
+ +The default takeoff method is set to in the air, which means that new spawned airplanes will be spawned directly in the air above the airbase by default.
+ +The default takeoff method can be set for ALL squadrons that don't have an individual takeoff method configured.
+ +-
+
- AIA2ADISPATCHER.SetDefaultTakeoff() is the generic configuration method to control takeoff by default from the air, hot, cold or from the runway. See the method for further details. +
- AIA2ADISPATCHER.SetDefaultTakeoffInAir() will spawn by default new aircraft from the squadron directly in the air. +
- AIA2ADISPATCHER.SetDefaultTakeoffFromParkingCold() will spawn by default new aircraft in without running engines at a parking spot at the airfield. +
- AIA2ADISPATCHER.SetDefaultTakeoffFromParkingHot() will spawn by default new aircraft in with running engines at a parking spot at the airfield. +
- AIA2ADISPATCHER.SetDefaultTakeoffFromRunway() will spawn by default new aircraft at the runway at the airfield. +
10.2. Default landing method.
+ +The default landing method is set to near the airbase, which means that returning airplanes will be despawned directly in the air by default.
+ +The default landing method can be set for ALL squadrons that don't have an individual landing method configured.
+ +-
+
- AIA2ADISPATCHER.SetDefaultLanding() is the generic configuration method to control by default landing, namely despawn the aircraft near the airfield in the air, right after landing, or at engine shutdown. +
- AIA2ADISPATCHER.SetDefaultLandingNearAirbase() will despawn by default the returning aircraft in the air when near the airfield. +
- AIA2ADISPATCHER.SetDefaultLandingAtRunway() will despawn by default the returning aircraft directly after landing at the runway. +
- AIA2ADISPATCHER.SetDefaultLandingAtEngineShutdown() will despawn by default the returning aircraft when the aircraft has returned to its parking spot and has turned off its engines. +
10.3. Default overhead.
+ +The default overhead is set to 1. That essentially means that there isn't any overhead set by default.
+ +The default overhead value can be set for ALL squadrons that don't have an individual overhead value configured.
+ +Use the AIA2ADISPATCHER.SetDefaultOverhead() method can be used to set the default overhead or defense strength for ALL squadrons.
+ +10.4. Default grouping.
+ +The default grouping is set to one airplane. That essentially means that there won't be any grouping applied by default.
+ +The default grouping value can be set for ALL squadrons that don't have an individual grouping value configured.
+ +Use the method AIA2ADISPATCHER.SetDefaultGrouping() to set the default grouping of spawned airplanes for all squadrons.
+ +10.5. RTB fuel treshold.
+ +When an airplane gets out of fuel to a certain %-tage, which is 15% (0.15), it will go RTB, and will be replaced with a new airplane when applicable.
+ +Use the method AIA2ADISPATCHER.SetDefaultFuelTreshold() to set the default fuel treshold of spawned airplanes for all squadrons.
+ +10.6. RTB damage treshold.
+ +When an airplane is damaged to a certain %-tage, which is 40% (0.40), it will go RTB, and will be replaced with a new airplane when applicable.
+ +Use the method AIA2ADISPATCHER.SetDefaultDamageTreshold() to set the default damage treshold of spawned airplanes for all squadrons.
+ + +11. Q & A:
+ +11.1. Which countries will be selected for each coalition?
Which countries are assigned to a coalition influences which units are available to the coalition. For example because the mission calls for a EWR radar on the blue side the Ukraine might be chosen as a blue country @@ -1365,7 +1418,7 @@ so that the 55G6 EWR radar unit is available to blue.
-
Some countries assign different tasking to aircraft, for example Germany assigns the CAP task to F-4E Phantoms but the USA does not.
Therefore if F4s are wanted as a coalition’s CAP or GCI aircraft Germany will need to be assigned to that coalition.10.2. Country, type, load out, skill and skins for CAP and GCI aircraft?
+11.2. Country, type, load out, skill and skins for CAP and GCI aircraft?
- Note these can be from any countries within the coalition but must be an aircraft with one of the main tasks being “CAP”. @@ -1389,7 +1442,7 @@ Therefore if F4s are wanted as a coalition’s CAP or GCI aircraft Germany will
-
-
AI_A2A_GCICAP class, extends AI#AIA2ADISPATCHER
+AI_A2A_GCICAP class, extends AIA2ADispatcher#AIA2ADISPATCHER
@@ -3007,6 +3060,84 @@ or- + +AI_A2A_DISPATCHER:SetDefaultDamageTreshold(DamageTreshold) + + +
-
+
+
Set the default damage treshold when defenders will RTB.
+ + +The default damage treshold is by default set to 40%, which means that when the airplane is 40% damaged, it will go RTB.
+ +Parameter
+-
+
-
+
+
+ +#number DamageTreshold: +A decimal number between 0 and 1, that expresses the %-tage of the damage treshold before going RTB.
+
Return value
+ + + + +Usage:
+
+ ++ -- Now Setup the A2A dispatcher, and initialize it using the Detection object. + A2ADispatcher = AI_A2A_DISPATCHER:New( Detection ) + + -- Now Setup the default damage treshold. + A2ADispatcher:SetDefaultDamageTreshold( 0.90 ) -- Go RTB when the airplane 90% damaged. +
+ -
+
+
-
+
- + + +AI_A2A_DISPATCHER:SetDefaultFuelTreshold(FuelTreshold) + + +
-
+
+
Set the default fuel treshold when defenders will RTB or Refuel in the air.
+ + +The fuel treshold is by default set to 15%, which means that an airplane will stay in the air until 15% of its fuel has been consumed.
+ +Parameter
+-
+
-
+
+
+ +#number FuelTreshold: +A decimal number between 0 and 1, that expresses the %-tage of the treshold of fuel remaining in the tank when the plane will go RTB or Refuel.
+
Return value
+ + + + +Usage:
+
+ ++ -- Now Setup the A2A dispatcher, and initialize it using the Detection object. + A2ADispatcher = AI_A2A_DISPATCHER:New( Detection ) + + -- Now Setup the default fuel treshold. + A2ADispatcher:SetDefaultRefuelTreshold( 0.30 ) -- Go RTB when only 30% of fuel remaining in the tank. +
+ -
+
+
-
+
-
+
AI_A2A_DISPATCHER:SetDefaultGrouping(Grouping)
@@ -4590,7 +4721,7 @@ Provide a value of true to display every 30 seconds a tactical
- -AI_A2A_GCICAP:New(<, GroupingRadius, EWRPrefixes, TemplatePrefixes, CAPPrefixes, CapLimit, EngageRadius) +AI_A2A_GCICAP:New(EWRPrefixes, TemplatePrefixes, CapPrefixes, CapLimit, GroupingRadius, EngageRadius, GciRadius)
-
@@ -4601,8 +4732,26 @@ Provide a value of true to display every 30 seconds a tactical
-
-
+#list <: -string> EWRPrefixes A list of prefixes that of groups that setup the Early Warning Radar network.
+ +#string EWRPrefixes: +A list of prefixes that of groups that setup the Early Warning Radar network.
+ -
+
+
+ +#string TemplatePrefixes: +A list of template prefixes.
+ -
+
+
+ +#string CapPrefixes: +A list of CAP zone prefixes (polygon zones).
+ -
+
+
#number CapLimit: +A number of how many CAP maximum will be spawned. - @@ -4614,27 +4763,92 @@ For airplanes, 6000 (6km) is recommended, and is also the default value of this
-
-
+EWRPrefixes:#number EngageRadius: +The radius in meters wherein detected airplanes will be engaged by airborne defenders without a task. -
-
+TemplatePrefixes:
+ +#number GciRadius: +The radius in meters wherein detected airplanes will GCI.
+
Return value
+ + + + +Usage:
+
+ ++ -- Set a new AI A2A GCICAP object, based on an EWR network with a 30 km grouping radius + -- This for ground and awacs installations. + + A2ADispatcher = AI_A2A_GCICAP:New( { "BlueEWRGroundRadars", "BlueEWRAwacs" }, 30000 ) +
+ -
-
-
+
- + + +AI_A2A_GCICAP:NewWithBorder(EWRPrefixes, TemplatePrefixes, BorderPrefix, CapPrefixes, CapLimit, GroupingRadius, EngageRadius, GciRadius) + + +
-
+
+
AIA2AGCICAP constructor with border.
+ +Parameters
+-
+
-
+
+
#string EWRPrefixes: +A list of prefixes that of groups that setup the Early Warning Radar network. -
-
+CAPPrefixes:#string TemplatePrefixes: +A list of template prefixes. -
-
+CapLimit:#string BorderPrefix: +A Border Zone Prefix. -
-
+EngageRadius:
+ +#string CapPrefixes: +A list of CAP zone prefixes (polygon zones).
+ -
+
+
+ +#number CapLimit: +A number of how many CAP maximum will be spawned.
+ -
+
+
+ +#number GroupingRadius: +The radius in meters wherein detected planes are being grouped as one target area. +For airplanes, 6000 (6km) is recommended, and is also the default value of this parameter.
+ -
+
+
+ +#number EngageRadius: +The radius in meters wherein detected airplanes will be engaged by airborne defenders without a task.
+ -
+
+
#number GciRadius: +The radius in meters wherein detected airplanes will GCI.
- - + #number DETECTION_BASE.DetectionInterval diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html index 177f34281..e0276d335 100644 --- a/docs/Documentation/Fsm.html +++ b/docs/Documentation/Fsm.html @@ -1598,7 +1598,7 @@ A string defining the start state.
- - #string + FSM._StartState @@ -1897,6 +1897,7 @@ A string defining the start state.
- + FSM.current diff --git a/docs/Documentation/Settings.html b/docs/Documentation/Settings.html index 318968720..6836574d8 100644 --- a/docs/Documentation/Settings.html +++ b/docs/Documentation/Settings.html @@ -1142,7 +1142,7 @@ true if metric.
-
-
+ #boolean
SETTINGS.Metric
diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html
index a0a416bf7..74346e859 100644
--- a/docs/Documentation/Spawn.html
+++ b/docs/Documentation/Spawn.html
@@ -2194,9 +2194,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.
-
-
+
+
-
@@ -2729,9 +2726,6 @@ when nothing was spawned.
-
-
Overwrite unit names by default with group name.
- - - + #boolean SPAWN.SpawnUnControlled diff --git a/docs/Documentation/SpawnStatic.html b/docs/Documentation/SpawnStatic.html index bc91b9624..d8aa5e633 100644 --- a/docs/Documentation/SpawnStatic.html +++ b/docs/Documentation/SpawnStatic.html @@ -436,6 +436,7 @@ 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 349f0de89..1f1e13d4f 100644
--- a/docs/Documentation/Task_Cargo.html
+++ b/docs/Documentation/Task_Cargo.html
@@ -566,7 +566,6 @@ based on the tasking capabilities defined in Task#TA
-
-
FSM_PROCESS.DeployZone
@@ -631,7 +630,7 @@ based on the tasking capabilities defined in Task#TA
- - #number + TASK_CARGO.CargoLimit
-
-
FSM_PROCESS.DeployZone
@@ -631,7 +630,7 @@ based on the tasking capabilities defined in Task#TA
-
@@ -3129,7 +3123,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
-
+
-
+