Documentation

This commit is contained in:
FlightControl
2017-06-14 11:13:14 +02:00
parent 95ce44f2d8
commit 385dba63d9
11 changed files with 125 additions and 132 deletions

View File

@@ -974,76 +974,77 @@ But you can also define other zone types instead, like moving zones.</p>
<p>Find the following mission script as an example:</p>
<p> -- Define a SET<em>GROUP object that builds a collection of groups that define the EWR network.
<pre><code> -- Define a SET_GROUP object that builds a collection of groups that define the EWR network.
-- Here we build the network with all the groups that have a name starting with DF CCCP AWACS and DF CCCP EWR.
DetectionSetGroup = SET</em>GROUP:New()
DetectionSetGroup = SET_GROUP:New()
DetectionSetGroup:FilterPrefixes( { "DF CCCP AWACS", "DF CCCP EWR" } )
DetectionSetGroup:FilterStart()</p>
DetectionSetGroup:FilterStart()
<p> -- Setup the A2A dispatcher, and initialize it.
A2ADispatcher = AI<em>A2A</em>DISPATCHER:New( DetectionSetGroup, 30000 )</p>
-- Setup the A2A dispatcher, and initialize it.
A2ADispatcher = AI_A2A_DISPATCHER:New( DetectionSetGroup, 30000 )
<p> -- Initialize the dispatcher, setting up a border zone. This is a polygon,
-- Initialize the dispatcher, setting up a border zone. This is a polygon,
-- which takes the waypoints of a late activated group with the name CCCP Border as the boundaries of the border area.
-- Any enemy crossing this border will be engaged.
CCCPBorderZone = ZONE_POLYGON:New( "CCCP Border", GROUP:FindByName( "CCCP Border" ) )
A2ADispatcher:SetBorderZone( { CCCPBorderZone } )</p>
A2ADispatcher:SetBorderZone( { CCCPBorderZone } )
<p> -- Initialize the dispatcher, setting up a radius of 100km where any airborne friendly
-- Initialize the dispatcher, setting up a radius of 100km where any airborne friendly
-- without an assignment within 100km radius from a detected target, will engage that target.
A2ADispatcher:SetEngageRadius( 300000 )</p>
A2ADispatcher:SetEngageRadius( 300000 )
<p> -- Setup the squadrons.
A2ADispatcher:SetSquadron( "Mineralnye", AIRBASE.Caucasus.Mineralnye<em>Vody, { "SQ CCCP SU-27" }, 20 )
A2ADispatcher:SetSquadron( "Maykop", AIRBASE.Caucasus.Maykop</em>Khanskaya, { "SQ CCCP MIG-31" }, 20 )
-- Setup the squadrons.
A2ADispatcher:SetSquadron( "Mineralnye", AIRBASE.Caucasus.Mineralnye_Vody, { "SQ CCCP SU-27" }, 20 )
A2ADispatcher:SetSquadron( "Maykop", AIRBASE.Caucasus.Maykop_Khanskaya, { "SQ CCCP MIG-31" }, 20 )
A2ADispatcher:SetSquadron( "Mozdok", AIRBASE.Caucasus.Mozdok, { "SQ CCCP MIG-31" }, 20 )
A2ADispatcher:SetSquadron( "Sochi", AIRBASE.Caucasus.Sochi_Adler, { "SQ CCCP SU-27" }, 20 )
A2ADispatcher:SetSquadron( "Novo", AIRBASE.Caucasus.Novorossiysk, { "SQ CCCP SU-27" }, 20 )</p>
A2ADispatcher:SetSquadron( "Novo", AIRBASE.Caucasus.Novorossiysk, { "SQ CCCP SU-27" }, 20 )
<p> -- Setup the overhead
-- Setup the overhead
A2ADispatcher:SetSquadronOverhead( "Mineralnye", 1.2 )
A2ADispatcher:SetSquadronOverhead( "Maykop", 1 )
A2ADispatcher:SetSquadronOverhead( "Mozdok", 1.5 )
A2ADispatcher:SetSquadronOverhead( "Sochi", 1 )
A2ADispatcher:SetSquadronOverhead( "Novo", 1 )</p>
A2ADispatcher:SetSquadronOverhead( "Novo", 1 )
<p> -- Setup the Grouping
-- Setup the Grouping
A2ADispatcher:SetSquadronGrouping( "Mineralnye", 2 )
A2ADispatcher:SetSquadronGrouping( "Sochi", 2 )
A2ADispatcher:SetSquadronGrouping( "Novo", 3 )</p>
A2ADispatcher:SetSquadronGrouping( "Novo", 3 )
<p> -- Setup the Takeoff methods
A2ADispatcher:SetSquadronTakeoff( "Mineralnye", AI<em>A2A</em>DISPATCHER.Takeoff.Air )
-- Setup the Takeoff methods
A2ADispatcher:SetSquadronTakeoff( "Mineralnye", AI_A2A_DISPATCHER.Takeoff.Air )
A2ADispatcher:SetSquadronTakeoffInAir( "Sochi" )
A2ADispatcher:SetSquadronTakeoffFromRunway( "Mozdok" )
A2ADispatcher:SetSquadronTakeoffFromParkingCold( "Maykop" )
A2ADispatcher:SetSquadronTakeoffFromParkingHot( "Novo" )</p>
A2ADispatcher:SetSquadronTakeoffFromParkingHot( "Novo" )
<p> -- Setup the Landing methods
-- Setup the Landing methods
A2ADispatcher:SetSquadronLandingAtRunway( "Mineralnye" )
A2ADispatcher:SetSquadronLandingNearAirbase( "Sochi" )
A2ADispatcher:SetSquadronLandingAtEngineShutdown( "Mozdok" )
A2ADispatcher:SetSquadronLandingNearAirbase( "Maykop" )
A2ADispatcher:SetSquadronLanding( "Novo", AI<em>A2A</em>DISPATCHER.Landing.AtRunway )</p>
A2ADispatcher:SetSquadronLanding( "Novo", AI_A2A_DISPATCHER.Landing.AtRunway )
<p> -- CAP Squadron execution.
-- CAP Squadron execution.
CAPZoneEast = ZONE_POLYGON:New( "CAP Zone East", GROUP:FindByName( "CAP Zone East" ) )
A2ADispatcher:SetSquadronCap( "Mineralnye", CAPZoneEast, 4000, 10000, 500, 600, 800, 900 )
A2ADispatcher:SetSquadronCapInterval( "Mineralnye", 2, 30, 60, 1 )</p>
A2ADispatcher:SetSquadronCapInterval( "Mineralnye", 2, 30, 60, 1 )
<p> CAPZoneWest = ZONE_POLYGON:New( "CAP Zone West", GROUP:FindByName( "CAP Zone West" ) )
CAPZoneWest = ZONE_POLYGON:New( "CAP Zone West", GROUP:FindByName( "CAP Zone West" ) )
A2ADispatcher:SetSquadronCap( "Sochi", CAPZoneWest, 4000, 8000, 600, 800, 800, 1200, "BARO" )
A2ADispatcher:SetSquadronCapInterval( "Sochi", 2, 30, 120, 1 )</p>
A2ADispatcher:SetSquadronCapInterval( "Sochi", 2, 30, 120, 1 )
<p> CAPZoneMiddle = ZONE:New( "CAP Zone Middle")
CAPZoneMiddle = ZONE:New( "CAP Zone Middle")
A2ADispatcher:SetSquadronCap( "Maykop", CAPZoneMiddle, 4000, 8000, 600, 800, 800, 1200, "RADIO" )
A2ADispatcher:SetSquadronCapInterval( "Sochi", 2, 30, 120, 1 )</p>
A2ADispatcher:SetSquadronCapInterval( "Sochi", 2, 30, 120, 1 )
<p> -- GCI Squadron execution.
-- GCI Squadron execution.
A2ADispatcher:SetSquadronGci( "Mozdok", 900, 1200 )
A2ADispatcher:SetSquadronGci( "Novo", 900, 2100 )
A2ADispatcher:SetSquadronGci( "Maykop", 900, 1200 )</p>
A2ADispatcher:SetSquadronGci( "Maykop", 900, 1200 )
</code></pre>
<h4>8.5.1. Script the EWR network</h4>