mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2026-08-14 13:18:48 +00:00
UPDATE: OPS function params
- Added (Optional) to param descriptions for params that have default values
This commit is contained in:
@@ -1003,8 +1003,8 @@ ATIS.version = "1.0.1"
|
|||||||
--- Create a new ATIS class object for a specific airbase.
|
--- Create a new ATIS class object for a specific airbase.
|
||||||
-- @param #ATIS self
|
-- @param #ATIS self
|
||||||
-- @param #string AirbaseName Name of the airbase.
|
-- @param #string AirbaseName Name of the airbase.
|
||||||
-- @param #number Frequency Radio frequency in MHz. Default 143.00 MHz. When using **SRS** this can be passed as a table of multiple frequencies.
|
-- @param #number Frequency (Optional) Radio frequency in MHz. Default 143.00 MHz. When using **SRS** this can be passed as a table of multiple frequencies.
|
||||||
-- @param #number Modulation Radio modulation: 0=AM, 1=FM. Default 0=AM. See `radio.modulation.AM` and `radio.modulation.FM` enumerators. When using **SRS** this can be passed as a table of multiple modulations.
|
-- @param #number Modulation (Optional) Radio modulation: 0=AM, 1=FM. Default 0=AM. See `radio.modulation.AM` and `radio.modulation.FM` enumerators. When using **SRS** this can be passed as a table of multiple modulations.
|
||||||
-- @return #ATIS self
|
-- @return #ATIS self
|
||||||
function ATIS:New(AirbaseName, Frequency, Modulation)
|
function ATIS:New(AirbaseName, Frequency, Modulation)
|
||||||
|
|
||||||
@@ -1161,9 +1161,9 @@ end
|
|||||||
|
|
||||||
--- Set sound files folder within miz file (not your local hard drive!).
|
--- Set sound files folder within miz file (not your local hard drive!).
|
||||||
-- @param #ATIS self
|
-- @param #ATIS self
|
||||||
-- @param #string pathMain Path to folder containing main sound files. Default "ATIS Soundfiles/". Mind the slash "/" at the end!
|
-- @param #string pathMain (Optional) Path to folder containing main sound files. Default "ATIS Soundfiles/". Mind the slash "/" at the end!
|
||||||
-- @param #string pathAirports Path folder containing the airport names sound files. Default is `"ATIS Soundfiles/<Map Name>"`, *e.g.* `"ATIS Soundfiles/Caucasus/"`.
|
-- @param #string pathAirports (Optional) Path folder containing the airport names sound files. Default is `"ATIS Soundfiles/<Map Name>"`, *e.g.* `"ATIS Soundfiles/Caucasus/"`.
|
||||||
-- @param #string pathNato Path folder containing the NATO alphabet sound files. Default is "ATIS Soundfiles/NATO Alphabet/".
|
-- @param #string pathNato (Optional) Path folder containing the NATO alphabet sound files. Default is "ATIS Soundfiles/NATO Alphabet/".
|
||||||
-- @return #ATIS self
|
-- @return #ATIS self
|
||||||
function ATIS:SetSoundfilesPath( pathMain, pathAirports, pathNato )
|
function ATIS:SetSoundfilesPath( pathMain, pathAirports, pathNato )
|
||||||
self.soundpath = tostring( pathMain or "ATIS Soundfiles/" )
|
self.soundpath = tostring( pathMain or "ATIS Soundfiles/" )
|
||||||
@@ -1283,8 +1283,8 @@ end
|
|||||||
|
|
||||||
--- Set the active runway for landing.
|
--- Set the active runway for landing.
|
||||||
-- @param #ATIS self
|
-- @param #ATIS self
|
||||||
-- @param #string runway : Name of the runway, e.g. "31" or "02L" or "90R". If not given, the runway is determined from the wind direction.
|
-- @param #string runway (Optional) Name of the runway, e.g. "31" or "02L" or "90R". If not given, the runway is determined from the wind direction.
|
||||||
-- @param #boolean preferleft : If true, perfer the left runway. If false, prefer the right runway. If nil (default), do not care about left or right.
|
-- @param #boolean preferleft (Optional) If true, perfer the left runway. If false, prefer the right runway. If nil (default), do not care about left or right.
|
||||||
-- @return #ATIS self
|
-- @return #ATIS self
|
||||||
function ATIS:SetActiveRunwayLanding(runway, preferleft)
|
function ATIS:SetActiveRunwayLanding(runway, preferleft)
|
||||||
self.airbase:SetActiveRunwayLanding(runway,preferleft)
|
self.airbase:SetActiveRunwayLanding(runway,preferleft)
|
||||||
@@ -1294,7 +1294,7 @@ end
|
|||||||
--- Set the active runway for take-off.
|
--- Set the active runway for take-off.
|
||||||
-- @param #ATIS self
|
-- @param #ATIS self
|
||||||
-- @param #string runway : Name of the runway, e.g. "31" or "02L" or "90R". If not given, the runway is determined from the wind direction.
|
-- @param #string runway : Name of the runway, e.g. "31" or "02L" or "90R". If not given, the runway is determined from the wind direction.
|
||||||
-- @param #boolean preferleft : If true, perfer the left runway. If false, prefer the right runway. If nil (default), do not care about left or right.
|
-- @param #boolean preferleft (Optional) If true, perfer the left runway. If false, prefer the right runway. If nil (default), do not care about left or right.
|
||||||
-- @return #ATIS self
|
-- @return #ATIS self
|
||||||
function ATIS:SetActiveRunwayTakeoff(runway,preferleft)
|
function ATIS:SetActiveRunwayTakeoff(runway,preferleft)
|
||||||
self.airbase:SetActiveRunwayTakeoff(runway,preferleft)
|
self.airbase:SetActiveRunwayTakeoff(runway,preferleft)
|
||||||
@@ -1328,7 +1328,7 @@ end
|
|||||||
|
|
||||||
--- Set radio power. Note that this only applies if no relay unit is used.
|
--- Set radio power. Note that this only applies if no relay unit is used.
|
||||||
-- @param #ATIS self
|
-- @param #ATIS self
|
||||||
-- @param #number power Radio power in Watts. Default 100 W.
|
-- @param #number power (Optional) Radio power in Watts. Default 100 W.
|
||||||
-- @return #ATIS self
|
-- @return #ATIS self
|
||||||
function ATIS:SetRadioPower( power )
|
function ATIS:SetRadioPower( power )
|
||||||
self.power = power or 100
|
self.power = power or 100
|
||||||
@@ -1337,7 +1337,7 @@ end
|
|||||||
|
|
||||||
--- Use F10 map mark points.
|
--- Use F10 map mark points.
|
||||||
-- @param #ATIS self
|
-- @param #ATIS self
|
||||||
-- @param #boolean switch If *true* or *nil*, marks are placed on F10 map. If *false* this feature is set to off (default).
|
-- @param #boolean switch (Optional) If *true* or *nil*, marks are placed on F10 map. If *false* this feature is set to off (default).
|
||||||
-- @return #ATIS self
|
-- @return #ATIS self
|
||||||
function ATIS:SetMapMarks( switch )
|
function ATIS:SetMapMarks( switch )
|
||||||
if switch == nil or switch == true then
|
if switch == nil or switch == true then
|
||||||
@@ -1406,7 +1406,7 @@ end
|
|||||||
|
|
||||||
--- Set duration how long subtitles are displayed.
|
--- Set duration how long subtitles are displayed.
|
||||||
-- @param #ATIS self
|
-- @param #ATIS self
|
||||||
-- @param #number duration Duration in seconds. Default 10 seconds.
|
-- @param #number duration (Optional) Duration in seconds. Default 10 seconds.
|
||||||
-- @return #ATIS self
|
-- @return #ATIS self
|
||||||
function ATIS:SetSubtitleDuration( duration )
|
function ATIS:SetSubtitleDuration( duration )
|
||||||
self.subduration = tonumber( duration or 10 )
|
self.subduration = tonumber( duration or 10 )
|
||||||
@@ -1449,7 +1449,7 @@ end
|
|||||||
--- Set relative humidity. This is used to approximately calculate the dew point.
|
--- Set relative humidity. This is used to approximately calculate the dew point.
|
||||||
-- Note that the dew point is only an artificial information as DCS does not have an atmospheric model that includes humidity (yet).
|
-- Note that the dew point is only an artificial information as DCS does not have an atmospheric model that includes humidity (yet).
|
||||||
-- @param #ATIS self
|
-- @param #ATIS self
|
||||||
-- @param #number Humidity Relative Humidity, i.e. a number between 0 and 100 %. Default is 50 %.
|
-- @param #number Humidity (Optional) Relative Humidity, i.e. a number between 0 and 100 %. Default is 50 %.
|
||||||
-- @return #ATIS self
|
-- @return #ATIS self
|
||||||
function ATIS:SetRelativeHumidity( Humidity )
|
function ATIS:SetRelativeHumidity( Humidity )
|
||||||
self.relHumidity = Humidity or 50
|
self.relHumidity = Humidity or 50
|
||||||
@@ -1524,7 +1524,7 @@ end
|
|||||||
-- Or you make your life simple and just include the sign so you don't have to bother about East/West.
|
-- Or you make your life simple and just include the sign so you don't have to bother about East/West.
|
||||||
--
|
--
|
||||||
-- @param #ATIS self
|
-- @param #ATIS self
|
||||||
-- @param #number magvar Magnetic variation in degrees. Positive for easterly and negative for westerly variation. Default is magnatic declinaton of the used map, c.f. @{Utilities.Utils#UTILS.GetMagneticDeclination}.
|
-- @param #number magvar (Optional) Magnetic variation in degrees. Positive for easterly and negative for westerly variation. Default is magnatic declinaton of the used map, c.f. @{Utilities.Utils#UTILS.GetMagneticDeclination}.
|
||||||
-- @return #ATIS self
|
-- @return #ATIS self
|
||||||
function ATIS:SetMagneticDeclination( magvar )
|
function ATIS:SetMagneticDeclination( magvar )
|
||||||
self.magvar = magvar or UTILS.GetMagneticDeclination()
|
self.magvar = magvar or UTILS.GetMagneticDeclination()
|
||||||
@@ -1654,7 +1654,7 @@ end
|
|||||||
|
|
||||||
--- Place marks with runway data on the F10 map.
|
--- Place marks with runway data on the F10 map.
|
||||||
-- @param #ATIS self
|
-- @param #ATIS self
|
||||||
-- @param #boolean markall If true, mark all runways of the map. By default only the current ATIS runways are marked.
|
-- @param #boolean markall (Optional) If true, mark all runways of the map. By default only the current ATIS runways are marked.
|
||||||
function ATIS:MarkRunways( markall )
|
function ATIS:MarkRunways( markall )
|
||||||
local airbases = AIRBASE.GetAllAirbases()
|
local airbases = AIRBASE.GetAllAirbases()
|
||||||
for _, _airbase in pairs( airbases ) do
|
for _, _airbase in pairs( airbases ) do
|
||||||
@@ -1667,11 +1667,11 @@ end
|
|||||||
|
|
||||||
--- Use SRS Simple-Text-To-Speech for transmissions. No sound files necessary.`SetSRS()` will try to use as many attributes configured with @{Sound.SRS#MSRS.LoadConfigFile}() as possible.
|
--- Use SRS Simple-Text-To-Speech for transmissions. No sound files necessary.`SetSRS()` will try to use as many attributes configured with @{Sound.SRS#MSRS.LoadConfigFile}() as possible.
|
||||||
-- @param #ATIS self
|
-- @param #ATIS self
|
||||||
-- @param #string PathToSRS Path to SRS directory (only necessary if SRS exe backend is used).
|
-- @param #string PathToSRS (Optional) Path to SRS directory (only necessary if SRS exe backend is used).
|
||||||
-- @param #string Gender Gender: "male" or "female" (default).
|
-- @param #string Gender (Optional) Gender: "male" or "female" (default).
|
||||||
-- @param #string Culture Culture, e.g. "en-GB" (default).
|
-- @param #string Culture (Optional) Culture, e.g. "en-GB" (default).
|
||||||
-- @param #string Voice Specific voice. Overrides `Gender` and `Culture`.
|
-- @param #string Voice (Optional) Specific voice. Overrides `Gender` and `Culture`.
|
||||||
-- @param #number Port SRS port. Default 5002.
|
-- @param #number Port (Optional) SRS port. Default 5002.
|
||||||
-- @param #string GoogleKey Path to Google JSON-Key (SRS exe backend) or Google API key (DCS-gRPC backend).
|
-- @param #string GoogleKey Path to Google JSON-Key (SRS exe backend) or Google API key (DCS-gRPC backend).
|
||||||
-- @return #ATIS self
|
-- @return #ATIS self
|
||||||
function ATIS:SetSRS(PathToSRS, Gender, Culture, Voice, Port, GoogleKey)
|
function ATIS:SetSRS(PathToSRS, Gender, Culture, Voice, Port, GoogleKey)
|
||||||
@@ -1727,7 +1727,7 @@ end
|
|||||||
|
|
||||||
--- Set the time interval between radio queue updates.
|
--- Set the time interval between radio queue updates.
|
||||||
-- @param #ATIS self
|
-- @param #ATIS self
|
||||||
-- @param #number TimeInterval Interval in seconds. Default 5 sec.
|
-- @param #number TimeInterval (Optional) Interval in seconds. Default 5 sec.
|
||||||
-- @return #ATIS self
|
-- @return #ATIS self
|
||||||
function ATIS:SetQueueUpdateTime( TimeInterval )
|
function ATIS:SetQueueUpdateTime( TimeInterval )
|
||||||
self.dTQueueCheck = TimeInterval or 5
|
self.dTQueueCheck = TimeInterval or 5
|
||||||
@@ -3195,7 +3195,7 @@ end
|
|||||||
|
|
||||||
--- Get active runway runway.
|
--- Get active runway runway.
|
||||||
-- @param #ATIS self
|
-- @param #ATIS self
|
||||||
-- @param #boolean Takeoff If `true`, get runway for takeoff. Default is for landing.
|
-- @param #boolean Takeoff (Optional) If `true`, get runway for takeoff. Default is for landing.
|
||||||
-- @return #string Active runway, e.g. "31" for 310 deg.
|
-- @return #string Active runway, e.g. "31" for 310 deg.
|
||||||
-- @return #boolean Use Left=true, Right=false, or nil.
|
-- @return #boolean Use Left=true, Right=false, or nil.
|
||||||
function ATIS:GetActiveRunway(Takeoff)
|
function ATIS:GetActiveRunway(Takeoff)
|
||||||
@@ -3305,7 +3305,7 @@ end
|
|||||||
-- @param #ATIS.Soundfile sound ATIS sound object.
|
-- @param #ATIS.Soundfile sound ATIS sound object.
|
||||||
-- @param #number interval Interval in seconds after the last transmission finished.
|
-- @param #number interval Interval in seconds after the last transmission finished.
|
||||||
-- @param #string subtitle Subtitle of the transmission.
|
-- @param #string subtitle Subtitle of the transmission.
|
||||||
-- @param #string path Path to sound file. Default `self.soundpath`.
|
-- @param #string path (Optional) Path to sound file. Default `self.soundpath`.
|
||||||
function ATIS:Transmission( sound, interval, subtitle, path )
|
function ATIS:Transmission( sound, interval, subtitle, path )
|
||||||
self.radioqueue:NewTransmission( sound.filename, sound.duration, path or self.soundpath, nil, interval, subtitle, self.subduration )
|
self.radioqueue:NewTransmission( sound.filename, sound.duration, path or self.soundpath, nil, interval, subtitle, self.subduration )
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -369,9 +369,9 @@ end
|
|||||||
--- Add a **new** payload to the airwing resources.
|
--- Add a **new** payload to the airwing resources.
|
||||||
-- @param #AIRWING self
|
-- @param #AIRWING self
|
||||||
-- @param Wrapper.Unit#UNIT Unit The unit, the payload is extracted from. Can also be given as *#string* name of the unit.
|
-- @param Wrapper.Unit#UNIT Unit The unit, the payload is extracted from. Can also be given as *#string* name of the unit.
|
||||||
-- @param #number Npayloads Number of payloads to add to the airwing resources. Default 99 (which should be enough for most scenarios). Set to -1 for unlimited.
|
-- @param #number Npayloads (Optional) Number of payloads to add to the airwing resources. Default 99 (which should be enough for most scenarios). Set to -1 for unlimited.
|
||||||
-- @param #table MissionTypes Mission types this payload can be used for.
|
-- @param #table MissionTypes Mission types this payload can be used for.
|
||||||
-- @param #number Performance A number between 0 (worst) and 100 (best) to describe the performance of the loadout for the given mission types. Default is 50.
|
-- @param #number Performance (Optional) A number between 0 (worst) and 100 (best) to describe the performance of the loadout for the given mission types. Default is 50.
|
||||||
-- @return #AIRWING.Payload The payload table or nil if the unit does not exist.
|
-- @return #AIRWING.Payload The payload table or nil if the unit does not exist.
|
||||||
function AIRWING:NewPayload(Unit, Npayloads, MissionTypes, Performance)
|
function AIRWING:NewPayload(Unit, Npayloads, MissionTypes, Performance)
|
||||||
|
|
||||||
@@ -454,7 +454,7 @@ end
|
|||||||
--- Set the number of payload available.
|
--- Set the number of payload available.
|
||||||
-- @param #AIRWING self
|
-- @param #AIRWING self
|
||||||
-- @param #AIRWING.Payload Payload The payload table created by the `:NewPayload` function.
|
-- @param #AIRWING.Payload Payload The payload table created by the `:NewPayload` function.
|
||||||
-- @param #number Navailable Number of payloads available to the airwing resources. Default 99 (which should be enough for most scenarios). Set to -1 for unlimited.
|
-- @param #number Navailable (Optional) Number of payloads available to the airwing resources. Default 99 (which should be enough for most scenarios). Set to -1 for unlimited.
|
||||||
-- @return #AIRWING self
|
-- @return #AIRWING self
|
||||||
function AIRWING:SetPayloadAmount(Payload, Navailable)
|
function AIRWING:SetPayloadAmount(Payload, Navailable)
|
||||||
|
|
||||||
@@ -477,7 +477,7 @@ end
|
|||||||
--- Increase or decrease the amount of available payloads. Unlimited playloads first need to be set to a limited number with the `SetPayloadAmount` function.
|
--- Increase or decrease the amount of available payloads. Unlimited playloads first need to be set to a limited number with the `SetPayloadAmount` function.
|
||||||
-- @param #AIRWING self
|
-- @param #AIRWING self
|
||||||
-- @param #AIRWING.Payload Payload The payload table created by the `:NewPayload` function.
|
-- @param #AIRWING.Payload Payload The payload table created by the `:NewPayload` function.
|
||||||
-- @param #number N Number of payloads to be added. Use negative number to decrease amount. Default 1.
|
-- @param #number N (Optional) Number of payloads to be added. Use negative number to decrease amount. Default 1.
|
||||||
-- @return #AIRWING self
|
-- @return #AIRWING self
|
||||||
function AIRWING:IncreasePayloadAmount(Payload, N)
|
function AIRWING:IncreasePayloadAmount(Payload, N)
|
||||||
|
|
||||||
@@ -516,7 +516,7 @@ end
|
|||||||
-- @param #AIRWING self
|
-- @param #AIRWING self
|
||||||
-- @param #AIRWING.Payload Payload The payload table to which the capability should be added.
|
-- @param #AIRWING.Payload Payload The payload table to which the capability should be added.
|
||||||
-- @param #table MissionTypes Mission types to be added.
|
-- @param #table MissionTypes Mission types to be added.
|
||||||
-- @param #number Performance A number between 0 (worst) and 100 (best) to describe the performance of the loadout for the given mission types. Default is 50.
|
-- @param #number Performance (Optional) A number between 0 (worst) and 100 (best) to describe the performance of the loadout for the given mission types. Default is 50.
|
||||||
-- @return #AIRWING self
|
-- @return #AIRWING self
|
||||||
function AIRWING:AddPayloadCapability(Payload, MissionTypes, Performance)
|
function AIRWING:AddPayloadCapability(Payload, MissionTypes, Performance)
|
||||||
|
|
||||||
@@ -739,7 +739,7 @@ end
|
|||||||
|
|
||||||
--- Set number of CAP flights constantly carried out.
|
--- Set number of CAP flights constantly carried out.
|
||||||
-- @param #AIRWING self
|
-- @param #AIRWING self
|
||||||
-- @param #number n Number of flights. Default 1.
|
-- @param #number n (Optional) Number of flights. Default 1.
|
||||||
-- @return #AIRWING self
|
-- @return #AIRWING self
|
||||||
function AIRWING:SetNumberCAP(n)
|
function AIRWING:SetNumberCAP(n)
|
||||||
self.nflightsCAP=n or 1
|
self.nflightsCAP=n or 1
|
||||||
@@ -757,7 +757,7 @@ end
|
|||||||
|
|
||||||
--- Set CAP close race track.We'll utilize the AUFTRAG PatrolRaceTrack instead of a standard race track orbit task.
|
--- Set CAP close race track.We'll utilize the AUFTRAG PatrolRaceTrack instead of a standard race track orbit task.
|
||||||
-- @param #AIRWING self
|
-- @param #AIRWING self
|
||||||
-- @param #boolean OnOff If true, switch this on, else switch off. Off by default.
|
-- @param #boolean OnOff (Optional) If true, switch this on, else switch off. Off by default.
|
||||||
-- @return #AIRWING self
|
-- @return #AIRWING self
|
||||||
function AIRWING:SetCapCloseRaceTrack(OnOff)
|
function AIRWING:SetCapCloseRaceTrack(OnOff)
|
||||||
self.capOptionPatrolRaceTrack = OnOff
|
self.capOptionPatrolRaceTrack = OnOff
|
||||||
@@ -777,7 +777,7 @@ end
|
|||||||
|
|
||||||
--- Set number of TANKER flights with Boom constantly in the air.
|
--- Set number of TANKER flights with Boom constantly in the air.
|
||||||
-- @param #AIRWING self
|
-- @param #AIRWING self
|
||||||
-- @param #number Nboom Number of flights. Default 1.
|
-- @param #number Nboom (Optional) Number of flights. Default 1.
|
||||||
-- @return #AIRWING self
|
-- @return #AIRWING self
|
||||||
function AIRWING:SetNumberTankerBoom(Nboom)
|
function AIRWING:SetNumberTankerBoom(Nboom)
|
||||||
self.nflightsTANKERboom=Nboom or 1
|
self.nflightsTANKERboom=Nboom or 1
|
||||||
@@ -799,7 +799,7 @@ end
|
|||||||
|
|
||||||
--- Set number of TANKER flights with Probe constantly in the air.
|
--- Set number of TANKER flights with Probe constantly in the air.
|
||||||
-- @param #AIRWING self
|
-- @param #AIRWING self
|
||||||
-- @param #number Nprobe Number of flights. Default 1.
|
-- @param #number Nprobe (Optional) Number of flights. Default 1.
|
||||||
-- @return #AIRWING self
|
-- @return #AIRWING self
|
||||||
function AIRWING:SetNumberTankerProbe(Nprobe)
|
function AIRWING:SetNumberTankerProbe(Nprobe)
|
||||||
self.nflightsTANKERprobe=Nprobe or 1
|
self.nflightsTANKERprobe=Nprobe or 1
|
||||||
@@ -808,7 +808,7 @@ end
|
|||||||
|
|
||||||
--- Set number of AWACS flights constantly in the air.
|
--- Set number of AWACS flights constantly in the air.
|
||||||
-- @param #AIRWING self
|
-- @param #AIRWING self
|
||||||
-- @param #number n Number of flights. Default 1.
|
-- @param #number n (Optional) Number of flights. Default 1.
|
||||||
-- @return #AIRWING self
|
-- @return #AIRWING self
|
||||||
function AIRWING:SetNumberAWACS(n)
|
function AIRWING:SetNumberAWACS(n)
|
||||||
self.nflightsAWACS=n or 1
|
self.nflightsAWACS=n or 1
|
||||||
@@ -817,7 +817,7 @@ end
|
|||||||
|
|
||||||
--- Set number of RECON flights constantly in the air.
|
--- Set number of RECON flights constantly in the air.
|
||||||
-- @param #AIRWING self
|
-- @param #AIRWING self
|
||||||
-- @param #number n Number of flights. Default 1.
|
-- @param #number n (Optional) Number of flights. Default 1.
|
||||||
-- @return #AIRWING self
|
-- @return #AIRWING self
|
||||||
function AIRWING:SetNumberRecon(n)
|
function AIRWING:SetNumberRecon(n)
|
||||||
self.nflightsRecon=n or 1
|
self.nflightsRecon=n or 1
|
||||||
@@ -826,7 +826,7 @@ end
|
|||||||
|
|
||||||
--- Set number of Rescue helo flights constantly in the air.
|
--- Set number of Rescue helo flights constantly in the air.
|
||||||
-- @param #AIRWING self
|
-- @param #AIRWING self
|
||||||
-- @param #number n Number of flights. Default 1.
|
-- @param #number n (Optional) Number of flights. Default 1.
|
||||||
-- @return #AIRWING self
|
-- @return #AIRWING self
|
||||||
function AIRWING:SetNumberRescuehelo(n)
|
function AIRWING:SetNumberRescuehelo(n)
|
||||||
self.nflightsRescueHelo=n or 1
|
self.nflightsRescueHelo=n or 1
|
||||||
@@ -868,13 +868,13 @@ end
|
|||||||
|
|
||||||
--- Create a new generic patrol point.
|
--- Create a new generic patrol point.
|
||||||
-- @param #AIRWING self
|
-- @param #AIRWING self
|
||||||
-- @param #string Type Patrol point type, e.g. "CAP" or "AWACS". Default "Unknown".
|
-- @param #string Type (Optional) Patrol point type, e.g. "CAP" or "AWACS". Default "Unknown".
|
||||||
-- @param Core.Point#COORDINATE Coordinate Coordinate of the patrol point. Default 10-15 NM away from the location of the airwing. Can be handed as a Core.Zone#ZONE object (e.g. in case you want the point to align with a moving zone).
|
-- @param Core.Point#COORDINATE Coordinate (Optional) Coordinate of the patrol point. Default 10-15 NM away from the location of the airwing. Can be handed as a Core.Zone#ZONE object (e.g. in case you want the point to align with a moving zone).
|
||||||
-- @param #number Altitude Orbit altitude in feet. Default random between Angels 10 and 20.
|
-- @param #number Altitude (Optional) Orbit altitude in feet. Default random between Angels 10 and 20.
|
||||||
-- @param #number Heading Heading in degrees. Default random (0, 360] degrees.
|
-- @param #number Heading (Optional) Heading in degrees. Default random (0, 360] degrees.
|
||||||
-- @param #number LegLength Length of race-track orbit in NM. Default 15 NM.
|
-- @param #number LegLength (Optional) Length of race-track orbit in NM. Default 15 NM.
|
||||||
-- @param #number Speed Orbit speed in knots. Default 350 knots.
|
-- @param #number Speed (Optional) Orbit speed in knots. Default 350 knots.
|
||||||
-- @param #number RefuelSystem Refueling system: 0=Boom, 1=Probe. Default nil=any.
|
-- @param #number RefuelSystem (Optional) Refueling system: 0=Boom, 1=Probe. Default nil=any.
|
||||||
-- @return #AIRWING.PatrolData Patrol point table.
|
-- @return #AIRWING.PatrolData Patrol point table.
|
||||||
function AIRWING:NewPatrolPoint(Type, Coordinate, Altitude, Speed, Heading, LegLength, RefuelSystem)
|
function AIRWING:NewPatrolPoint(Type, Coordinate, Altitude, Speed, Heading, LegLength, RefuelSystem)
|
||||||
|
|
||||||
@@ -944,7 +944,7 @@ end
|
|||||||
-- @param #number Speed Orbit speed in knots.
|
-- @param #number Speed Orbit speed in knots.
|
||||||
-- @param #number Heading Heading in degrees.
|
-- @param #number Heading Heading in degrees.
|
||||||
-- @param #number LegLength Length of race-track orbit in NM.
|
-- @param #number LegLength Length of race-track orbit in NM.
|
||||||
-- @param #number RefuelSystem Set refueling system of tanker: 0=boom, 1=probe. Default any (=nil).
|
-- @param #number RefuelSystem (Optional) Set refueling system of tanker: 0=boom, 1=probe. Default any (=nil).
|
||||||
-- @return #AIRWING self
|
-- @return #AIRWING self
|
||||||
function AIRWING:AddPatrolPointTANKER(Coordinate, Altitude, Speed, Heading, LegLength, RefuelSystem)
|
function AIRWING:AddPatrolPointTANKER(Coordinate, Altitude, Speed, Heading, LegLength, RefuelSystem)
|
||||||
|
|
||||||
@@ -984,7 +984,7 @@ end
|
|||||||
--- Set takeoff type. All assets of this airwing will be spawned with this takeoff type.
|
--- Set takeoff type. All assets of this airwing will be spawned with this takeoff type.
|
||||||
-- Spawning on runways is not supported.
|
-- Spawning on runways is not supported.
|
||||||
-- @param #AIRWING self
|
-- @param #AIRWING self
|
||||||
-- @param #string TakeoffType Take off type: "Cold" (default) or "Hot" with engines on or "Air" for spawning in air.
|
-- @param #string TakeoffType (Optional) Take off type: "Cold" (default) or "Hot" with engines on or "Air" for spawning in air.
|
||||||
-- @return #AIRWING self
|
-- @return #AIRWING self
|
||||||
function AIRWING:SetTakeoffType(TakeoffType)
|
function AIRWING:SetTakeoffType(TakeoffType)
|
||||||
TakeoffType=TakeoffType or "Cold"
|
TakeoffType=TakeoffType or "Cold"
|
||||||
@@ -1067,7 +1067,7 @@ end
|
|||||||
--- Set despawn after landing. Aircraft will be despawned after the landing event.
|
--- Set despawn after landing. Aircraft will be despawned after the landing event.
|
||||||
-- Can help to avoid DCS AI taxiing issues.
|
-- Can help to avoid DCS AI taxiing issues.
|
||||||
-- @param #AIRWING self
|
-- @param #AIRWING self
|
||||||
-- @param #boolean Switch If `true` (default), activate despawn after landing.
|
-- @param #boolean Switch (Optional) If `true` (default), activate despawn after landing.
|
||||||
-- @return #AIRWING self
|
-- @return #AIRWING self
|
||||||
function AIRWING:SetDespawnAfterLanding(Switch)
|
function AIRWING:SetDespawnAfterLanding(Switch)
|
||||||
if Switch then
|
if Switch then
|
||||||
@@ -1081,7 +1081,7 @@ end
|
|||||||
--- Set despawn after holding. Aircraft will be despawned when they arrive at their holding position at the airbase.
|
--- Set despawn after holding. Aircraft will be despawned when they arrive at their holding position at the airbase.
|
||||||
-- Can help to avoid DCS AI taxiing issues.
|
-- Can help to avoid DCS AI taxiing issues.
|
||||||
-- @param #AIRWING self
|
-- @param #AIRWING self
|
||||||
-- @param #boolean Switch If `true` (default), activate despawn after landing.
|
-- @param #boolean Switch (Optional) If `true` (default), activate despawn after landing.
|
||||||
-- @return #AIRWING self
|
-- @return #AIRWING self
|
||||||
function AIRWING:SetDespawnAfterHolding(Switch)
|
function AIRWING:SetDespawnAfterHolding(Switch)
|
||||||
if Switch then
|
if Switch then
|
||||||
@@ -1581,9 +1581,9 @@ end
|
|||||||
|
|
||||||
--- Count payloads in stock.
|
--- Count payloads in stock.
|
||||||
-- @param #AIRWING self
|
-- @param #AIRWING self
|
||||||
-- @param #table MissionTypes Types on mission to be checked. Default *all* possible types `AUFTRAG.Type`.
|
-- @param #table MissionTypes (Optional) Types on mission to be checked. Default *all* possible types `AUFTRAG.Type`.
|
||||||
-- @param #table UnitTypes Types of units.
|
-- @param #table UnitTypes (Optional) Types of units.
|
||||||
-- @param #table Payloads Specific payloads to be counted only.
|
-- @param #table Payloads (Optional) Specific payloads to be counted only.
|
||||||
-- @return #number Count of available payloads in stock.
|
-- @return #number Count of available payloads in stock.
|
||||||
function AIRWING:CountPayloadsInStock(MissionTypes, UnitTypes, Payloads)
|
function AIRWING:CountPayloadsInStock(MissionTypes, UnitTypes, Payloads)
|
||||||
|
|
||||||
|
|||||||
@@ -2456,7 +2456,7 @@ end
|
|||||||
--- Set carrier controlled area (CCA).
|
--- Set carrier controlled area (CCA).
|
||||||
-- This is a large zone around the carrier, which is constantly updated wrt the carrier position.
|
-- This is a large zone around the carrier, which is constantly updated wrt the carrier position.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number Radius Radius of zone in nautical miles (NM). Default 50 NM.
|
-- @param #number Radius (Optional) Radius of zone in nautical miles (NM). Default 50 NM.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetCarrierControlledArea( Radius )
|
function AIRBOSS:SetCarrierControlledArea( Radius )
|
||||||
|
|
||||||
@@ -2470,7 +2470,7 @@ end
|
|||||||
--- Set carrier controlled zone (CCZ).
|
--- Set carrier controlled zone (CCZ).
|
||||||
-- This is a small zone (usually 5 NM radius) around the carrier, which is constantly updated wrt the carrier position.
|
-- This is a small zone (usually 5 NM radius) around the carrier, which is constantly updated wrt the carrier position.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number Radius Radius of zone in nautical miles (NM). Default 5 NM.
|
-- @param #number Radius (Optional) Radius of zone in nautical miles (NM). Default 5 NM.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetCarrierControlledZone( Radius )
|
function AIRBOSS:SetCarrierControlledZone( Radius )
|
||||||
|
|
||||||
@@ -2483,7 +2483,7 @@ end
|
|||||||
|
|
||||||
--- Set distance up to which water ahead is scanned for collisions.
|
--- Set distance up to which water ahead is scanned for collisions.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number Distance Distance in NM. Default 5 NM.
|
-- @param #number Distance (Optional) Distance in NM. Default 5 NM.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetCollisionDistance( Distance )
|
function AIRBOSS:SetCollisionDistance( Distance )
|
||||||
self.collisiondist = UTILS.NMToMeters( Distance or 5 )
|
self.collisiondist = UTILS.NMToMeters( Distance or 5 )
|
||||||
@@ -2492,7 +2492,7 @@ end
|
|||||||
|
|
||||||
--- Set the default recovery case.
|
--- Set the default recovery case.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number Case Case of recovery. Either 1, 2 or 3. Default 1.
|
-- @param #number Case (Optional) Case of recovery. Either 1, 2 or 3. Default 1.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetRecoveryCase( Case )
|
function AIRBOSS:SetRecoveryCase( Case )
|
||||||
|
|
||||||
@@ -2509,7 +2509,7 @@ end
|
|||||||
-- Usually, this is +-15 or +-30 degrees. You should not use and offset angle >= 90 degrees, because this will cause a devision by zero in some of the equations used to calculate the approach corridor.
|
-- Usually, this is +-15 or +-30 degrees. You should not use and offset angle >= 90 degrees, because this will cause a devision by zero in some of the equations used to calculate the approach corridor.
|
||||||
-- So best stick to the defaults up to 30 degrees.
|
-- So best stick to the defaults up to 30 degrees.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number Offset Offset angle in degrees. Default 0.
|
-- @param #number Offset (Optional) Offset angle in degrees. Default 0.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetHoldingOffsetAngle( Offset )
|
function AIRBOSS:SetHoldingOffsetAngle( Offset )
|
||||||
|
|
||||||
@@ -2524,10 +2524,10 @@ end
|
|||||||
|
|
||||||
--- Enable F10 menu to manually start recoveries.
|
--- Enable F10 menu to manually start recoveries.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number Duration Default duration of the recovery in minutes. Default 30 min.
|
-- @param #number Duration (Optional) Default duration of the recovery in minutes. Default 30 min.
|
||||||
-- @param #number WindOnDeck Default wind on deck in knots. Default 25 knots.
|
-- @param #number WindOnDeck(Optional) Default wind on deck in knots. Default 25 knots.
|
||||||
-- @param #boolean Uturn U-turn after recovery window closes on=true or off=false/nil. Default off.
|
-- @param #boolean Uturn (Optional) U-turn after recovery window closes on=true or off=false/nil. Default off.
|
||||||
-- @param #number Offset Relative Marshal radial in degrees for Case II/III recoveries. Default 30°.
|
-- @param #number Offset (Optional) Relative Marshal radial in degrees for Case II/III recoveries. Default 30°.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetMenuRecovery( Duration, WindOnDeck, Uturn, Offset )
|
function AIRBOSS:SetMenuRecovery( Duration, WindOnDeck, Uturn, Offset )
|
||||||
|
|
||||||
@@ -2547,13 +2547,13 @@ end
|
|||||||
|
|
||||||
--- Add aircraft recovery time window and recovery case.
|
--- Add aircraft recovery time window and recovery case.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #string starttime Start time, e.g. "8:00" for eight o'clock. Default now.
|
-- @param #string starttime (Optional) Start time, e.g. "8:00" for eight o'clock. Default now.
|
||||||
-- @param #string stoptime Stop time, e.g. "9:00" for nine o'clock. Default 90 minutes after start time.
|
-- @param #string stoptime (Optional) Stop time, e.g. "9:00" for nine o'clock. Default 90 minutes after start time.
|
||||||
-- @param #number case Recovery case for that time slot. Number between one and three.
|
-- @param #number case (Optional) Recovery case for that time slot. Number between one and three. Defaults to 1.
|
||||||
-- @param #number holdingoffset Only for CASE II/III: Angle in degrees the holding pattern is offset.
|
-- @param #number holdingoffset (Optional) Only for CASE II/III: Angle in degrees the holding pattern is offset. Defaults to 0.
|
||||||
-- @param #boolean turnintowind If true, carrier will turn into the wind 5 minutes before the recovery window opens.
|
-- @param #boolean turnintowind If true, carrier will turn into the wind 5 minutes before the recovery window opens.
|
||||||
-- @param #number speed Speed in knots during turn into wind leg.
|
-- @param #number speed (Optional) Speed in knots during turn into wind leg. Default is 20.
|
||||||
-- @param #boolean uturn If true (or nil), carrier wil perform a U-turn and go back to where it came from before resuming its route to the next waypoint. If false, it will go directly to the next waypoint.
|
-- @param #boolean uturn (Optional) If true (or nil), carrier wil perform a U-turn and go back to where it came from before resuming its route to the next waypoint. If false, it will go directly to the next waypoint.
|
||||||
-- @return #AIRBOSS.Recovery Recovery window.
|
-- @return #AIRBOSS.Recovery Recovery window.
|
||||||
function AIRBOSS:AddRecoveryWindow( starttime, stoptime, case, holdingoffset, turnintowind, speed, uturn )
|
function AIRBOSS:AddRecoveryWindow( starttime, stoptime, case, holdingoffset, turnintowind, speed, uturn )
|
||||||
|
|
||||||
@@ -2735,7 +2735,7 @@ end
|
|||||||
|
|
||||||
--- Set time before carrier turns and recovery window opens.
|
--- Set time before carrier turns and recovery window opens.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number Interval Time interval in seconds. Default 300 sec.
|
-- @param #number Interval (Optional) Time interval in seconds. Default 300 sec.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetRecoveryTurnTime( Interval )
|
function AIRBOSS:SetRecoveryTurnTime( Interval )
|
||||||
self.dTturn = Interval or 300
|
self.dTturn = Interval or 300
|
||||||
@@ -2744,7 +2744,7 @@ end
|
|||||||
|
|
||||||
--- Set multiplayer environment wire correction.
|
--- Set multiplayer environment wire correction.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number Dcorr Correction distance in meters. Default 12 m.
|
-- @param #number Dcorr (Optional) Correction distance in meters. Default 12 m.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetMPWireCorrection( Dcorr )
|
function AIRBOSS:SetMPWireCorrection( Dcorr )
|
||||||
self.mpWireCorrection = Dcorr or 12
|
self.mpWireCorrection = Dcorr or 12
|
||||||
@@ -2753,7 +2753,7 @@ end
|
|||||||
|
|
||||||
--- Set time interval for updating queues and other stuff.
|
--- Set time interval for updating queues and other stuff.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number TimeInterval Time interval in seconds. Default 30 sec.
|
-- @param #number TimeInterval (Optional) Time interval in seconds. Default 30 sec.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetQueueUpdateTime( TimeInterval )
|
function AIRBOSS:SetQueueUpdateTime( TimeInterval )
|
||||||
self.dTqueue = TimeInterval or 30
|
self.dTqueue = TimeInterval or 30
|
||||||
@@ -2762,7 +2762,7 @@ end
|
|||||||
|
|
||||||
--- Set time interval between LSO calls. Optimal time in the groove is ~16 seconds. So the default of 4 seconds gives around 3-4 correction calls in the groove.
|
--- Set time interval between LSO calls. Optimal time in the groove is ~16 seconds. So the default of 4 seconds gives around 3-4 correction calls in the groove.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number TimeInterval Time interval in seconds between LSO calls. Default 4 sec.
|
-- @param #number TimeInterval (Optional) Time interval in seconds between LSO calls. Default 4 sec.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetLSOCallInterval( TimeInterval )
|
function AIRBOSS:SetLSOCallInterval( TimeInterval )
|
||||||
self.LSOdT = TimeInterval or 4
|
self.LSOdT = TimeInterval or 4
|
||||||
@@ -2835,7 +2835,7 @@ end
|
|||||||
|
|
||||||
--- Give AI aircraft the refueling task if a recovery tanker is present or send them to the nearest divert airfield.
|
--- Give AI aircraft the refueling task if a recovery tanker is present or send them to the nearest divert airfield.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number LowFuelThreshold Low fuel threshold in percent. AI will go refueling if their fuel level drops below this value. Default 10 %.
|
-- @param #number LowFuelThreshold (Optional) Low fuel threshold in percent. AI will go refueling if their fuel level drops below this value. Default 10 %.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetRefuelAI( LowFuelThreshold )
|
function AIRBOSS:SetRefuelAI( LowFuelThreshold )
|
||||||
self.lowfuelAI = LowFuelThreshold or 10
|
self.lowfuelAI = LowFuelThreshold or 10
|
||||||
@@ -2844,7 +2844,7 @@ end
|
|||||||
|
|
||||||
--- Set max altitude to register flights in the initial zone. Aircraft above this altitude will not be registerered.
|
--- Set max altitude to register flights in the initial zone. Aircraft above this altitude will not be registerered.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number MaxAltitude Max altitude in feet. Default 1300 ft.
|
-- @param #number MaxAltitude (Optional) Max altitude in feet. Default 1300 ft.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetInitialMaxAlt( MaxAltitude )
|
function AIRBOSS:SetInitialMaxAlt( MaxAltitude )
|
||||||
self.initialmaxalt = UTILS.FeetToMeters( MaxAltitude or 1300 )
|
self.initialmaxalt = UTILS.FeetToMeters( MaxAltitude or 1300 )
|
||||||
@@ -2878,7 +2878,7 @@ end
|
|||||||
|
|
||||||
--- Set time interval for updating player status and other things.
|
--- Set time interval for updating player status and other things.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number TimeInterval Time interval in seconds. Default 0.5 sec.
|
-- @param #number TimeInterval (Optional) Time interval in seconds. Default 0.5 sec.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetStatusUpdateTime( TimeInterval )
|
function AIRBOSS:SetStatusUpdateTime( TimeInterval )
|
||||||
self.dTstatus = TimeInterval or 0.5
|
self.dTstatus = TimeInterval or 0.5
|
||||||
@@ -2887,7 +2887,7 @@ end
|
|||||||
|
|
||||||
--- Set duration how long messages are displayed to players.
|
--- Set duration how long messages are displayed to players.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number Duration Duration in seconds. Default 10 sec.
|
-- @param #number Duration (Optional) Duration in seconds. Default 10 sec.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetDefaultMessageDuration( Duration )
|
function AIRBOSS:SetDefaultMessageDuration( Duration )
|
||||||
self.Tmessage = Duration or 10
|
self.Tmessage = Duration or 10
|
||||||
@@ -2978,7 +2978,7 @@ end
|
|||||||
--- Set Case I Marshal radius. This is the radius of the valid zone around "the post" aircraft are supposed to be holding in the Case I Marshal stack.
|
--- Set Case I Marshal radius. This is the radius of the valid zone around "the post" aircraft are supposed to be holding in the Case I Marshal stack.
|
||||||
-- The post is 2.5 NM port of the carrier.
|
-- The post is 2.5 NM port of the carrier.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number Radius Radius in NM. Default 2.8 NM, which gives a diameter of 5.6 NM.
|
-- @param #number Radius (Optional) Radius in NM. Default 2.8 NM, which gives a diameter of 5.6 NM.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetMarshalRadius( Radius )
|
function AIRBOSS:SetMarshalRadius( Radius )
|
||||||
self.marshalradius = UTILS.NMToMeters( Radius or 2.8 )
|
self.marshalradius = UTILS.NMToMeters( Radius or 2.8 )
|
||||||
@@ -3112,9 +3112,9 @@ end
|
|||||||
--- Set up SRS for usage without sound files
|
--- Set up SRS for usage without sound files
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #string PathToSRS Path to SRS folder, e.g. "C:\\Program Files\\DCS-SimpleRadio\\ExternalAudio".
|
-- @param #string PathToSRS Path to SRS folder, e.g. "C:\\Program Files\\DCS-SimpleRadio\\ExternalAudio".
|
||||||
-- @param #number Port Port of the SRS server, defaults to 5002.
|
-- @param #number Port (Optional) Port of the SRS server, defaults to 5002.
|
||||||
-- @param #string Culture (Optional, Airboss Culture) Culture, defaults to "en-US".
|
-- @param #string Culture (Optional) (Optional, Airboss Culture) Culture, defaults to "en-US".
|
||||||
-- @param #string Gender (Optional, Airboss Gender) Gender, e.g. "male" or "female". Defaults to "male".
|
-- @param #string Gender (Optional) (Optional, Airboss Gender) Gender, e.g. "male" or "female". Defaults to "male".
|
||||||
-- @param #string Voice (Optional, Airboss Voice) Set to use a specific voice. Will **override gender and culture** settings.
|
-- @param #string Voice (Optional, Airboss Voice) Set to use a specific voice. Will **override gender and culture** settings.
|
||||||
-- @param #string GoogleCreds (Optional) Path to Google credentials, e.g. "C:\\Program Files\\DCS-SimpleRadio-Standalone\\yourgooglekey.json".
|
-- @param #string GoogleCreds (Optional) Path to Google credentials, e.g. "C:\\Program Files\\DCS-SimpleRadio-Standalone\\yourgooglekey.json".
|
||||||
-- @param #number Volume (Optional) E.g. 0.75. Defaults to 1.0 (loudest).
|
-- @param #number Volume (Optional) E.g. 0.75. Defaults to 1.0 (loudest).
|
||||||
@@ -3362,7 +3362,7 @@ end
|
|||||||
|
|
||||||
--- Set number of aircraft units, which can be in the landing pattern before the pattern is full.
|
--- Set number of aircraft units, which can be in the landing pattern before the pattern is full.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number nmax Max number. Default 4. Minimum is 1, maximum is 6.
|
-- @param #number nmax (Optional) Max number. Default 4. Minimum is 1, maximum is 6.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetMaxLandingPattern( nmax )
|
function AIRBOSS:SetMaxLandingPattern( nmax )
|
||||||
nmax = nmax or 4
|
nmax = nmax or 4
|
||||||
@@ -3375,7 +3375,7 @@ end
|
|||||||
--- Set number available Case I Marshal stacks. If Marshal stacks are full, flights requesting Marshal will be told to hold outside 10 NM zone until a stack becomes available again.
|
--- Set number available Case I Marshal stacks. If Marshal stacks are full, flights requesting Marshal will be told to hold outside 10 NM zone until a stack becomes available again.
|
||||||
-- Marshal stacks for Case II/III are unlimited.
|
-- Marshal stacks for Case II/III are unlimited.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number nmax Max number of stacks available to players and AI flights. Default 3, i.e. angels 2, 3, 4. Minimum is 1.
|
-- @param #number nmax (Optional) Max number of stacks available to players and AI flights. Default 3, i.e. angels 2, 3, 4. Minimum is 1.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetMaxMarshalStacks( nmax )
|
function AIRBOSS:SetMaxMarshalStacks( nmax )
|
||||||
self.Nmaxmarshal = nmax or 3
|
self.Nmaxmarshal = nmax or 3
|
||||||
@@ -3397,7 +3397,7 @@ end
|
|||||||
|
|
||||||
--- Set maximum distance up to which section members are allowed (default: 100 meters).
|
--- Set maximum distance up to which section members are allowed (default: 100 meters).
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number dmax Max distance in meters (default 100 m). Minimum is 10 m, maximum is 5000 m.
|
-- @param #number dmax (Optional) Max distance in meters (default 100 m). Minimum is 10 m, maximum is 5000 m.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetMaxSectionDistance( dmax )
|
function AIRBOSS:SetMaxSectionDistance( dmax )
|
||||||
if dmax then
|
if dmax then
|
||||||
@@ -3413,7 +3413,7 @@ end
|
|||||||
|
|
||||||
--- Set max number of flights per stack. All members of a section count as one "flight".
|
--- Set max number of flights per stack. All members of a section count as one "flight".
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number nmax Number of max allowed flights per stack. Default is two. Minimum is one, maximum is 4.
|
-- @param #number nmax (Optional) Number of max allowed flights per stack. Default is two. Minimum is one, maximum is 4.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetMaxFlightsPerStack( nmax )
|
function AIRBOSS:SetMaxFlightsPerStack( nmax )
|
||||||
nmax = nmax or 2
|
nmax = nmax or 2
|
||||||
@@ -3433,7 +3433,7 @@ end
|
|||||||
|
|
||||||
--- Will play the inbound calls, commencing, initial, etc. from the player when requesteing marshal
|
--- Will play the inbound calls, commencing, initial, etc. from the player when requesteing marshal
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #AIRBOSS status Boolean to activate (true) / deactivate (false) the radio inbound calls (default is ON)
|
-- @param #AIRBOSS status (Optional) Boolean to activate (true) / deactivate (false) the radio inbound calls (default is ON)
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetExtraVoiceOvers(status)
|
function AIRBOSS:SetExtraVoiceOvers(status)
|
||||||
self.xtVoiceOvers=status
|
self.xtVoiceOvers=status
|
||||||
@@ -3442,7 +3442,7 @@ end
|
|||||||
|
|
||||||
--- Will simulate the inbound call, commencing, initial, etc from the AI when requested by Airboss
|
--- Will simulate the inbound call, commencing, initial, etc from the AI when requested by Airboss
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #AIRBOSS status Boolean to activate (true) / deactivate (false) the radio inbound calls (default is ON)
|
-- @param #AIRBOSS status (Optional) Boolean to activate (true) / deactivate (false) the radio inbound calls (default is ON)
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetExtraVoiceOversAI(status)
|
function AIRBOSS:SetExtraVoiceOversAI(status)
|
||||||
self.xtVoiceOversAI=status
|
self.xtVoiceOversAI=status
|
||||||
@@ -3481,7 +3481,7 @@ end
|
|||||||
-- * "Naval Aviator" = @{#AIRBOSS.Difficulty.Normal}
|
-- * "Naval Aviator" = @{#AIRBOSS.Difficulty.Normal}
|
||||||
-- * "TOPGUN Graduate" = @{#AIRBOSS.Difficulty.Hard}
|
-- * "TOPGUN Graduate" = @{#AIRBOSS.Difficulty.Hard}
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #string skill Player skill. Default "Naval Aviator".
|
-- @param #string skill (Optional) Player skill. Default "Naval Aviator".
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetDefaultPlayerSkill( skill )
|
function AIRBOSS:SetDefaultPlayerSkill( skill )
|
||||||
|
|
||||||
@@ -3507,8 +3507,8 @@ end
|
|||||||
|
|
||||||
--- Enable auto save of player results each time a player is *finally* graded. *Finally* means after the player landed on the carrier! After intermediate passes (bolter or waveoff) the stats are *not* saved.
|
--- Enable auto save of player results each time a player is *finally* graded. *Finally* means after the player landed on the carrier! After intermediate passes (bolter or waveoff) the stats are *not* saved.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #string path Path where to save the asset data file. Default is the DCS root installation directory or your "Saved Games\\DCS" folder if lfs was desanitized.
|
-- @param #string path (Optional) Path where to save the asset data file. Default is the DCS root installation directory or your "Saved Games\\DCS" folder if lfs was desanitized.
|
||||||
-- @param #string filename File name. Default is generated automatically from airboss carrier name/alias.
|
-- @param #string filename (Optional) File name. Default is generated automatically from airboss carrier name/alias.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetAutoSave( path, filename )
|
function AIRBOSS:SetAutoSave( path, filename )
|
||||||
self.autosave = true
|
self.autosave = true
|
||||||
@@ -3540,7 +3540,7 @@ end
|
|||||||
|
|
||||||
--- Set the magnetic declination (or variation). By default this is set to the standard declination of the map.
|
--- Set the magnetic declination (or variation). By default this is set to the standard declination of the map.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number declination Declination in degrees or nil for default declination of the map.
|
-- @param #number declination (Optional) Declination in degrees or nil for default declination of the map.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetMagneticDeclination( declination )
|
function AIRBOSS:SetMagneticDeclination( declination )
|
||||||
self.magvar = declination or UTILS.GetMagneticDeclination()
|
self.magvar = declination or UTILS.GetMagneticDeclination()
|
||||||
@@ -3559,8 +3559,8 @@ end
|
|||||||
--- Set FunkMan socket. LSO grades and trap sheets will be send to your Discord bot.
|
--- Set FunkMan socket. LSO grades and trap sheets will be send to your Discord bot.
|
||||||
-- **Requires running FunkMan program**.
|
-- **Requires running FunkMan program**.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number Port Port. Default `10042`.
|
-- @param #number Port (Optional) Port. Default `10042`.
|
||||||
-- @param #string Host Host. Default `"127.0.0.1"`.
|
-- @param #string Host (Optional) Host. Default `"127.0.0.1"`.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:SetFunkManOn(Port, Host)
|
function AIRBOSS:SetFunkManOn(Port, Host)
|
||||||
|
|
||||||
@@ -3571,7 +3571,7 @@ end
|
|||||||
|
|
||||||
--- Get next time the carrier will start recovering aircraft.
|
--- Get next time the carrier will start recovering aircraft.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #boolean InSeconds If true, abs. mission time seconds is returned. Default is a clock #string.
|
-- @param #boolean InSeconds (Optional) If true, abs. mission time seconds is returned. Default is a clock #string.
|
||||||
-- @return #string Clock start (or start time in abs. seconds).
|
-- @return #string Clock start (or start time in abs. seconds).
|
||||||
-- @return #string Clock stop (or stop time in abs. seconds).
|
-- @return #string Clock stop (or stop time in abs. seconds).
|
||||||
function AIRBOSS:GetNextRecoveryTime( InSeconds )
|
function AIRBOSS:GetNextRecoveryTime( InSeconds )
|
||||||
@@ -6734,7 +6734,7 @@ end
|
|||||||
--- Get marshal altitude and two positions of a counter-clockwise race track pattern.
|
--- Get marshal altitude and two positions of a counter-clockwise race track pattern.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number stack Assigned stack number. Counting starts at one, i.e. stack=1 is the first stack.
|
-- @param #number stack Assigned stack number. Counting starts at one, i.e. stack=1 is the first stack.
|
||||||
-- @param #number case Recovery case. Default is self.case.
|
-- @param #number case (Optional) Recovery case. Default is self.case.
|
||||||
-- @return #number Holding altitude in meters.
|
-- @return #number Holding altitude in meters.
|
||||||
-- @return Core.Point#COORDINATE First race track coordinate.
|
-- @return Core.Point#COORDINATE First race track coordinate.
|
||||||
-- @return Core.Point#COORDINATE Second race track coordinate.
|
-- @return Core.Point#COORDINATE Second race track coordinate.
|
||||||
@@ -7095,8 +7095,8 @@ end
|
|||||||
--- Get next free Marshal stack. Depending on AI/human and recovery case.
|
--- Get next free Marshal stack. Depending on AI/human and recovery case.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #boolean ai If true, get a free stack for an AI flight group.
|
-- @param #boolean ai If true, get a free stack for an AI flight group.
|
||||||
-- @param #number case Recovery case. Default current (self) case in progress.
|
-- @param #number case (Optional) Recovery case. Default current (self) case in progress.
|
||||||
-- @param #boolean empty Return lowest stack that is completely empty.
|
-- @param #boolean empty (Optional) Return lowest stack that is completely empty.
|
||||||
-- @return #number Lowest free stack available for the given case or nil if all Case I stacks are taken.
|
-- @return #number Lowest free stack available for the given case or nil if all Case I stacks are taken.
|
||||||
function AIRBOSS:_GetFreeStack( ai, case, empty )
|
function AIRBOSS:_GetFreeStack( ai, case, empty )
|
||||||
|
|
||||||
@@ -7185,7 +7185,7 @@ end
|
|||||||
--- Get next free Marshal stack. Depending on AI/human and recovery case.
|
--- Get next free Marshal stack. Depending on AI/human and recovery case.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #boolean ai If true, get a free stack for an AI flight group.
|
-- @param #boolean ai If true, get a free stack for an AI flight group.
|
||||||
-- @param #number case Recovery case. Default current (self) case in progress.
|
-- @param #number case (Optional) Recovery case. Default current (self) case in progress.
|
||||||
-- @param #boolean empty Return lowest stack that is completely empty.
|
-- @param #boolean empty Return lowest stack that is completely empty.
|
||||||
-- @return #number Lowest free stack available for the given case or nil if all Case I stacks are taken.
|
-- @return #number Lowest free stack available for the given case or nil if all Case I stacks are taken.
|
||||||
function AIRBOSS:_GetFreeStack_Old( ai, case, empty )
|
function AIRBOSS:_GetFreeStack_Old( ai, case, empty )
|
||||||
@@ -7253,7 +7253,7 @@ end
|
|||||||
--- Get number of (airborne) units in a flight.
|
--- Get number of (airborne) units in a flight.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #AIRBOSS.FlightGroup flight The flight group.
|
-- @param #AIRBOSS.FlightGroup flight The flight group.
|
||||||
-- @param #boolean onground If true, include units on the ground. By default only airborne units are counted.
|
-- @param #boolean onground (Optional) If true, include units on the ground. By default only airborne units are counted.
|
||||||
-- @return #number Number of units in flight including section members.
|
-- @return #number Number of units in flight including section members.
|
||||||
-- @return #number Number of units in flight excluding section members.
|
-- @return #number Number of units in flight excluding section members.
|
||||||
-- @return #number Number of section members.
|
-- @return #number Number of section members.
|
||||||
@@ -10958,9 +10958,9 @@ end
|
|||||||
|
|
||||||
--- Get groove zone.
|
--- Get groove zone.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number l Length of the groove in NM. Default 1.5 NM.
|
-- @param #number l (Optional) Length of the groove in NM. Default 1.5 NM.
|
||||||
-- @param #number w Width of the groove in NM. Default 0.25 NM.
|
-- @param #number w (Optional) Width of the groove in NM. Default 0.25 NM.
|
||||||
-- @param #number b Width of the beginning in NM. Default 0.10 NM.
|
-- @param #number b (Optional) Width of the beginning in NM. Default 0.10 NM.
|
||||||
-- @return Core.Zone#ZONE_POLYGON_BASE Groove zone.
|
-- @return Core.Zone#ZONE_POLYGON_BASE Groove zone.
|
||||||
function AIRBOSS:_GetZoneGroove( l, w, b )
|
function AIRBOSS:_GetZoneGroove( l, w, b )
|
||||||
|
|
||||||
@@ -11131,7 +11131,7 @@ end
|
|||||||
--- Get approach corridor zone. Shape depends on recovery case.
|
--- Get approach corridor zone. Shape depends on recovery case.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number case Recovery case.
|
-- @param #number case Recovery case.
|
||||||
-- @param #number l Length of the zone in NM. Default 31 (=21+10) NM.
|
-- @param #number l (Optional) Length of the zone in NM. Default 31 (=21+10) NM.
|
||||||
-- @return Core.Zone#ZONE_POLYGON_BASE Box zone.
|
-- @return Core.Zone#ZONE_POLYGON_BASE Box zone.
|
||||||
function AIRBOSS:_GetZoneCorridor( case, l )
|
function AIRBOSS:_GetZoneCorridor( case, l )
|
||||||
|
|
||||||
@@ -11977,7 +11977,7 @@ end
|
|||||||
|
|
||||||
--- Get true (or magnetic) heading of carrier.
|
--- Get true (or magnetic) heading of carrier.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #boolean magnetic If true, calculate magnetic heading. By default true heading is returned.
|
-- @param #boolean magnetic (Optional) If true, calculate magnetic heading. By default true heading is returned.
|
||||||
-- @return #number Carrier heading in degrees.
|
-- @return #number Carrier heading in degrees.
|
||||||
function AIRBOSS:GetHeading( magnetic )
|
function AIRBOSS:GetHeading( magnetic )
|
||||||
self:F3( { magnetic = magnetic } )
|
self:F3( { magnetic = magnetic } )
|
||||||
@@ -12010,8 +12010,8 @@ end
|
|||||||
|
|
||||||
--- Get wind direction and speed at carrier position.
|
--- Get wind direction and speed at carrier position.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number alt Altitude ASL in meters. Default 18 m.
|
-- @param #number alt (Optional) Altitude ASL in meters. Default 18 m.
|
||||||
-- @param #boolean magnetic Direction including magnetic declination.
|
-- @param #boolean magnetic (Optional) Direction including magnetic declination.
|
||||||
-- @param Core.Point#COORDINATE coord (Optional) Coordinate at which to get the wind. Default is current carrier position.
|
-- @param Core.Point#COORDINATE coord (Optional) Coordinate at which to get the wind. Default is current carrier position.
|
||||||
-- @return #number Direction the wind is blowing **from** in degrees.
|
-- @return #number Direction the wind is blowing **from** in degrees.
|
||||||
-- @return #number Wind speed in m/s.
|
-- @return #number Wind speed in m/s.
|
||||||
@@ -12037,7 +12037,7 @@ end
|
|||||||
|
|
||||||
--- Get wind speed on carrier deck parallel and perpendicular to runway.
|
--- Get wind speed on carrier deck parallel and perpendicular to runway.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number alt Altitude in meters. Default 18 m.
|
-- @param #number alt (Optional) Altitude in meters. Default 18 m.
|
||||||
-- @return #number Wind component parallel to runway im m/s.
|
-- @return #number Wind component parallel to runway im m/s.
|
||||||
-- @return #number Wind component perpendicular to runway in m/s.
|
-- @return #number Wind component perpendicular to runway in m/s.
|
||||||
-- @return #number Total wind strength in m/s.
|
-- @return #number Total wind strength in m/s.
|
||||||
@@ -12083,7 +12083,7 @@ end
|
|||||||
--- Get true (or magnetic) heading of carrier into the wind. This accounts for the angled runway.
|
--- Get true (or magnetic) heading of carrier into the wind. This accounts for the angled runway.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number vdeck Desired wind velocity over deck in knots.
|
-- @param #number vdeck Desired wind velocity over deck in knots.
|
||||||
-- @param #boolean magnetic If true, calculate magnetic heading. By default true heading is returned.
|
-- @param #boolean magnetic (Optional) If true, calculate magnetic heading. By default true heading is returned.
|
||||||
-- @param Core.Point#COORDINATE coord (Optional) Coordinate from which heading is calculated. Default is current carrier position.
|
-- @param Core.Point#COORDINATE coord (Optional) Coordinate from which heading is calculated. Default is current carrier position.
|
||||||
-- @return #number Carrier heading in degrees.
|
-- @return #number Carrier heading in degrees.
|
||||||
-- @return #number Carrier speed in knots to reach desired wind speed on deck.
|
-- @return #number Carrier speed in knots to reach desired wind speed on deck.
|
||||||
@@ -12103,7 +12103,7 @@ end
|
|||||||
--- Get true (or magnetic) heading of carrier into the wind. This accounts for the angled runway.
|
--- Get true (or magnetic) heading of carrier into the wind. This accounts for the angled runway.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number vdeck Desired wind velocity over deck in knots.
|
-- @param #number vdeck Desired wind velocity over deck in knots.
|
||||||
-- @param #boolean magnetic If true, calculate magnetic heading. By default true heading is returned.
|
-- @param #boolean magnetic (Optional) If true, calculate magnetic heading. By default true heading is returned.
|
||||||
-- @param Core.Point#COORDINATE coord (Optional) Coordinate from which heading is calculated. Default is current carrier position.
|
-- @param Core.Point#COORDINATE coord (Optional) Coordinate from which heading is calculated. Default is current carrier position.
|
||||||
-- @return #number Carrier heading in degrees.
|
-- @return #number Carrier heading in degrees.
|
||||||
function AIRBOSS:GetHeadingIntoWind_old( vdeck, magnetic, coord )
|
function AIRBOSS:GetHeadingIntoWind_old( vdeck, magnetic, coord )
|
||||||
@@ -12176,7 +12176,7 @@ end
|
|||||||
-- Implementation based on [Mags & Bambi](https://magwo.github.io/carrier-cruise/).
|
-- Implementation based on [Mags & Bambi](https://magwo.github.io/carrier-cruise/).
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number vdeck Desired wind velocity over deck in knots.
|
-- @param #number vdeck Desired wind velocity over deck in knots.
|
||||||
-- @param #boolean magnetic If true, calculate magnetic heading. By default true heading is returned.
|
-- @param #boolean magnetic (Optional) If true, calculate magnetic heading. By default true heading is returned.
|
||||||
-- @param Core.Point#COORDINATE coord (Optional) Coordinate from which heading is calculated. Default is current carrier position.
|
-- @param Core.Point#COORDINATE coord (Optional) Coordinate from which heading is calculated. Default is current carrier position.
|
||||||
-- @return #number Carrier heading in degrees.
|
-- @return #number Carrier heading in degrees.
|
||||||
-- @return #number Carrier speed in knots to reach desired wind speed on deck.
|
-- @return #number Carrier speed in knots to reach desired wind speed on deck.
|
||||||
@@ -12307,9 +12307,9 @@ end
|
|||||||
--
|
--
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #number case Recovery case.
|
-- @param #number case Recovery case.
|
||||||
-- @param #boolean magnetic If true, magnetic radial is returned. Default is true radial.
|
-- @param #boolean magnetic (Optional) If true, magnetic radial is returned. Default is true radial.
|
||||||
-- @param #boolean offset If true, inlcude holding offset.
|
-- @param #boolean offset (Optional) If true, inlcude holding offset.
|
||||||
-- @param #boolean inverse Return inverse, i.e. radial-180 degrees.
|
-- @param #boolean inverse (Optional) Return inverse, i.e. radial-180 degrees.
|
||||||
-- @return #number Radial in degrees.
|
-- @return #number Radial in degrees.
|
||||||
function AIRBOSS:GetRadial( case, magnetic, offset, inverse )
|
function AIRBOSS:GetRadial( case, magnetic, offset, inverse )
|
||||||
|
|
||||||
@@ -13255,7 +13255,7 @@ end
|
|||||||
--- Get short name of the grove step.
|
--- Get short name of the grove step.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #string step Player step.
|
-- @param #string step Player step.
|
||||||
-- @param #number n Use -1 for previous or +1 for next. Default 0.
|
-- @param #number n (Optional) Use -1 for previous or +1 for next. Default 0.
|
||||||
-- @return #string Shortcut name "X", "RB", "IM", "AR", "IW".
|
-- @return #string Shortcut name "X", "RB", "IM", "AR", "IW".
|
||||||
function AIRBOSS:_GS( step, n )
|
function AIRBOSS:_GS( step, n )
|
||||||
local gp
|
local gp
|
||||||
@@ -13454,7 +13454,7 @@ end
|
|||||||
--- Display hint to player.
|
--- Display hint to player.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #AIRBOSS.PlayerData playerData Player data table.
|
-- @param #AIRBOSS.PlayerData playerData Player data table.
|
||||||
-- @param #number delay Delay before playing sound messages. Default 0 sec.
|
-- @param #number delay (Optional) Delay before playing sound messages. Default 0 sec.
|
||||||
-- @param #boolean soundoff If true, don't play and sound hint.
|
-- @param #boolean soundoff If true, don't play and sound hint.
|
||||||
function AIRBOSS:_PlayerHint( playerData, delay, soundoff )
|
function AIRBOSS:_PlayerHint( playerData, delay, soundoff )
|
||||||
|
|
||||||
@@ -14276,7 +14276,7 @@ end
|
|||||||
|
|
||||||
--- Check Collision.
|
--- Check Collision.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param Core.Point#COORDINATE fromcoord Coordinate from which the path to the next WP is calculated. Default current carrier position.
|
-- @param Core.Point#COORDINATE fromcoord (Optional) Coordinate from which the path to the next WP is calculated. Default current carrier position.
|
||||||
-- @return #boolean If true, surface type ahead is not deep water.
|
-- @return #boolean If true, surface type ahead is not deep water.
|
||||||
function AIRBOSS:_CheckFreePathToNextWP( fromcoord )
|
function AIRBOSS:_CheckFreePathToNextWP( fromcoord )
|
||||||
|
|
||||||
@@ -14354,9 +14354,9 @@ end
|
|||||||
--- Let the carrier make a detour to a given point. When it reaches the point, it will resume its normal route.
|
--- Let the carrier make a detour to a given point. When it reaches the point, it will resume its normal route.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param Core.Point#COORDINATE coord Coordinate of the detour.
|
-- @param Core.Point#COORDINATE coord Coordinate of the detour.
|
||||||
-- @param #number speed Speed in knots. Default is current carrier velocity.
|
-- @param #number speed (Optional) Speed in knots. Default is current carrier velocity.
|
||||||
-- @param #boolean uturn (Optional) If true, carrier will go back to where it came from before it resumes its route to the next waypoint.
|
-- @param #boolean uturn (Optional) If true, carrier will go back to where it came from before it resumes its route to the next waypoint.
|
||||||
-- @param #number uspeed Speed in knots after U-turn. Default is same as before.
|
-- @param #number uspeed (Optional) Speed in knots after U-turn. Default is same as before.
|
||||||
-- @param Core.Point#COORDINATE tcoord Additional coordinate to make turn smoother.
|
-- @param Core.Point#COORDINATE tcoord Additional coordinate to make turn smoother.
|
||||||
-- @return #AIRBOSS self
|
-- @return #AIRBOSS self
|
||||||
function AIRBOSS:CarrierDetour( coord, speed, uturn, uspeed, tcoord )
|
function AIRBOSS:CarrierDetour( coord, speed, uturn, uspeed, tcoord )
|
||||||
@@ -16090,11 +16090,11 @@ end
|
|||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #AIRBOSS.PlayerData playerData Player data.
|
-- @param #AIRBOSS.PlayerData playerData Player data.
|
||||||
-- @param #string message The message to send.
|
-- @param #string message The message to send.
|
||||||
-- @param #string sender The person who sends the message or nil.
|
-- @param #string sender (Optional) The person who sends the message or nil. Defaults to nil.
|
||||||
-- @param #string receiver The person who receives the message. Default player's onboard number. Set to "" for no receiver.
|
-- @param #string receiver (Optional) The person who receives the message. Default player's onboard number. Set to "" for no receiver.
|
||||||
-- @param #number duration Display message duration. Default 10 seconds.
|
-- @param #number duration (Optional) Display message duration. Default 10 seconds.
|
||||||
-- @param #boolean clear If true, clear screen from previous messages.
|
-- @param #boolean clear I(Optional) f true, clear screen from previous messages. Defaults to false.
|
||||||
-- @param #number delay Delay in seconds, before the message is displayed.
|
-- @param #number delay (Optional) Delay in seconds, before the message is displayed.
|
||||||
function AIRBOSS:MessageToPlayer( playerData, message, sender, receiver, duration, clear, delay )
|
function AIRBOSS:MessageToPlayer( playerData, message, sender, receiver, duration, clear, delay )
|
||||||
self:T({sender,receiver,message})
|
self:T({sender,receiver,message})
|
||||||
if playerData and message and message ~= "" then
|
if playerData and message and message ~= "" then
|
||||||
@@ -16218,11 +16218,11 @@ end
|
|||||||
-- Message format will be "SENDER: RECCEIVER, MESSAGE".
|
-- Message format will be "SENDER: RECCEIVER, MESSAGE".
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #string message The message to send.
|
-- @param #string message The message to send.
|
||||||
-- @param #string sender The person who sends the message or nil.
|
-- @param #string sender (Optional) The person who sends the message or nil. Defaults to "LSO".
|
||||||
-- @param #string receiver The person who receives the message. Default player's onboard number. Set to "" for no receiver.
|
-- @param #string receiver (Optional) The person who receives the message. Default player's onboard number. Set to "" for no receiver.
|
||||||
-- @param #number duration Display message duration. Default 10 seconds.
|
-- @param #number duration (Optional) Display message duration. Default 10 seconds.
|
||||||
-- @param #boolean clear If true, clear screen from previous messages.
|
-- @param #boolean clear (Optional) If true, clear screen from previous messages.
|
||||||
-- @param #number delay Delay in seconds, before the message is displayed.
|
-- @param #number delay (Optional) Delay in seconds, before the message is displayed.
|
||||||
function AIRBOSS:MessageToPattern( message, sender, receiver, duration, clear, delay )
|
function AIRBOSS:MessageToPattern( message, sender, receiver, duration, clear, delay )
|
||||||
|
|
||||||
-- Create new (fake) radio call to show the subtitile.
|
-- Create new (fake) radio call to show the subtitile.
|
||||||
@@ -16237,11 +16237,11 @@ end
|
|||||||
-- Message format will be "SENDER: RECCEIVER, MESSAGE".
|
-- Message format will be "SENDER: RECCEIVER, MESSAGE".
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #string message The message to send.
|
-- @param #string message The message to send.
|
||||||
-- @param #string sender The person who sends the message or nil.
|
-- @param #string sender (Optional) The person who sends the message or nil. Defaults to "Marshal".
|
||||||
-- @param #string receiver The person who receives the message. Default player's onboard number. Set to "" for no receiver.
|
-- @param #string receiver (Optional) The person who receives the message. Default player's onboard number. Set to "" for no receiver.
|
||||||
-- @param #number duration Display message duration. Default 10 seconds.
|
-- @param #number duration (Optional) Display message duration. Default 10 seconds.
|
||||||
-- @param #boolean clear If true, clear screen from previous messages.
|
-- @param #boolean clear (Optional) If true, clear screen from previous messages.
|
||||||
-- @param #number delay Delay in seconds, before the message is displayed.
|
-- @param #number delay (Optional) Delay in seconds, before the message is displayed.
|
||||||
function AIRBOSS:MessageToMarshal( message, sender, receiver, duration, clear, delay )
|
function AIRBOSS:MessageToMarshal( message, sender, receiver, duration, clear, delay )
|
||||||
|
|
||||||
-- Create new (fake) radio call to show the subtitile.
|
-- Create new (fake) radio call to show the subtitile.
|
||||||
@@ -16255,11 +16255,11 @@ end
|
|||||||
--- Generate a new radio call (deepcopy) from an existing default call.
|
--- Generate a new radio call (deepcopy) from an existing default call.
|
||||||
-- @param #AIRBOSS self
|
-- @param #AIRBOSS self
|
||||||
-- @param #AIRBOSS.RadioCall call Radio call to be enhanced.
|
-- @param #AIRBOSS.RadioCall call Radio call to be enhanced.
|
||||||
-- @param #string sender Sender of the message. Default is the radio alias.
|
-- @param #string sender (Optional) Sender of the message. Default is the radio alias.
|
||||||
-- @param #string subtitle Subtitle of the message. Default from original radio call. Use "" for no subtitle.
|
-- @param #string subtitle (Optional) Subtitle of the message. Default from original radio call. Use "" for no subtitle.
|
||||||
-- @param #number subduration Time in seconds the subtitle is displayed. Default 10 seconds.
|
-- @param #number subduration (Optional) Time in seconds the subtitle is displayed. Default 10 seconds.
|
||||||
-- @param #string modexreceiver Onboard number of the receiver or nil.
|
-- @param #string modexreceiver (Optional) Onboard number of the receiver or nil.
|
||||||
-- @param #string modexsender Onboard number of the sender or nil.
|
-- @param #string modexsender (Optional) Onboard number of the sender or nil.
|
||||||
function AIRBOSS:_NewRadioCall( call, sender, subtitle, subduration, modexreceiver, modexsender )
|
function AIRBOSS:_NewRadioCall( call, sender, subtitle, subduration, modexreceiver, modexsender )
|
||||||
|
|
||||||
-- Create a new call
|
-- Create a new call
|
||||||
@@ -19201,7 +19201,7 @@ end
|
|||||||
-- @param #string From From state.
|
-- @param #string From From state.
|
||||||
-- @param #string Event Event.
|
-- @param #string Event Event.
|
||||||
-- @param #string To To state.
|
-- @param #string To To state.
|
||||||
-- @param #string path Path where the file is loaded from. Default is the DCS root installation folder or your "Saved Games\\DCS" folder if lfs was desanizied.
|
-- @param #string path (Optional) Path where the file is loaded from. Default is the DCS root installation folder or your "Saved Games\\DCS" folder if lfs was desanizied.
|
||||||
-- @param #string filename (Optional) File name for saving the player grades. Default is "AIRBOSS-<ALIAS>_LSOgrades.csv".
|
-- @param #string filename (Optional) File name for saving the player grades. Default is "AIRBOSS-<ALIAS>_LSOgrades.csv".
|
||||||
function AIRBOSS:onafterLoad( From, Event, To, path, filename )
|
function AIRBOSS:onafterLoad( From, Event, To, path, filename )
|
||||||
|
|
||||||
|
|||||||
@@ -463,10 +463,10 @@ end
|
|||||||
-- @param #ARMYGROUP self
|
-- @param #ARMYGROUP self
|
||||||
-- @param Core.Point#COORDINATE Coordinate Coordinate of the target.
|
-- @param Core.Point#COORDINATE Coordinate Coordinate of the target.
|
||||||
-- @param #string Clock Time when to start the attack.
|
-- @param #string Clock Time when to start the attack.
|
||||||
-- @param #number Radius Radius in meters. Default 100 m.
|
-- @param #number Radius (Optional) Radius in meters. Default 100 m.
|
||||||
-- @param #number Nshots Number of shots to fire. Default 3.
|
-- @param #number Nshots (Optional) Number of shots to fire. Default 3.
|
||||||
-- @param #number WeaponType Type of weapon. Default auto.
|
-- @param #number WeaponType (Optional) Type of weapon. Default auto.
|
||||||
-- @param #number Prio Priority of the task.
|
-- @param #number Prio (Optional) Priority of the task. Defaults to 50.
|
||||||
-- @return Ops.OpsGroup#OPSGROUP.Task The task table.
|
-- @return Ops.OpsGroup#OPSGROUP.Task The task table.
|
||||||
function ARMYGROUP:AddTaskFireAtPoint(Coordinate, Clock, Radius, Nshots, WeaponType, Prio)
|
function ARMYGROUP:AddTaskFireAtPoint(Coordinate, Clock, Radius, Nshots, WeaponType, Prio)
|
||||||
|
|
||||||
@@ -485,10 +485,10 @@ end
|
|||||||
-- @param #number Heading Heading min in Degrees.
|
-- @param #number Heading Heading min in Degrees.
|
||||||
-- @param #number Alpha Shooting angle in Degrees.
|
-- @param #number Alpha Shooting angle in Degrees.
|
||||||
-- @param #number Altitude Altitude in meters.
|
-- @param #number Altitude Altitude in meters.
|
||||||
-- @param #number Radius Radius in meters. Default 100 m.
|
-- @param #number Radius (Optional) Radius in meters. Default 100 m.
|
||||||
-- @param #number Nshots Number of shots to fire. Default nil.
|
-- @param #number Nshots (Optional) Number of shots to fire. Default nil.
|
||||||
-- @param #number WeaponType Type of weapon. Default auto.
|
-- @param #number WeaponType (Optional) Type of weapon. Default auto.
|
||||||
-- @param #number Prio Priority of the task.
|
-- @param #number Prio (Optional) Priority of the task. Defaults to 50.
|
||||||
-- @return Ops.OpsGroup#OPSGROUP.Task The task table.
|
-- @return Ops.OpsGroup#OPSGROUP.Task The task table.
|
||||||
function ARMYGROUP:AddTaskBarrage(Clock, Heading, Alpha, Altitude, Radius, Nshots, WeaponType, Prio)
|
function ARMYGROUP:AddTaskBarrage(Clock, Heading, Alpha, Altitude, Radius, Nshots, WeaponType, Prio)
|
||||||
|
|
||||||
@@ -516,11 +516,11 @@ end
|
|||||||
--- Add a *waypoint* task to fire at a given coordinate.
|
--- Add a *waypoint* task to fire at a given coordinate.
|
||||||
-- @param #ARMYGROUP self
|
-- @param #ARMYGROUP self
|
||||||
-- @param Core.Point#COORDINATE Coordinate Coordinate of the target.
|
-- @param Core.Point#COORDINATE Coordinate Coordinate of the target.
|
||||||
-- @param Ops.OpsGroup#OPSGROUP.Waypoint Waypoint Where the task is executed. Default is next waypoint.
|
-- @param Ops.OpsGroup#OPSGROUP.Waypoint Waypoint (Optional) Where the task is executed. Default is next waypoint.
|
||||||
-- @param #number Radius Radius in meters. Default 100 m.
|
-- @param #number Radius (Optional) Radius in meters. Default 100 m.
|
||||||
-- @param #number Nshots Number of shots to fire. Default 3.
|
-- @param #number Nshots (Optional) Number of shots to fire. Default 3.
|
||||||
-- @param #number WeaponType Type of weapon. Default auto.
|
-- @param #number WeaponType (Optional) Type of weapon. Default auto.
|
||||||
-- @param #number Prio Priority of the task.
|
-- @param #number Prio (Optional) Priority of the task. Defaults to 50.
|
||||||
-- @return Ops.OpsGroup#OPSGROUP.Task The task table.
|
-- @return Ops.OpsGroup#OPSGROUP.Task The task table.
|
||||||
function ARMYGROUP:AddTaskWaypointFireAtPoint(Coordinate, Waypoint, Radius, Nshots, WeaponType, Prio)
|
function ARMYGROUP:AddTaskWaypointFireAtPoint(Coordinate, Waypoint, Radius, Nshots, WeaponType, Prio)
|
||||||
|
|
||||||
@@ -538,10 +538,10 @@ end
|
|||||||
--- Add a *scheduled* task.
|
--- Add a *scheduled* task.
|
||||||
-- @param #ARMYGROUP self
|
-- @param #ARMYGROUP self
|
||||||
-- @param Wrapper.Group#GROUP TargetGroup Target group.
|
-- @param Wrapper.Group#GROUP TargetGroup Target group.
|
||||||
-- @param #number WeaponExpend How much weapons does are used.
|
-- @param #number WeaponExpend (Optional) How much weapons does are used. Defaults to "Auto".
|
||||||
-- @param #number WeaponType Type of weapon. Default auto.
|
-- @param #number WeaponType (Optional) Type of weapon. Default auto.
|
||||||
-- @param #string Clock Time when to start the attack.
|
-- @param #string Clock (Optional) Time when to start the attack. Defaults to 5.
|
||||||
-- @param #number Prio Priority of the task.
|
-- @param #number Prio (Optional) Priority of the task. Defaults to 50.
|
||||||
-- @return Ops.OpsGroup#OPSGROUP.Task The task table.
|
-- @return Ops.OpsGroup#OPSGROUP.Task The task table.
|
||||||
function ARMYGROUP:AddTaskAttackGroup(TargetGroup, WeaponExpend, WeaponType, Clock, Prio)
|
function ARMYGROUP:AddTaskAttackGroup(TargetGroup, WeaponExpend, WeaponType, Clock, Prio)
|
||||||
|
|
||||||
@@ -574,7 +574,7 @@ end
|
|||||||
|
|
||||||
--- Define a set of possible retreat zones.
|
--- Define a set of possible retreat zones.
|
||||||
-- @param #ARMYGROUP self
|
-- @param #ARMYGROUP self
|
||||||
-- @param Core.Set#SET_ZONE RetreatZoneSet The retreat zone set. Default is an empty set.
|
-- @param Core.Set#SET_ZONE RetreatZoneSet (Optional) The retreat zone set. Default is an empty set.
|
||||||
-- @return #ARMYGROUP self
|
-- @return #ARMYGROUP self
|
||||||
function ARMYGROUP:SetRetreatZones(RetreatZoneSet)
|
function ARMYGROUP:SetRetreatZones(RetreatZoneSet)
|
||||||
self.retreatZones=RetreatZoneSet or SET_ZONE:New()
|
self.retreatZones=RetreatZoneSet or SET_ZONE:New()
|
||||||
@@ -592,7 +592,7 @@ end
|
|||||||
|
|
||||||
--- Set suppression on. average, minimum and maximum time a unit is suppressed each time it gets hit.
|
--- Set suppression on. average, minimum and maximum time a unit is suppressed each time it gets hit.
|
||||||
-- @param #ARMYGROUP self
|
-- @param #ARMYGROUP self
|
||||||
-- @param #number Tave Average time [seconds] a group will be suppressed. Default is 15 seconds.
|
-- @param #number Tave (Optional) Average time [seconds] a group will be suppressed. Default is 15 seconds.
|
||||||
-- @param #number Tmin (Optional) Minimum time [seconds] a group will be suppressed. Default is 5 seconds.
|
-- @param #number Tmin (Optional) Minimum time [seconds] a group will be suppressed. Default is 5 seconds.
|
||||||
-- @param #number Tmax (Optional) Maximum time a group will be suppressed. Default is 25 seconds.
|
-- @param #number Tmax (Optional) Maximum time a group will be suppressed. Default is 25 seconds.
|
||||||
-- @return #ARMYGROUP self
|
-- @return #ARMYGROUP self
|
||||||
@@ -995,10 +995,10 @@ end
|
|||||||
-- @param #string From From state.
|
-- @param #string From From state.
|
||||||
-- @param #string Event Event.
|
-- @param #string Event Event.
|
||||||
-- @param #string To To state.
|
-- @param #string To To state.
|
||||||
-- @param #number n Next waypoint index. Default is the one coming after that one that has been passed last.
|
-- @param #number n (Optional) Next waypoint index. Default is the one coming after that one that has been passed last.
|
||||||
-- @param #number N Waypoint Max waypoint index to be included in the route. Default is the final waypoint.
|
-- @param #number N (Optional) Waypoint Max waypoint index to be included in the route. Default is the final waypoint.
|
||||||
-- @param #number Speed Speed in knots. Default cruise speed.
|
-- @param #number Speed (Optional) Speed in knots. Default cruise speed.
|
||||||
-- @param #number Formation Formation of the group.
|
-- @param #number Formation (Optional) Formation of the group.
|
||||||
function ARMYGROUP:onbeforeUpdateRoute(From, Event, To, n, N, Speed, Formation)
|
function ARMYGROUP:onbeforeUpdateRoute(From, Event, To, n, N, Speed, Formation)
|
||||||
|
|
||||||
-- Is transition allowed? We assume yes until proven otherwise.
|
-- Is transition allowed? We assume yes until proven otherwise.
|
||||||
@@ -1082,10 +1082,10 @@ end
|
|||||||
-- @param #string From From state.
|
-- @param #string From From state.
|
||||||
-- @param #string Event Event.
|
-- @param #string Event Event.
|
||||||
-- @param #string To To state.
|
-- @param #string To To state.
|
||||||
-- @param #number n Next waypoint index. Default is the one coming after that one that has been passed last.
|
-- @param #number n (Optional) Next waypoint index. Default is the one coming after that one that has been passed last.
|
||||||
-- @param #number N Waypoint Max waypoint index to be included in the route. Default is the final waypoint.
|
-- @param #number N (Optional) Waypoint Max waypoint index to be included in the route. Default is the final waypoint.
|
||||||
-- @param #number Speed Speed in knots. Default cruise speed.
|
-- @param #number Speed (Optional) Speed in knots. Default cruise speed.
|
||||||
-- @param #number Formation Formation of the group.
|
-- @param #number Formation (Optional) Formation of the group.
|
||||||
function ARMYGROUP:onafterUpdateRoute(From, Event, To, n, N, Speed, Formation)
|
function ARMYGROUP:onafterUpdateRoute(From, Event, To, n, N, Speed, Formation)
|
||||||
|
|
||||||
-- Update route from this waypoint number onwards.
|
-- Update route from this waypoint number onwards.
|
||||||
@@ -1358,7 +1358,7 @@ end
|
|||||||
-- @param #string Event Event.
|
-- @param #string Event Event.
|
||||||
-- @param #string To To state.
|
-- @param #string To To state.
|
||||||
-- @param Core.Point#COORDINATE Coordinate Coordinate where to go.
|
-- @param Core.Point#COORDINATE Coordinate Coordinate where to go.
|
||||||
-- @param #number Speed Speed in knots. Default cruise speed.
|
-- @param #number Speed (Optional) Speed in knots. Default cruise speed.
|
||||||
-- @param #number Formation Formation of the group.
|
-- @param #number Formation Formation of the group.
|
||||||
-- @param #number ResumeRoute If true, resume route after detour point was reached. If false, the group will stop at the detour point and wait for futher commands.
|
-- @param #number ResumeRoute If true, resume route after detour point was reached. If false, the group will stop at the detour point and wait for futher commands.
|
||||||
function ARMYGROUP:onafterDetour(From, Event, To, Coordinate, Speed, Formation, ResumeRoute)
|
function ARMYGROUP:onafterDetour(From, Event, To, Coordinate, Speed, Formation, ResumeRoute)
|
||||||
@@ -1738,7 +1738,7 @@ end
|
|||||||
-- @param #string To To state.
|
-- @param #string To To state.
|
||||||
-- @param Wrapper.Group#GROUP Group the group to be engaged.
|
-- @param Wrapper.Group#GROUP Group the group to be engaged.
|
||||||
-- @param #number Speed Speed in knots.
|
-- @param #number Speed Speed in knots.
|
||||||
-- @param #string Formation Formation used in the engagement. Default `ENUMS.Formation.Vehicle.Vee`.
|
-- @param #string Formation (Optional) Formation used in the engagement. Default `ENUMS.Formation.Vehicle.Vee`.
|
||||||
function ARMYGROUP:onbeforeEngageTarget(From, Event, To, Target, Speed, Formation)
|
function ARMYGROUP:onbeforeEngageTarget(From, Event, To, Target, Speed, Formation)
|
||||||
|
|
||||||
local dt=nil
|
local dt=nil
|
||||||
@@ -1779,7 +1779,7 @@ end
|
|||||||
-- @param #string To To state.
|
-- @param #string To To state.
|
||||||
-- @param Ops.Target#TARGET Target The target to be engaged. Can also be a group or unit.
|
-- @param Ops.Target#TARGET Target The target to be engaged. Can also be a group or unit.
|
||||||
-- @param #number Speed Attack speed in knots.
|
-- @param #number Speed Attack speed in knots.
|
||||||
-- @param #string Formation Formation used in the engagement. Default `ENUMS.Formation.Vehicle.Vee`.
|
-- @param #string Formation (Optional) Formation used in the engagement. Default `ENUMS.Formation.Vehicle.Vee`.
|
||||||
function ARMYGROUP:onafterEngageTarget(From, Event, To, Target, Speed, Formation)
|
function ARMYGROUP:onafterEngageTarget(From, Event, To, Target, Speed, Formation)
|
||||||
self:T(self.lid.."Engaging Target")
|
self:T(self.lid.."Engaging Target")
|
||||||
|
|
||||||
@@ -1983,10 +1983,10 @@ end
|
|||||||
--- Add an a waypoint to the route.
|
--- Add an a waypoint to the route.
|
||||||
-- @param #ARMYGROUP self
|
-- @param #ARMYGROUP self
|
||||||
-- @param Core.Point#COORDINATE Coordinate The coordinate of the waypoint.
|
-- @param Core.Point#COORDINATE Coordinate The coordinate of the waypoint.
|
||||||
-- @param #number Speed Speed in knots. Default is default cruise speed or 70% of max speed.
|
-- @param #number Speed (Optional) Speed in knots. Default is default cruise speed or 70% of max speed.
|
||||||
-- @param #number AfterWaypointWithID Insert waypoint after waypoint given ID. Default is to insert as last waypoint.
|
-- @param #number AfterWaypointWithID (Optional) Insert waypoint after waypoint given ID. Default is to insert as last waypoint.
|
||||||
-- @param #string Formation Formation the group will use.
|
-- @param #string Formation (Optional) Formation the group will use.
|
||||||
-- @param #boolean Updateroute If true or nil, call UpdateRoute. If false, no call.
|
-- @param #boolean Updateroute (Optional) If true or nil, call UpdateRoute. If false, no call.
|
||||||
-- @return Ops.OpsGroup#OPSGROUP.Waypoint Waypoint table.
|
-- @return Ops.OpsGroup#OPSGROUP.Waypoint Waypoint table.
|
||||||
function ARMYGROUP:AddWaypoint(Coordinate, Speed, AfterWaypointWithID, Formation, Updateroute)
|
function ARMYGROUP:AddWaypoint(Coordinate, Speed, AfterWaypointWithID, Formation, Updateroute)
|
||||||
|
|
||||||
@@ -2047,8 +2047,8 @@ end
|
|||||||
|
|
||||||
--- Initialize group parameters. Also initializes waypoints if self.waypoints is nil.
|
--- Initialize group parameters. Also initializes waypoints if self.waypoints is nil.
|
||||||
-- @param #ARMYGROUP self
|
-- @param #ARMYGROUP self
|
||||||
-- @param #table Template Template used to init the group. Default is `self.template`.
|
-- @param #table Template (Optional) Template used to init the group. Default is `self.template`.
|
||||||
-- @param #number Delay Delay in seconds before group is initialized. Default `nil`, *i.e.* instantaneous.
|
-- @param #number Delay (Optional) Delay in seconds before group is initialized. Default `nil`, *i.e.* instantaneous.
|
||||||
-- @return #ARMYGROUP self
|
-- @return #ARMYGROUP self
|
||||||
function ARMYGROUP:_InitGroup(Template, Delay)
|
function ARMYGROUP:_InitGroup(Template, Delay)
|
||||||
|
|
||||||
@@ -2145,9 +2145,9 @@ end
|
|||||||
|
|
||||||
--- Switch to a specific formation.
|
--- Switch to a specific formation.
|
||||||
-- @param #ARMYGROUP self
|
-- @param #ARMYGROUP self
|
||||||
-- @param #number Formation New formation the group will fly in. Default is the setting of `SetDefaultFormation()`.
|
-- @param #number Formation (Optional) New formation the group will fly in. Default is the setting of `SetDefaultFormation()`.
|
||||||
-- @param #boolean Permanently If true, formation always used from now on.
|
-- @param #boolean Permanently (Optional) If true, formation always used from now on. Defaults to false.
|
||||||
-- @param #boolean NoRouteUpdate If true, route is not updated.
|
-- @param #boolean NoRouteUpdate (Optional) If true, route is not updated. Defaults to false.
|
||||||
-- @return #ARMYGROUP self
|
-- @return #ARMYGROUP self
|
||||||
function ARMYGROUP:SwitchFormation(Formation, Permanently, NoRouteUpdate)
|
function ARMYGROUP:SwitchFormation(Formation, Permanently, NoRouteUpdate)
|
||||||
|
|
||||||
@@ -2191,7 +2191,7 @@ end
|
|||||||
|
|
||||||
--- Find the neares ammo supply group within a given radius.
|
--- Find the neares ammo supply group within a given radius.
|
||||||
-- @param #ARMYGROUP self
|
-- @param #ARMYGROUP self
|
||||||
-- @param #number Radius Search radius in NM. Default 30 NM.
|
-- @param #number Radius (Optional) Search radius in NM. Default 30 NM.
|
||||||
-- @return Wrapper.Group#GROUP Closest ammo supplying group or `nil` if no group is in the given radius.
|
-- @return Wrapper.Group#GROUP Closest ammo supplying group or `nil` if no group is in the given radius.
|
||||||
-- @return #number Distance to closest group in meters.
|
-- @return #number Distance to closest group in meters.
|
||||||
function ARMYGROUP:FindNearestAmmoSupply(Radius)
|
function ARMYGROUP:FindNearestAmmoSupply(Radius)
|
||||||
|
|||||||
@@ -1008,7 +1008,7 @@ end
|
|||||||
--- **[AIR]** Create an ANTI-SHIP mission.
|
--- **[AIR]** Create an ANTI-SHIP mission.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Wrapper.Positionable#POSITIONABLE Target The target to attack. Can be passed as a @{Wrapper.Group#GROUP} or @{Wrapper.Unit#UNIT} object.
|
-- @param Wrapper.Positionable#POSITIONABLE Target The target to attack. Can be passed as a @{Wrapper.Group#GROUP} or @{Wrapper.Unit#UNIT} object.
|
||||||
-- @param #number Altitude Engage altitude in feet. Default 2000 ft.
|
-- @param #number Altitude (Optional) Engage altitude in feet. Default 2000 ft.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewANTISHIP(Target, Altitude)
|
function AUFTRAG:NewANTISHIP(Target, Altitude)
|
||||||
|
|
||||||
@@ -1038,10 +1038,10 @@ end
|
|||||||
--- **[AIR ROTARY]** Create an HOVER mission.
|
--- **[AIR ROTARY]** Create an HOVER mission.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Point#COORDINATE Coordinate Where to hover.
|
-- @param Core.Point#COORDINATE Coordinate Where to hover.
|
||||||
-- @param #number Altitude Hover altitude in feet AGL. Default is 50 feet above ground.
|
-- @param #number Altitude (Optional) Hover altitude in feet AGL. Default is 50 feet above ground.
|
||||||
-- @param #number Time Time in seconds to hold the hover. Default 300 seconds.
|
-- @param #number Time (Optional) Time in seconds to hold the hover. Default 300 seconds.
|
||||||
-- @param #number Speed Speed in knots to fly to the target coordinate. Default 150kn.
|
-- @param #number Speed (Optional) Speed in knots to fly to the target coordinate. Default 150kn.
|
||||||
-- @param #number MissionAlt Altitude to fly towards the mission in feet AGL. Default 1000ft.
|
-- @param #number MissionAlt (Optional) Altitude to fly towards the mission in feet AGL. Default 1000ft.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewHOVER(Coordinate, Altitude, Time, Speed, MissionAlt)
|
function AUFTRAG:NewHOVER(Coordinate, Altitude, Time, Speed, MissionAlt)
|
||||||
|
|
||||||
@@ -1078,9 +1078,9 @@ end
|
|||||||
-- @param Core.Point#COORDINATE Coordinate Where to land.
|
-- @param Core.Point#COORDINATE Coordinate Where to land.
|
||||||
-- @param #number OuterRadius (Optional) Vary the coordinate by this many feet, e.g. get a new random coordinate between OuterRadius and (optionally) avoiding InnerRadius of the coordinate.
|
-- @param #number OuterRadius (Optional) Vary the coordinate by this many feet, e.g. get a new random coordinate between OuterRadius and (optionally) avoiding InnerRadius of the coordinate.
|
||||||
-- @param #number InnerRadius (Optional) Vary the coordinate by this many feet, e.g. get a new random coordinate between OuterRadius and (optionally) avoiding InnerRadius of the coordinate.
|
-- @param #number InnerRadius (Optional) Vary the coordinate by this many feet, e.g. get a new random coordinate between OuterRadius and (optionally) avoiding InnerRadius of the coordinate.
|
||||||
-- @param #number Time Time in seconds to stay. Default 300 seconds.
|
-- @param #number Time (Optional) Time in seconds to stay. Default 300 seconds.
|
||||||
-- @param #number Speed Speed in knots to fly to the target coordinate. Default 150kn.
|
-- @param #number Speed (Optional) Speed in knots to fly to the target coordinate. Default 150kn.
|
||||||
-- @param #number MissionAlt Altitude to fly towards the mission in feet AGL. Default 1000ft.
|
-- @param #number MissionAlt A(Optional) ltitude to fly towards the mission in feet AGL. Default 1000ft.
|
||||||
-- @param #boolean CombatLanding (Optional) If true, set the Combat Landing option.
|
-- @param #boolean CombatLanding (Optional) If true, set the Combat Landing option.
|
||||||
-- @param #number DirectionAfterLand (Optional) Heading after landing in degrees.
|
-- @param #number DirectionAfterLand (Optional) Heading after landing in degrees.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
@@ -1168,10 +1168,10 @@ end
|
|||||||
--- **[AIR]** Create an ORBIT mission, which can be either a circular orbit or a race-track pattern.
|
--- **[AIR]** Create an ORBIT mission, which can be either a circular orbit or a race-track pattern.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Point#COORDINATE Coordinate Where to orbit.
|
-- @param Core.Point#COORDINATE Coordinate Where to orbit.
|
||||||
-- @param #number Altitude Orbit altitude in feet above sea level. Default is y component of `Coordinate`.
|
-- @param #number Altitude (Optional) Orbit altitude in feet above sea level. Default is y component of `Coordinate`.
|
||||||
-- @param #number Speed Orbit indicated airspeed in knots at the set altitude ASL. Default 350 KIAS.
|
-- @param #number Speed (Optional) Orbit indicated airspeed in knots at the set altitude ASL. Default 350 KIAS.
|
||||||
-- @param #number Heading Heading of race-track pattern in degrees. If not specified, a circular orbit is performed.
|
-- @param #number Heading (Optional) Heading of race-track pattern in degrees. If not specified, a circular orbit is performed.
|
||||||
-- @param #number Leg Length of race-track in NM. If not specified, a circular orbit is performed.
|
-- @param #number Leg (Optional) Length of race-track in NM. If not specified, a circular orbit is performed.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewORBIT(Coordinate, Altitude, Speed, Heading, Leg)
|
function AUFTRAG:NewORBIT(Coordinate, Altitude, Speed, Heading, Leg)
|
||||||
|
|
||||||
@@ -1222,8 +1222,8 @@ end
|
|||||||
--- **[AIR]** Create an ORBIT mission, where the aircraft will go in a circle around the specified coordinate.
|
--- **[AIR]** Create an ORBIT mission, where the aircraft will go in a circle around the specified coordinate.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Point#COORDINATE Coordinate Position where to orbit around.
|
-- @param Core.Point#COORDINATE Coordinate Position where to orbit around.
|
||||||
-- @param #number Altitude Orbit altitude in feet. Default is y component of `Coordinate`.
|
-- @param #number Altitude (Optional) Orbit altitude in feet. Default is y component of `Coordinate`.
|
||||||
-- @param #number Speed Orbit indicated airspeed in knots at the set altitude ASL. Default 350 KIAS.
|
-- @param #number Speed (Optional) Orbit indicated airspeed in knots at the set altitude ASL. Default 350 KIAS.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewORBIT_CIRCLE(Coordinate, Altitude, Speed)
|
function AUFTRAG:NewORBIT_CIRCLE(Coordinate, Altitude, Speed)
|
||||||
|
|
||||||
@@ -1235,10 +1235,10 @@ end
|
|||||||
--- **[AIR]** Create an ORBIT mission, where the aircraft will fly a race-track pattern.
|
--- **[AIR]** Create an ORBIT mission, where the aircraft will fly a race-track pattern.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Point#COORDINATE Coordinate Where to orbit.
|
-- @param Core.Point#COORDINATE Coordinate Where to orbit.
|
||||||
-- @param #number Altitude Orbit altitude in feet. Default is y component of `Coordinate`.
|
-- @param #number Altitude (Optional) Orbit altitude in feet. Default is y component of `Coordinate`.
|
||||||
-- @param #number Speed Orbit indicated airspeed in knots at the set altitude ASL. Default 350 KIAS.
|
-- @param #number Speed (Optional) Orbit indicated airspeed in knots at the set altitude ASL. Default 350 KIAS.
|
||||||
-- @param #number Heading Heading of race-track pattern in degrees. Default random in [0, 360) degrees.
|
-- @param #number Heading (Optional) Heading of race-track pattern in degrees. Default random in [0, 360) degrees.
|
||||||
-- @param #number Leg Length of race-track in NM. Default 10 NM.
|
-- @param #number Leg (Optional) Length of race-track in NM. Default 10 NM.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewORBIT_RACETRACK(Coordinate, Altitude, Speed, Heading, Leg)
|
function AUFTRAG:NewORBIT_RACETRACK(Coordinate, Altitude, Speed, Heading, Leg)
|
||||||
|
|
||||||
@@ -1253,12 +1253,12 @@ end
|
|||||||
--- **[AIR]** Create an ORBIT mission, where the aircraft will fly a circular or race-track pattern over a given group or unit.
|
--- **[AIR]** Create an ORBIT mission, where the aircraft will fly a circular or race-track pattern over a given group or unit.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Wrapper.Group#GROUP Group Group where to orbit around. Can also be a UNIT object.
|
-- @param Wrapper.Group#GROUP Group Group where to orbit around. Can also be a UNIT object.
|
||||||
-- @param #number Altitude Orbit altitude in feet. Default is 6,000 ft.
|
-- @param #number Altitude (Optional) Orbit altitude in feet. Default is 6,000 ft.
|
||||||
-- @param #number Speed Orbit indicated airspeed in knots at the set altitude ASL. Default 350 KIAS.
|
-- @param #number Speed (Optional) Orbit indicated airspeed in knots at the set altitude ASL. Default 350 KIAS.
|
||||||
-- @param #number Leg Length of race-track in NM. Default nil.
|
-- @param #number Leg (Optional) Length of race-track in NM. Default nil.
|
||||||
-- @param #number Heading Heading of race-track pattern in degrees. Default is heading of the group.
|
-- @param #number Heading (Optional) Heading of race-track pattern in degrees. Default is heading of the group.
|
||||||
-- @param DCS#Vec2 OffsetVec2 Offset 2D-vector {x=0, y=0} in NM with respect to the group. Default directly overhead. Can also be given in polar coordinates `{r=5, phi=45}`.
|
-- @param DCS#Vec2 OffsetVec2 (Optional) Offset 2D-vector {x=0, y=0} in NM with respect to the group. Default directly overhead. Can also be given in polar coordinates `{r=5, phi=45}`.
|
||||||
-- @param #number Distance Threshold distance in NM before orbit pattern is updated. Default 5 NM.
|
-- @param #number Distance (Optional) Threshold distance in NM before orbit pattern is updated. Default 5 NM.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewORBIT_GROUP(Group, Altitude, Speed, Leg, Heading, OffsetVec2, Distance)
|
function AUFTRAG:NewORBIT_GROUP(Group, Altitude, Speed, Leg, Heading, OffsetVec2, Distance)
|
||||||
|
|
||||||
@@ -1301,10 +1301,10 @@ end
|
|||||||
-- themselfs. They wait for the CHIEF to tell them whom to engage.
|
-- themselfs. They wait for the CHIEF to tell them whom to engage.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Point#COORDINATE Coordinate Where to orbit.
|
-- @param Core.Point#COORDINATE Coordinate Where to orbit.
|
||||||
-- @param #number Altitude Orbit altitude in feet. Default is y component of `Coordinate`.
|
-- @param #number Altitude (Optional) Orbit altitude in feet. Default is y component of `Coordinate`.
|
||||||
-- @param #number Speed Orbit indicated airspeed in knots at the set altitude ASL. Default 350 KIAS.
|
-- @param #number Speed (Optional) Orbit indicated airspeed in knots at the set altitude ASL. Default 350 KIAS.
|
||||||
-- @param #number Heading Heading of race-track pattern in degrees. Default random in [0, 360) degrees.
|
-- @param #number Heading (Optional) Heading of race-track pattern in degrees. Default random in [0, 360) degrees.
|
||||||
-- @param #number Leg Length of race-track in NM. Default 10 NM.
|
-- @param #number Leg (Optional) Length of race-track in NM. Default 10 NM.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewGCICAP(Coordinate, Altitude, Speed, Heading, Leg)
|
function AUFTRAG:NewGCICAP(Coordinate, Altitude, Speed, Heading, Leg)
|
||||||
|
|
||||||
@@ -1328,10 +1328,10 @@ end
|
|||||||
--- **[AIR]** Create a TANKER mission.
|
--- **[AIR]** Create a TANKER mission.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Point#COORDINATE Coordinate Where to orbit.
|
-- @param Core.Point#COORDINATE Coordinate Where to orbit.
|
||||||
-- @param #number Altitude Orbit altitude in feet. Default is y component of `Coordinate`.
|
-- @param #number Altitude (Optional) Orbit altitude in feet. Default is y component of `Coordinate`.
|
||||||
-- @param #number Speed Orbit indicated airspeed in knots at the set altitude ASL. Default 350 KIAS.
|
-- @param #number Speed (Optional) Orbit indicated airspeed in knots at the set altitude ASL. Default 350 KIAS.
|
||||||
-- @param #number Heading Heading of race-track pattern in degrees. Default 270 (East to West).
|
-- @param #number Heading (Optional) Heading of race-track pattern in degrees. Default 270 (East to West).
|
||||||
-- @param #number Leg Length of race-track in NM. Default 10 NM. Set to 0 for a simple circular orbit.
|
-- @param #number Leg (Optional) Length of race-track in NM. Default 10 NM. Set to 0 for a simple circular orbit.
|
||||||
-- @param #number RefuelSystem Refueling system (0=boom, 1=probe). This info is *only* for AIRWINGs so they launch the right tanker type.
|
-- @param #number RefuelSystem Refueling system (0=boom, 1=probe). This info is *only* for AIRWINGs so they launch the right tanker type.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewTANKER(Coordinate, Altitude, Speed, Heading, Leg, RefuelSystem)
|
function AUFTRAG:NewTANKER(Coordinate, Altitude, Speed, Heading, Leg, RefuelSystem)
|
||||||
@@ -1367,10 +1367,10 @@ end
|
|||||||
--- **[AIR]** Create a AWACS mission.
|
--- **[AIR]** Create a AWACS mission.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Point#COORDINATE Coordinate Where to orbit. Altitude is also taken from the coordinate.
|
-- @param Core.Point#COORDINATE Coordinate Where to orbit. Altitude is also taken from the coordinate.
|
||||||
-- @param #number Altitude Orbit altitude in feet. Default is y component of `Coordinate`.
|
-- @param #number Altitude (Optional) Orbit altitude in feet. Default is y component of `Coordinate`.
|
||||||
-- @param #number Speed Orbit speed in knots. Default 350 kts.
|
-- @param #number Speed (Optional) Orbit speed in knots. Default 350 kts.
|
||||||
-- @param #number Heading Heading of race-track pattern in degrees. Default 270 (East to West).
|
-- @param #number Heading (Optional) Heading of race-track pattern in degrees. Default 270 (East to West).
|
||||||
-- @param #number Leg Length of race-track in NM. Default 10 NM.
|
-- @param #number Leg (Optional) Length of race-track in NM. Default 10 NM.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewAWACS(Coordinate, Altitude, Speed, Heading, Leg)
|
function AUFTRAG:NewAWACS(Coordinate, Altitude, Speed, Heading, Leg)
|
||||||
|
|
||||||
@@ -1422,12 +1422,12 @@ end
|
|||||||
--- **[AIR]** Create a CAP mission.
|
--- **[AIR]** Create a CAP mission.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Zone#ZONE_RADIUS ZoneCAP Circular CAP zone. Detected targets in this zone will be engaged.
|
-- @param Core.Zone#ZONE_RADIUS ZoneCAP Circular CAP zone. Detected targets in this zone will be engaged.
|
||||||
-- @param #number Altitude Altitude at which to orbit in feet. Default is 10,000 ft.
|
-- @param #number Altitude (Optional) Altitude at which to orbit in feet. Default is 10,000 ft.
|
||||||
-- @param #number Speed Orbit speed in knots. Default 350 kts.
|
-- @param #number Speed (Optional) Orbit speed in knots. Default 350 kts.
|
||||||
-- @param Core.Point#COORDINATE Coordinate Where to orbit. Default is the center of the CAP zone.
|
-- @param Core.Point#COORDINATE Coordinate (Optional) Where to orbit. Default is the center of the CAP zone.
|
||||||
-- @param #number Heading Heading of race-track pattern in degrees. If not specified, a simple circular orbit is performed.
|
-- @param #number Heading (Optional) Heading of race-track pattern in degrees. If not specified, a simple circular orbit is performed.
|
||||||
-- @param #number Leg Length of race-track in NM. If not specified, a simple circular orbit is performed.
|
-- @param #number Leg (Optional) Length of race-track in NM. If not specified, a simple circular orbit is performed.
|
||||||
-- @param #table TargetTypes Table of target types. Default {"Air"}.
|
-- @param #table TargetTypes (Optional) Table of target types. Default {"Air"}.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewCAP(ZoneCAP, Altitude, Speed, Coordinate, Heading, Leg, TargetTypes)
|
function AUFTRAG:NewCAP(ZoneCAP, Altitude, Speed, Coordinate, Heading, Leg, TargetTypes)
|
||||||
|
|
||||||
@@ -1464,15 +1464,15 @@ end
|
|||||||
--- **[AIR]** Create a CAP mission over a (moving) group.
|
--- **[AIR]** Create a CAP mission over a (moving) group.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Wrapper.Group#GROUP Grp The grp to perform the CAP over.
|
-- @param Wrapper.Group#GROUP Grp The grp to perform the CAP over.
|
||||||
-- @param #number Altitude Orbit altitude in feet. Default is 6,000 ft.
|
-- @param #number Altitude (Optional) Orbit altitude in feet. Default is 6,000 ft.
|
||||||
-- @param #number Speed Orbit speed in knots. Default 250 KIAS.
|
-- @param #number Speed (Optional) Orbit speed in knots. Default 250 KIAS.
|
||||||
-- @param #number RelHeading Relative heading [0, 360) of race-track pattern in degrees wrt heading of the carrier. Default is heading of the carrier.
|
-- @param #number RelHeading (Optional) Relative heading [0, 360) of race-track pattern in degrees wrt heading of the carrier. Default is heading of the carrier.
|
||||||
-- @param #number Leg Length of race-track in NM. Default 14 NM.
|
-- @param #number Leg (Optional) Length of race-track in NM. Default 14 NM.
|
||||||
-- @param #number OffsetDist Relative distance of the first race-track point wrt to the carrier. Default 6 NM.
|
-- @param #number OffsetDist (Optional) Relative distance of the first race-track point wrt to the carrier. Default 6 NM.
|
||||||
-- @param #number OffsetAngle Relative angle of the first race-track point wrt. to the carrier. Default 180 (behind the boat).
|
-- @param #number OffsetAngle (Optional) Relative angle of the first race-track point wrt. to the carrier. Default 180 (behind the boat).
|
||||||
-- @param #number UpdateDistance Threshold distance in NM before orbit pattern is updated. Default 5 NM.
|
-- @param #number UpdateDistance (Optional) Threshold distance in NM before orbit pattern is updated. Default 5 NM.
|
||||||
-- @param #table TargetTypes (Optional) Table of target types. Default `{"Air"}`.
|
-- @param #table TargetTypes (Optional) Table of target types. Default `{"Air"}`.
|
||||||
-- @param #number EngageRange Max range in nautical miles that the escort group(s) will engage enemies. Default 32 NM (60 km).
|
-- @param #number EngageRange (Optional) Max range in nautical miles that the escort group(s) will engage enemies. Default 32 NM (60 km).
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewCAPGROUP(Grp, Altitude, Speed, RelHeading, Leg, OffsetDist, OffsetAngle, UpdateDistance, TargetTypes, EngageRange)
|
function AUFTRAG:NewCAPGROUP(Grp, Altitude, Speed, RelHeading, Leg, OffsetDist, OffsetAngle, UpdateDistance, TargetTypes, EngageRange)
|
||||||
|
|
||||||
@@ -1517,11 +1517,11 @@ end
|
|||||||
--- **[AIR]** Create a CAS mission.
|
--- **[AIR]** Create a CAS mission.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Zone#ZONE_RADIUS ZoneCAS Circular CAS zone. Detected targets in this zone will be engaged.
|
-- @param Core.Zone#ZONE_RADIUS ZoneCAS Circular CAS zone. Detected targets in this zone will be engaged.
|
||||||
-- @param #number Altitude Altitude at which to orbit. Default is 10,000 ft.
|
-- @param #number Altitude (Optional) Altitude at which to orbit. Default is 10,000 ft.
|
||||||
-- @param #number Speed Orbit speed in knots. Default 350 KIAS.
|
-- @param #number Speed (Optional) Orbit speed in knots. Default 350 KIAS.
|
||||||
-- @param Core.Point#COORDINATE Coordinate Where to orbit. Default is the center of the CAS zone.
|
-- @param Core.Point#COORDINATE Coordinate (Optional) Where to orbit. Default is the center of the CAS zone.
|
||||||
-- @param #number Heading Heading of race-track pattern in degrees. If not specified, a simple circular orbit is performed.
|
-- @param #number Heading (Optional) Heading of race-track pattern in degrees. If not specified, a simple circular orbit is performed.
|
||||||
-- @param #number Leg Length of race-track in NM. If not specified, a simple circular orbit is performed.
|
-- @param #number Leg (Optional) Length of race-track in NM. If not specified, a simple circular orbit is performed.
|
||||||
-- @param #table TargetTypes (Optional) Table of target types. Default `{"Helicopters", "Ground Units", "Light armed ships"}`.
|
-- @param #table TargetTypes (Optional) Table of target types. Default `{"Helicopters", "Ground Units", "Light armed ships"}`.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewCAS(ZoneCAS, Altitude, Speed, Coordinate, Heading, Leg, TargetTypes)
|
function AUFTRAG:NewCAS(ZoneCAS, Altitude, Speed, Coordinate, Heading, Leg, TargetTypes)
|
||||||
@@ -1555,11 +1555,11 @@ end
|
|||||||
--- **[AIR]** Create a CASENHANCED mission. Group(s) will go to the zone and patrol it randomly.
|
--- **[AIR]** Create a CASENHANCED mission. Group(s) will go to the zone and patrol it randomly.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Zone#ZONE CasZone The CAS zone.
|
-- @param Core.Zone#ZONE CasZone The CAS zone.
|
||||||
-- @param #number Altitude Altitude in feet. Only for airborne units. Default 2000 feet ASL.
|
-- @param #number Altitude (Optional) Altitude in feet. Only for airborne units. Default 2000 feet ASL.
|
||||||
-- @param #number Speed Speed in knots.
|
-- @param #number Speed (Optional) Speed in knots.
|
||||||
-- @param #number RangeMax Max range in NM. Only detected targets within this radius from the group will be engaged. Default is 25 NM.
|
-- @param #number RangeMax (Optional) Max range in NM. Only detected targets within this radius from the group will be engaged. Default is 25 NM.
|
||||||
-- @param Core.Set#SET_ZONE NoEngageZoneSet Set of zones in which targets are *not* engaged. Default is nowhere.
|
-- @param Core.Set#SET_ZONE NoEngageZoneSet (Optional) Set of zones in which targets are *not* engaged. Default is nowhere.
|
||||||
-- @param #table TargetTypes Types of target attributes that will be engaged. See [DCS enum attributes](https://wiki.hoggitworld.com/view/DCS_enum_attributes). Default `{"Helicopters", "Ground Units", "Light armed ships"}`.
|
-- @param #table TargetTypes (Optional) Types of target attributes that will be engaged. See [DCS enum attributes](https://wiki.hoggitworld.com/view/DCS_enum_attributes). Default `{"Helicopters", "Ground Units", "Light armed ships"}`.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewCASENHANCED(CasZone, Altitude, Speed, RangeMax, NoEngageZoneSet, TargetTypes)
|
function AUFTRAG:NewCASENHANCED(CasZone, Altitude, Speed, RangeMax, NoEngageZoneSet, TargetTypes)
|
||||||
|
|
||||||
@@ -1597,11 +1597,10 @@ end
|
|||||||
--- **[AIR, GROUND]** Create a FAC mission. Group(s) will go to the zone and patrol it randomly and act as FAC for detected units.
|
--- **[AIR, GROUND]** Create a FAC mission. Group(s) will go to the zone and patrol it randomly and act as FAC for detected units.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Zone#ZONE FacZone The FAC zone (or name of zone) where to patrol.
|
-- @param Core.Zone#ZONE FacZone The FAC zone (or name of zone) where to patrol.
|
||||||
-- @param #number Speed Speed in knots.
|
-- @param #number Speed (Optional) Speed in knots.
|
||||||
-- @param #number Altitude Altitude in feet. Only for airborne units. Default 2000 feet ASL.
|
-- @param #number Altitude (Optional) Altitude in feet. Only for airborne units. Default 2000 feet ASL.
|
||||||
-- @param #number Frequency Frequency in MHz.
|
-- @param #number Frequency (Optional) Frequency in MHz. Defaults to 133Mhz.
|
||||||
-- @param #number Modulation Modulation.
|
-- @param #number Modulation (Optional) Modulation. Defaults to radio.modulation.AM
|
||||||
-- @return #AUFTRAG self
|
|
||||||
function AUFTRAG:NewFAC(FacZone, Speed, Altitude, Frequency, Modulation)
|
function AUFTRAG:NewFAC(FacZone, Speed, Altitude, Frequency, Modulation)
|
||||||
|
|
||||||
local mission=AUFTRAG:New(AUFTRAG.Type.FAC)
|
local mission=AUFTRAG:New(AUFTRAG.Type.FAC)
|
||||||
@@ -1638,10 +1637,10 @@ end
|
|||||||
--- **[AIR]** Create a FACA mission.
|
--- **[AIR]** Create a FACA mission.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Wrapper.Group#GROUP Target Target group. Must be a GROUP object.
|
-- @param Wrapper.Group#GROUP Target Target group. Must be a GROUP object.
|
||||||
-- @param #string Designation Designation of target. See `AI.Task.Designation`. Default `AI.Task.Designation.AUTO`.
|
-- @param #string Designation (Optional) Designation of target. See `AI.Task.Designation`. Default `AI.Task.Designation.AUTO`.
|
||||||
-- @param #boolean DataLink Enable data link. Default `true`.
|
-- @param #boolean DataLink (Optional) Enable data link. Default `true`.
|
||||||
-- @param #number Frequency Radio frequency in MHz the FAC uses for communication. Default is 133 MHz.
|
-- @param #number Frequency (Optional) Radio frequency in MHz the FAC uses for communication. Default is 133 MHz.
|
||||||
-- @param #number Modulation Radio modulation band. Default 0=AM. Use 1 for FM. See radio.modulation.AM or radio.modulaton.FM.
|
-- @param #number Modulation (Optional) Radio modulation band. Default 0=AM. Use 1 for FM. See radio.modulation.AM or radio.modulaton.FM.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewFACA(Target, Designation, DataLink, Frequency, Modulation)
|
function AUFTRAG:NewFACA(Target, Designation, DataLink, Frequency, Modulation)
|
||||||
|
|
||||||
@@ -1675,7 +1674,7 @@ end
|
|||||||
--- **[AIR]** Create a BAI mission.
|
--- **[AIR]** Create a BAI mission.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Wrapper.Positionable#POSITIONABLE Target The target to attack. Can be a GROUP, UNIT or STATIC object.
|
-- @param Wrapper.Positionable#POSITIONABLE Target The target to attack. Can be a GROUP, UNIT or STATIC object.
|
||||||
-- @param #number Altitude Engage altitude in feet. Default 5000 ft.
|
-- @param #number Altitude (Optional) Engage altitude in feet. Default 5000 ft.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewBAI(Target, Altitude)
|
function AUFTRAG:NewBAI(Target, Altitude)
|
||||||
|
|
||||||
@@ -1705,7 +1704,7 @@ end
|
|||||||
--- **[AIR]** Create a SEAD mission.
|
--- **[AIR]** Create a SEAD mission.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Wrapper.Positionable#POSITIONABLE Target The target to attack. Can be a GROUP or UNIT object.
|
-- @param Wrapper.Positionable#POSITIONABLE Target The target to attack. Can be a GROUP or UNIT object.
|
||||||
-- @param #number Altitude Engage altitude in feet. Default 25000 ft.
|
-- @param #number Altitude (Optional) Engage altitude in feet. Default 25000 ft.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewSEAD(Target, Altitude)
|
function AUFTRAG:NewSEAD(Target, Altitude)
|
||||||
|
|
||||||
@@ -1735,9 +1734,9 @@ end
|
|||||||
--- **[AIR]** Create a SEAD in Zone mission.
|
--- **[AIR]** Create a SEAD in Zone mission.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Zone#ZONE TargetZone The target zone to attack.
|
-- @param Core.Zone#ZONE TargetZone The target zone to attack.
|
||||||
-- @param #number Altitude Engage altitude in feet. Default 25000 ft.
|
-- @param #number Altitude (Optional) Engage altitude in feet. Default 25000 ft.
|
||||||
-- @param #table TargetTypes Table of string of DCS known target types, defaults to {"Air Defence"}. See [DCS Target Attributes](https://wiki.hoggitworld.com/view/DCS_enum_attributes)
|
-- @param #table TargetTypes (Optional) Table of string of DCS known target types, defaults to {"Air Defence"}. See [DCS Target Attributes](https://wiki.hoggitworld.com/view/DCS_enum_attributes)
|
||||||
-- @param #number Duration Engage this much time when the AUFTRAG starts executing.
|
-- @param #number Duration (Optional) Engage this much time when the AUFTRAG starts executing. Default is 1800.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewSEADInZone(TargetZone, Altitude, TargetTypes, Duration)
|
function AUFTRAG:NewSEADInZone(TargetZone, Altitude, TargetTypes, Duration)
|
||||||
|
|
||||||
@@ -1771,8 +1770,8 @@ end
|
|||||||
--- **[AIR]** Create a STRIKE mission. Flight will attack the closest map object to the specified coordinate.
|
--- **[AIR]** Create a STRIKE mission. Flight will attack the closest map object to the specified coordinate.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Point#COORDINATE Target The target coordinate. Can also be given as a GROUP, UNIT, STATIC, SET_GROUP, SET_UNIT, SET_STATIC or TARGET object.
|
-- @param Core.Point#COORDINATE Target The target coordinate. Can also be given as a GROUP, UNIT, STATIC, SET_GROUP, SET_UNIT, SET_STATIC or TARGET object.
|
||||||
-- @param #number Altitude Engage altitude in feet. Default 2000 ft.
|
-- @param #number Altitude (Optional) Engage altitude in feet. Default 2000 ft.
|
||||||
-- @param #number EngageWeaponType Which weapon to use. Defaults to auto, ie ENUMS.WeaponFlag.Auto. See ENUMS.WeaponFlag for options.
|
-- @param #number EngageWeaponType (Optional) Which weapon to use. Defaults to auto, ie ENUMS.WeaponFlag.Auto. See ENUMS.WeaponFlag for options.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewSTRIKE(Target, Altitude, EngageWeaponType)
|
function AUFTRAG:NewSTRIKE(Target, Altitude, EngageWeaponType)
|
||||||
|
|
||||||
@@ -1803,9 +1802,9 @@ end
|
|||||||
-- See [DCS task bombing](https://wiki.hoggitworld.com/view/DCS_task_bombing).
|
-- See [DCS task bombing](https://wiki.hoggitworld.com/view/DCS_task_bombing).
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Point#COORDINATE Target Target coordinate. Can also be specified as a GROUP, UNIT, STATIC, SET_GROUP, SET_UNIT, SET_STATIC or TARGET object.
|
-- @param Core.Point#COORDINATE Target Target coordinate. Can also be specified as a GROUP, UNIT, STATIC, SET_GROUP, SET_UNIT, SET_STATIC or TARGET object.
|
||||||
-- @param #number Altitude Engage altitude in feet. Default 25000 ft.
|
-- @param #number Altitude Engage (Optional) altitude in feet. Default 25000 ft.
|
||||||
-- @param #number EngageWeaponType Which weapon to use. Defaults to auto, ie ENUMS.WeaponFlag.Auto. See ENUMS.WeaponFlag for options.
|
-- @param #number EngageWeaponType (Optional) Which weapon to use. Defaults to auto, ie ENUMS.WeaponFlag.Auto. See ENUMS.WeaponFlag for options.
|
||||||
-- @param #boolean Divebomb If true, use a dive bombing attack approach.
|
-- @param #boolean Divebomb (Optional) If true, use a dive bombing attack approach.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewBOMBING(Target, Altitude, EngageWeaponType, Divebomb)
|
function AUFTRAG:NewBOMBING(Target, Altitude, EngageWeaponType, Divebomb)
|
||||||
|
|
||||||
@@ -1841,8 +1840,8 @@ end
|
|||||||
-- See [DCS task strafing](https://wiki.hoggitworld.com/view/DCS_task_strafing).
|
-- See [DCS task strafing](https://wiki.hoggitworld.com/view/DCS_task_strafing).
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Point#COORDINATE Target Target coordinate. Can also be specified as a GROUP, UNIT, STATIC or TARGET object.
|
-- @param Core.Point#COORDINATE Target Target coordinate. Can also be specified as a GROUP, UNIT, STATIC or TARGET object.
|
||||||
-- @param #number Altitude Engage altitude in feet. Default 1000 ft.
|
-- @param #number Altitude (Optional) Engage altitude in feet. Default 1000 ft.
|
||||||
-- @param #number Length The total length of the strafing target in meters. Default `nil`.
|
-- @param #number Length (Optional) The total length of the strafing target in meters. Default `nil`.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewSTRAFING(Target, Altitude, Length)
|
function AUFTRAG:NewSTRAFING(Target, Altitude, Length)
|
||||||
|
|
||||||
@@ -1878,7 +1877,7 @@ end
|
|||||||
--- **[AIR]** Create a BOMBRUNWAY mission.
|
--- **[AIR]** Create a BOMBRUNWAY mission.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Wrapper.Airbase#AIRBASE Airdrome The airbase to bomb. This must be an airdrome (not a FARP or ship) as these do not have a runway.
|
-- @param Wrapper.Airbase#AIRBASE Airdrome The airbase to bomb. This must be an airdrome (not a FARP or ship) as these do not have a runway.
|
||||||
-- @param #number Altitude Engage altitude in feet. Default 25000 ft.
|
-- @param #number Altitude (Optional) Engage altitude in feet. Default 25000 ft.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewBOMBRUNWAY(Airdrome, Altitude)
|
function AUFTRAG:NewBOMBRUNWAY(Airdrome, Altitude)
|
||||||
|
|
||||||
@@ -1916,8 +1915,8 @@ end
|
|||||||
--- **[AIR]** Create a CARPET BOMBING mission.
|
--- **[AIR]** Create a CARPET BOMBING mission.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Point#COORDINATE Target Target coordinate. Can also be specified as a GROUP, UNIT or STATIC object.
|
-- @param Core.Point#COORDINATE Target Target coordinate. Can also be specified as a GROUP, UNIT or STATIC object.
|
||||||
-- @param #number Altitude Engage altitude in feet. Default 25000 ft.
|
-- @param #number Altitude (Optional) Engage altitude in feet. Default 25000 ft.
|
||||||
-- @param #number CarpetLength Length of bombing carpet in meters. Default 500 m.
|
-- @param #number CarpetLength (Optional) Length of bombing carpet in meters. Default 500 m.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewBOMBCARPET(Target, Altitude, CarpetLength)
|
function AUFTRAG:NewBOMBCARPET(Target, Altitude, CarpetLength)
|
||||||
|
|
||||||
@@ -1954,8 +1953,8 @@ end
|
|||||||
--- **[AIR/HELO]** Create a GROUNDESCORT (or FOLLOW) mission. Helo will escort a **ground** group and automatically engage certain target types.
|
--- **[AIR/HELO]** Create a GROUNDESCORT (or FOLLOW) mission. Helo will escort a **ground** group and automatically engage certain target types.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Wrapper.Group#GROUP EscortGroup The ground group to escort.
|
-- @param Wrapper.Group#GROUP EscortGroup The ground group to escort.
|
||||||
-- @param #number OrbitDistance Orbit to/from the lead unit this many NM. Defaults to 1.5 NM.
|
-- @param #number OrbitDistance(Optional) Orbit to/from the lead unit this many NM. Defaults to 1.5 NM.
|
||||||
-- @param #table TargetTypes Types of targets to engage automatically. Default is {"Ground vehicles"}, i.e. all enemy ground units. Use an empty set {} for a simple "FOLLOW" mission.
|
-- @param #table TargetTypes (Optional) Types of targets to engage automatically. Default is {"Ground vehicles"}, i.e. all enemy ground units. Use an empty set {} for a simple "FOLLOW" mission.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewGROUNDESCORT(EscortGroup, OrbitDistance, TargetTypes)
|
function AUFTRAG:NewGROUNDESCORT(EscortGroup, OrbitDistance, TargetTypes)
|
||||||
|
|
||||||
@@ -1992,9 +1991,9 @@ end
|
|||||||
--- **[AIR]** Create an ESCORT (or FOLLOW) mission. Flight will escort another group and automatically engage certain target types.
|
--- **[AIR]** Create an ESCORT (or FOLLOW) mission. Flight will escort another group and automatically engage certain target types.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Wrapper.Group#GROUP EscortGroup The group to escort.
|
-- @param Wrapper.Group#GROUP EscortGroup The group to escort.
|
||||||
-- @param DCS#Vec3 OffsetVector A table with x, y and z components specifying the offset of the flight to the escorted group. Default {x=-100, y=0, z=200} for z=200 meters to the right, same alitude (y=0), x=-100 meters behind.
|
-- @param DCS#Vec3 OffsetVector (Optional) A table with x, y and z components specifying the offset of the flight to the escorted group. Default {x=-100, y=0, z=200} for z=200 meters to the right, same alitude (y=0), x=-100 meters behind.
|
||||||
-- @param #number EngageMaxDistance Max engage distance of targets in nautical miles. Default auto 32 NM.
|
-- @param #number EngageMaxDistance (Optional) Max engage distance of targets in nautical miles. Default auto 32 NM.
|
||||||
-- @param #table TargetTypes Types of targets to engage automatically. Default is {"Air"}, i.e. all enemy airborne units. Use an empty set {} for a simple "FOLLOW" mission.
|
-- @param #table TargetTypes (Optional) Types of targets to engage automatically. Default is {"Air"}, i.e. all enemy airborne units. Use an empty set {} for a simple "FOLLOW" mission.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewESCORT(EscortGroup, OffsetVector, EngageMaxDistance, TargetTypes)
|
function AUFTRAG:NewESCORT(EscortGroup, OffsetVector, EngageMaxDistance, TargetTypes)
|
||||||
|
|
||||||
@@ -2053,13 +2052,13 @@ end
|
|||||||
--- **[AIRPANE]** Create a RECOVERY TANKER mission.
|
--- **[AIRPANE]** Create a RECOVERY TANKER mission.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Wrapper.Unit#UNIT Carrier The carrier unit.
|
-- @param Wrapper.Unit#UNIT Carrier The carrier unit.
|
||||||
-- @param #number Altitude Orbit altitude in feet. Default is 6,000 ft.
|
-- @param #number Altitude (Optional) Orbit altitude in feet. Default is 6,000 ft.
|
||||||
-- @param #number Speed Orbit speed in knots. Default 250 KIAS.
|
-- @param #number Speed (Optional) Orbit speed in knots. Default 250 KIAS.
|
||||||
-- @param #number Leg Length of race-track in NM. Default 14 NM.
|
-- @param #number Leg (Optional) Length of race-track in NM. Default 14 NM.
|
||||||
-- @param #number RelHeading Relative heading [0, 360) of race-track pattern in degrees wrt heading of the carrier. Default is heading of the carrier.
|
-- @param #number RelHeading (Optional) Relative heading [0, 360) of race-track pattern in degrees wrt heading of the carrier. Default is heading of the carrier.
|
||||||
-- @param #number OffsetDist Relative distance of the first race-track point wrt to the carrier. Default 6 NM.
|
-- @param #number OffsetDist (Optional) Relative distance of the first race-track point wrt to the carrier. Default 6 NM.
|
||||||
-- @param #number OffsetAngle Relative angle of the first race-track point wrt. to the carrier. Default 180 (behind the boat).
|
-- @param #number OffsetAngle (Optional) Relative angle of the first race-track point wrt. to the carrier. Default 180 (behind the boat).
|
||||||
-- @param #number UpdateDistance Threshold distance in NM before orbit pattern is updated. Default 5 NM.
|
-- @param #number UpdateDistance (Optional) Threshold distance in NM before orbit pattern is updated. Default 5 NM.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewRECOVERYTANKER(Carrier, Altitude, Speed, Leg, RelHeading, OffsetDist, OffsetAngle, UpdateDistance)
|
function AUFTRAG:NewRECOVERYTANKER(Carrier, Altitude, Speed, Leg, RelHeading, OffsetDist, OffsetAngle, UpdateDistance)
|
||||||
|
|
||||||
@@ -2101,8 +2100,8 @@ end
|
|||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Set#SET_GROUP TransportGroupSet The set group(s) to be transported.
|
-- @param Core.Set#SET_GROUP TransportGroupSet The set group(s) to be transported.
|
||||||
-- @param Core.Point#COORDINATE DropoffCoordinate Coordinate where the helo will land drop off the the troops.
|
-- @param Core.Point#COORDINATE DropoffCoordinate Coordinate where the helo will land drop off the the troops.
|
||||||
-- @param Core.Point#COORDINATE PickupCoordinate Coordinate where the helo will land to pick up the the cargo. Default is the first transport group.
|
-- @param Core.Point#COORDINATE PickupCoordinate(Optional) Coordinate where the helo will land to pick up the the cargo. Default is the first transport group.
|
||||||
-- @param #number PickupRadius Radius around the pickup coordinate in meters. Default 100 m.
|
-- @param #number PickupRadius (Optional) Radius around the pickup coordinate in meters. Default 100 m.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewTROOPTRANSPORT(TransportGroupSet, DropoffCoordinate, PickupCoordinate, PickupRadius)
|
function AUFTRAG:NewTROOPTRANSPORT(TransportGroupSet, DropoffCoordinate, PickupCoordinate, PickupRadius)
|
||||||
|
|
||||||
@@ -2287,9 +2286,9 @@ end
|
|||||||
-- **Note** that it is recommended to set the weapon range via the `OPSGROUP:AddWeaponRange()` function as this cannot be retrieved from the DCS API.
|
-- **Note** that it is recommended to set the weapon range via the `OPSGROUP:AddWeaponRange()` function as this cannot be retrieved from the DCS API.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Point#COORDINATE Target Center of the firing solution.
|
-- @param Core.Point#COORDINATE Target Center of the firing solution.
|
||||||
-- @param #number Nshots Number of shots to be fired. Default `#nil`. If value is in (0,1), it is interpreted as per cent of available ammo.
|
-- @param #number Nshots (Optional) Number of shots to be fired. Default `#nil`. If value is in (0,1), it is interpreted as per cent of available ammo.
|
||||||
-- @param #number Radius Radius of the shells in meters. Default 100 meters.
|
-- @param #number Radius (Optional) Radius of the shells in meters. Default 100 meters.
|
||||||
-- @param #number Altitude Altitude in meters. Can be used to setup a Barrage. Default `#nil`.
|
-- @param #number Altitude (Optional) Altitude in meters. Can be used to setup a Barrage. Default `#nil`.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewARTY(Target, Nshots, Radius, Altitude)
|
function AUFTRAG:NewARTY(Target, Nshots, Radius, Altitude)
|
||||||
|
|
||||||
@@ -2322,11 +2321,11 @@ end
|
|||||||
--- **[GROUND, NAVAL]** Create an BARRAGE mission. Assigned groups will move to a random coordinate within a given zone and start firing into the air.
|
--- **[GROUND, NAVAL]** Create an BARRAGE mission. Assigned groups will move to a random coordinate within a given zone and start firing into the air.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Zone#ZONE Zone The zone where the unit will go.
|
-- @param Core.Zone#ZONE Zone The zone where the unit will go.
|
||||||
-- @param #number Heading Heading in degrees. Default random heading [0, 360).
|
-- @param #number Heading (Optional) Heading in degrees. Default random heading [0, 360).
|
||||||
-- @param #number Angle Shooting angle in degrees. Default random [45, 85].
|
-- @param #number Angle (Optional) Shooting angle in degrees. Default random [45, 85].
|
||||||
-- @param #number Radius Radius of the shells in meters. Default 100 meters.
|
-- @param #number Radius (Optional) Radius of the shells in meters. Default 100 meters.
|
||||||
-- @param #number Altitude Altitude in meters. Default 500 m.
|
-- @param #number Altitude (Optional) Altitude in meters. Default 500 m.
|
||||||
-- @param #number Nshots Number of shots to be fired. Default is until ammo is empty (`#nil`).
|
-- @param #number Nshots (Optional) Number of shots to be fired. Default is until ammo is empty (`#nil`).
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewBARRAGE(Zone, Heading, Angle, Radius, Altitude, Nshots)
|
function AUFTRAG:NewBARRAGE(Zone, Heading, Angle, Radius, Altitude, Nshots)
|
||||||
|
|
||||||
@@ -2361,8 +2360,8 @@ end
|
|||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Zone#ZONE Zone The patrol zone.
|
-- @param Core.Zone#ZONE Zone The patrol zone.
|
||||||
-- @param #number Speed Speed in knots.
|
-- @param #number Speed Speed in knots.
|
||||||
-- @param #number Altitude Altitude in feet. Only for airborne units. Default 2000 feet ASL.
|
-- @param #number Altitude (Optional) Altitude in feet. Only for airborne units. Default 2000 feet ASL.
|
||||||
-- @param #string Formation Formation used by ground units during patrol. Default "Off Road".
|
-- @param #string Formation (Optional) Formation used by ground units during patrol. Default "Off Road".
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewPATROLZONE(Zone, Speed, Altitude, Formation)
|
function AUFTRAG:NewPATROLZONE(Zone, Speed, Altitude, Formation)
|
||||||
|
|
||||||
@@ -2399,8 +2398,8 @@ end
|
|||||||
-- @param Ops.OpsZone#OPSZONE OpsZone The OPS zone to capture.
|
-- @param Ops.OpsZone#OPSZONE OpsZone The OPS zone to capture.
|
||||||
-- @param #number Coalition The coalition which should capture the zone for the mission to be successful.
|
-- @param #number Coalition The coalition which should capture the zone for the mission to be successful.
|
||||||
-- @param #number Speed Speed in knots.
|
-- @param #number Speed Speed in knots.
|
||||||
-- @param #number Altitude Altitude in feet. Only for airborne units. Default 2000 feet ASL.
|
-- @param #number Altitude (Optional) Altitude in feet. Only for airborne units. Default 2000 feet ASL.
|
||||||
-- @param #string Formation Formation used by ground units during patrol. Default "Off Road".
|
-- @param #string Formation (Optional) Formation used by ground units during patrol. Default "Off Road".
|
||||||
-- @param #number StayInZoneTime Stay this many seconds in the zone when done, only then drive back.
|
-- @param #number StayInZoneTime Stay this many seconds in the zone when done, only then drive back.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewCAPTUREZONE(OpsZone, Coalition, Speed, Altitude, Formation, StayInZoneTime)
|
function AUFTRAG:NewCAPTUREZONE(OpsZone, Coalition, Speed, Altitude, Formation, StayInZoneTime)
|
||||||
@@ -2464,8 +2463,8 @@ end
|
|||||||
-- Therefore, we resort to this workaround, which guides the attacking group to the vicinity of the target. Then they start shooting on their own, once they detect the target.
|
-- Therefore, we resort to this workaround, which guides the attacking group to the vicinity of the target. Then they start shooting on their own, once they detect the target.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Wrapper.Positionable#POSITIONABLE Target The target to attack. Can be a GROUP, UNIT or STATIC object.
|
-- @param Wrapper.Positionable#POSITIONABLE Target The target to attack. Can be a GROUP, UNIT or STATIC object.
|
||||||
-- @param #number Speed Speed in knots. Default max.
|
-- @param #number Speed (Optional) Speed in knots. Default max.
|
||||||
-- @param #string Formation The attack formation, e.g. "Wedge", "Vee" etc. Default `ENUMS.Formation.Vehicle.Vee`. Only working for ground, not naval!
|
-- @param #string Formation (Optional) The attack formation, e.g. "Wedge", "Vee" etc. Default `ENUMS.Formation.Vehicle.Vee`. Only working for ground, not naval!
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewGROUNDATTACK(Target, Speed, Formation)
|
function AUFTRAG:NewGROUNDATTACK(Target, Speed, Formation)
|
||||||
|
|
||||||
@@ -2497,8 +2496,8 @@ end
|
|||||||
-- Therefore, we resort to this workaround, which guides the attacking group to the vicinity of the target. Then they start shooting on their own, once they detect the target.
|
-- Therefore, we resort to this workaround, which guides the attacking group to the vicinity of the target. Then they start shooting on their own, once they detect the target.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Wrapper.Positionable#POSITIONABLE Target The target to attack. Can be a GROUP, UNIT or STATIC object.
|
-- @param Wrapper.Positionable#POSITIONABLE Target The target to attack. Can be a GROUP, UNIT or STATIC object.
|
||||||
-- @param #number Speed Speed in knots. Default max.
|
-- @param #number Speed (Optional) Speed in knots. Default max.
|
||||||
-- @param #number Depth The attack depth in meters. Only for submarines!
|
-- @param #number Depth (Optional) The attack depth in meters. Only for submarines! Defaults to 0.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:NewNAVALENGAGEMENT(Target, Speed, Depth)
|
function AUFTRAG:NewNAVALENGAGEMENT(Target, Speed, Depth)
|
||||||
|
|
||||||
@@ -2527,8 +2526,8 @@ end
|
|||||||
--- **[AIR, GROUND, NAVAL]** Create a RECON mission.
|
--- **[AIR, GROUND, NAVAL]** Create a RECON mission.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Set#SET_ZONE ZoneSet The recon zones.
|
-- @param Core.Set#SET_ZONE ZoneSet The recon zones.
|
||||||
-- @param #number Speed Speed in knots.
|
-- @param #number Speed (Optional) Speed in knots.
|
||||||
-- @param #number Altitude Altitude in feet. Only for airborne units. Default 2000 feet ASL.
|
-- @param #number Altitude (Optional) Altitude in feet. Only for airborne units. Default 2000 feet ASL.
|
||||||
-- @param #boolean Adinfinitum If `true`, the group will start over again after reaching the final zone.
|
-- @param #boolean Adinfinitum If `true`, the group will start over again after reaching the final zone.
|
||||||
-- @param #boolean Randomly If `true`, the group will select a random zone.
|
-- @param #boolean Randomly If `true`, the group will select a random zone.
|
||||||
-- @param #string Formation Formation used during recon route.
|
-- @param #string Formation Formation used during recon route.
|
||||||
@@ -3020,7 +3019,7 @@ end
|
|||||||
|
|
||||||
--- Set mission start and stop time.
|
--- Set mission start and stop time.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #string ClockStart Time the mission is started, e.g. "05:00" for 5 am. If specified as a #number, it will be relative (in seconds) to the current mission time. Default is 5 seconds after mission was added.
|
-- @param #string ClockStart (Optional) Time the mission is started, e.g. "05:00" for 5 am. If specified as a #number, it will be relative (in seconds) to the current mission time. Default is 5 seconds after mission was added.
|
||||||
-- @param #string ClockStop (Optional) Time the mission is stopped, e.g. "13:00" for 1 pm. If mission could not be started at that time, it will be removed from the queue. If specified as a #number it will be relative (in seconds) to the current mission time.
|
-- @param #string ClockStop (Optional) Time the mission is stopped, e.g. "13:00" for 1 pm. If mission could not be started at that time, it will be removed from the queue. If specified as a #number it will be relative (in seconds) to the current mission time.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetTime(ClockStart, ClockStop)
|
function AUFTRAG:SetTime(ClockStart, ClockStop)
|
||||||
@@ -3106,9 +3105,9 @@ end
|
|||||||
|
|
||||||
--- Set mission priority and (optional) urgency. Urgent missions can cancel other running missions.
|
--- Set mission priority and (optional) urgency. Urgent missions can cancel other running missions.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #number Prio Priority 1=high, 100=low. Default 50.
|
-- @param #number Prio (Optional) Priority 1=high, 100=low. Default 50.
|
||||||
-- @param #boolean Urgent If *true*, another running mission might be cancelled if it has a lower priority.
|
-- @param #boolean Urgent If *true*, another running mission might be cancelled if it has a lower priority.
|
||||||
-- @param #number Importance Number 1-10. If missions with lower value are in the queue, these have to be finished first. Default is `nil`.
|
-- @param #number Importance (Optional) Number 1-10. If missions with lower value are in the queue, these have to be finished first. Default is `nil`.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetPriority(Prio, Urgent, Importance)
|
function AUFTRAG:SetPriority(Prio, Urgent, Importance)
|
||||||
self.prio=Prio or 50
|
self.prio=Prio or 50
|
||||||
@@ -3119,7 +3118,7 @@ end
|
|||||||
|
|
||||||
--- **[LEGION, COMMANDER, CHIEF]** Set how many times the mission is repeated. Only valid if the mission is handled by a LEGION (AIRWING, BRIGADE, FLEET) or higher level.
|
--- **[LEGION, COMMANDER, CHIEF]** Set how many times the mission is repeated. Only valid if the mission is handled by a LEGION (AIRWING, BRIGADE, FLEET) or higher level.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #number Nrepeat Number of repeats. Default 0.
|
-- @param #number Nrepeat (Optional) Number of repeats. Default 0.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetRepeat(Nrepeat)
|
function AUFTRAG:SetRepeat(Nrepeat)
|
||||||
self.Nrepeat=Nrepeat or 0
|
self.Nrepeat=Nrepeat or 0
|
||||||
@@ -3129,7 +3128,7 @@ end
|
|||||||
|
|
||||||
--- **[LEGION, COMMANDER, CHIEF]** Set the repeat delay in seconds after a mission is successful/failed. Only valid if the mission is handled by a LEGION (AIRWING, BRIGADE, FLEET) or higher level.
|
--- **[LEGION, COMMANDER, CHIEF]** Set the repeat delay in seconds after a mission is successful/failed. Only valid if the mission is handled by a LEGION (AIRWING, BRIGADE, FLEET) or higher level.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #number RepeatDelay Repeat delay in seconds. Default 1.
|
-- @param #number RepeatDelay (Optional) Repeat delay in seconds. Default 1.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetRepeatDelay(RepeatDelay)
|
function AUFTRAG:SetRepeatDelay(RepeatDelay)
|
||||||
self.repeatDelay = RepeatDelay
|
self.repeatDelay = RepeatDelay
|
||||||
@@ -3138,7 +3137,7 @@ end
|
|||||||
|
|
||||||
--- **[LEGION, COMMANDER, CHIEF]** Set how many times the mission is repeated if it fails. Only valid if the mission is handled by a LEGION (AIRWING, BRIGADE, FLEET) or higher level.
|
--- **[LEGION, COMMANDER, CHIEF]** Set how many times the mission is repeated if it fails. Only valid if the mission is handled by a LEGION (AIRWING, BRIGADE, FLEET) or higher level.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #number Nrepeat Number of repeats. Default 0.
|
-- @param #number Nrepeat (Optional) Number of repeats. Default 0.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetRepeatOnFailure(Nrepeat)
|
function AUFTRAG:SetRepeatOnFailure(Nrepeat)
|
||||||
self.NrepeatFailure=Nrepeat or 0
|
self.NrepeatFailure=Nrepeat or 0
|
||||||
@@ -3147,7 +3146,7 @@ end
|
|||||||
|
|
||||||
--- **[LEGION, COMMANDER, CHIEF]** Set how many times the mission is repeated if it was successful. Only valid if the mission is handled by a LEGION (AIRWING, BRIGADE, FLEET) or higher level.
|
--- **[LEGION, COMMANDER, CHIEF]** Set how many times the mission is repeated if it was successful. Only valid if the mission is handled by a LEGION (AIRWING, BRIGADE, FLEET) or higher level.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #number Nrepeat Number of repeats. Default 0.
|
-- @param #number Nrepeat (Optional) Number of repeats. Default 0.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetRepeatOnSuccess(Nrepeat)
|
function AUFTRAG:SetRepeatOnSuccess(Nrepeat)
|
||||||
self.NrepeatSuccess=Nrepeat or 0
|
self.NrepeatSuccess=Nrepeat or 0
|
||||||
@@ -3168,8 +3167,8 @@ end
|
|||||||
|
|
||||||
--- **[LEGION, COMMANDER, CHIEF]** Define how many assets are required to do the job. Only used if the mission is handled by a **LEGION** (AIRWING, BRIGADE, ...) or higher level.
|
--- **[LEGION, COMMANDER, CHIEF]** Define how many assets are required to do the job. Only used if the mission is handled by a **LEGION** (AIRWING, BRIGADE, ...) or higher level.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #number NassetsMin Minimum number of asset groups. Default 1.
|
-- @param #number NassetsMin (Optional) Minimum number of asset groups. Default 1.
|
||||||
-- @param #number NassetsMax Maximum Number of asset groups. Default is same as `NassetsMin`.
|
-- @param #number NassetsMax (Optional) Maximum Number of asset groups. Default is same as `NassetsMin`.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetRequiredAssets(NassetsMin, NassetsMax)
|
function AUFTRAG:SetRequiredAssets(NassetsMin, NassetsMax)
|
||||||
|
|
||||||
@@ -3236,11 +3235,11 @@ end
|
|||||||
--- **[LEGION, COMMANDER, CHIEF]** Define how many assets are required that escort the mission assets.
|
--- **[LEGION, COMMANDER, CHIEF]** Define how many assets are required that escort the mission assets.
|
||||||
-- Only used if the mission is handled by a **LEGION** (AIRWING, BRIGADE, FLEET) or higher level.
|
-- Only used if the mission is handled by a **LEGION** (AIRWING, BRIGADE, FLEET) or higher level.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #number NescortMin Minimum number of asset groups. Default 1.
|
-- @param #number NescortMin (Optional) Minimum number of asset groups. Default 1.
|
||||||
-- @param #number NescortMax Maximum Number of asset groups. Default is same as `NassetsMin`.
|
-- @param #number NescortMax (Optional) Maximum Number of asset groups. Default is same as `NassetsMin`.
|
||||||
-- @param #string MissionType Mission type assets will be optimized for and payload selected, *e.g.* `AUFTRAG.Type.SEAD`. Default nil.
|
-- @param #string MissionType (Optional) Mission type assets will be optimized for and payload selected, *e.g.* `AUFTRAG.Type.SEAD`. Default nil.
|
||||||
-- @param #table TargetTypes Target Types that will be engaged by the escort group(s). Default `{"Air"}` for aircraft and `{"Ground Units"}` for helos. Set, *e.g.*, `{"Air Defence"}` for SEAD.
|
-- @param #table TargetTypes (Optional) Target Types that will be engaged by the escort group(s). Default `{"Air"}` for aircraft and `{"Ground Units"}` for helos. Set, *e.g.*, `{"Air Defence"}` for SEAD.
|
||||||
-- @param #number EngageRange Max range in nautical miles that the escort group(s) will engage enemies. Default 32 NM (60 km).
|
-- @param #number EngageRange (Optional) Max range in nautical miles that the escort group(s) will engage enemies. Default 32 NM (60 km).
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetRequiredEscorts(NescortMin, NescortMax, MissionType, TargetTypes, EngageRange)
|
function AUFTRAG:SetRequiredEscorts(NescortMin, NescortMax, MissionType, TargetTypes, EngageRange)
|
||||||
|
|
||||||
@@ -3266,7 +3265,7 @@ end
|
|||||||
|
|
||||||
--- Set mission name.
|
--- Set mission name.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #string Name Name of the mission. Default is "Auftrag Nr. X", where X is a running number, which is automatically increased.
|
-- @param #string Name (Optional) Name of the mission. Default is "Auftrag Nr. X", where X is a running number, which is automatically increased.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetName(Name)
|
function AUFTRAG:SetName(Name)
|
||||||
self.name=Name or string.format("Auftrag Nr. %d", self.auftragsnummer)
|
self.name=Name or string.format("Auftrag Nr. %d", self.auftragsnummer)
|
||||||
@@ -3275,7 +3274,7 @@ end
|
|||||||
|
|
||||||
--- Enable markers, which dispay the mission status on the F10 map.
|
--- Enable markers, which dispay the mission status on the F10 map.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #number Coalition The coaliton side to which the markers are dispayed. Default is to all.
|
-- @param #number Coalition (Optional) The coaliton side to which the markers are dispayed. Default is to all.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetEnableMarkers(Coalition)
|
function AUFTRAG:SetEnableMarkers(Coalition)
|
||||||
self.markerOn=true
|
self.markerOn=true
|
||||||
@@ -3285,7 +3284,7 @@ end
|
|||||||
|
|
||||||
--- Set verbosity level.
|
--- Set verbosity level.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #number VerbosityLevel Level of output (higher=more). Default 0.
|
-- @param #number VerbosityLevel (Optional) Level of output (higher=more). Default 0.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetVerbosity(VerbosityLevel)
|
function AUFTRAG:SetVerbosity(VerbosityLevel)
|
||||||
self.verbose=VerbosityLevel or 0
|
self.verbose=VerbosityLevel or 0
|
||||||
@@ -3294,7 +3293,7 @@ end
|
|||||||
|
|
||||||
--- Set weapon type used for the engagement.
|
--- Set weapon type used for the engagement.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #number WeaponType Weapon type. Default is `ENUMS.WeaponFlag.Auto`.
|
-- @param #number WeaponType (Optional) Weapon type. Default is `ENUMS.WeaponFlag.Auto`.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetWeaponType(WeaponType)
|
function AUFTRAG:SetWeaponType(WeaponType)
|
||||||
|
|
||||||
@@ -3308,7 +3307,7 @@ end
|
|||||||
|
|
||||||
--- Set number of weapons to expend.
|
--- Set number of weapons to expend.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #number WeaponExpend How much of the weapon load is expended during the attack, e.g. `AI.Task.WeaponExpend.ALL`. Default "Auto".
|
-- @param #number WeaponExpend (Optional) How much of the weapon load is expended during the attack, e.g. `AI.Task.WeaponExpend.ALL`. Default "Auto".
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetWeaponExpend(WeaponExpend)
|
function AUFTRAG:SetWeaponExpend(WeaponExpend)
|
||||||
|
|
||||||
@@ -3340,7 +3339,7 @@ end
|
|||||||
|
|
||||||
--- Set engage altitude. This is the altitude passed to the DCS task. In the ME it is the tickbox ALTITUDE ABOVE.
|
--- Set engage altitude. This is the altitude passed to the DCS task. In the ME it is the tickbox ALTITUDE ABOVE.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #string Altitude Altitude in feet. Default 6000 ft.
|
-- @param #string Altitude (Optional) Altitude in feet. Default 6000 ft.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetEngageAltitude(Altitude)
|
function AUFTRAG:SetEngageAltitude(Altitude)
|
||||||
|
|
||||||
@@ -3354,10 +3353,10 @@ end
|
|||||||
|
|
||||||
--- Enable to automatically engage detected targets.
|
--- Enable to automatically engage detected targets.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #number RangeMax Max range in NM. Only detected targets within this radius from the group will be engaged. Default is 25 NM.
|
-- @param #number RangeMax (Optional) Max range in NM. Only detected targets within this radius from the group will be engaged. Default is 25 NM.
|
||||||
-- @param #table TargetTypes Types of target attributes that will be engaged. See [DCS enum attributes](https://wiki.hoggitworld.com/view/DCS_enum_attributes). Default "All".
|
-- @param #table TargetTypes (Optional) Types of target attributes that will be engaged. See [DCS enum attributes](https://wiki.hoggitworld.com/view/DCS_enum_attributes). Default "All".
|
||||||
-- @param Core.Set#SET_ZONE EngageZoneSet Set of zones in which targets are engaged. Default is anywhere.
|
-- @param Core.Set#SET_ZONE EngageZoneSet (Optional) Set of zones in which targets are engaged. Default is anywhere.
|
||||||
-- @param Core.Set#SET_ZONE NoEngageZoneSet Set of zones in which targets are *not* engaged. Default is nowhere.
|
-- @param Core.Set#SET_ZONE NoEngageZoneSet (Optional) Set of zones in which targets are *not* engaged. Default is nowhere.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetEngageDetected(RangeMax, TargetTypes, EngageZoneSet, NoEngageZoneSet)
|
function AUFTRAG:SetEngageDetected(RangeMax, TargetTypes, EngageZoneSet, NoEngageZoneSet)
|
||||||
|
|
||||||
@@ -3410,7 +3409,7 @@ end
|
|||||||
|
|
||||||
--- Set max mission range. Only applies if the AUFTRAG is handled by an AIRWING or CHIEF. This is the max allowed distance from the airbase to the target.
|
--- Set max mission range. Only applies if the AUFTRAG is handled by an AIRWING or CHIEF. This is the max allowed distance from the airbase to the target.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #number Range Max range in NM. Default 100 NM.
|
-- @param #number Range (Optional) Max range in NM. Default 100 NM.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetMissionRange(Range)
|
function AUFTRAG:SetMissionRange(Range)
|
||||||
self.engageRange=UTILS.NMToMeters(Range or 100)
|
self.engageRange=UTILS.NMToMeters(Range or 100)
|
||||||
@@ -3436,8 +3435,8 @@ end
|
|||||||
--- **[LEGION, COMMANDER, CHIEF]** Attach OPS transport to the mission. Mission assets will be transported before the mission is started at the OPSGROUP level.
|
--- **[LEGION, COMMANDER, CHIEF]** Attach OPS transport to the mission. Mission assets will be transported before the mission is started at the OPSGROUP level.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param Core.Zone#ZONE DeployZone Zone where assets are deployed.
|
-- @param Core.Zone#ZONE DeployZone Zone where assets are deployed.
|
||||||
-- @param #number NcarriersMin Number of carriers *at least* required. Default 1.
|
-- @param #number NcarriersMin (Optional) Number of carriers *at least* required. Default 1.
|
||||||
-- @param #number NcarriersMax Number of carriers *at most* used for transportation. Default is same as `NcarriersMin`.
|
-- @param #number NcarriersMax (Optional) Number of carriers *at most* used for transportation. Default is same as `NcarriersMin`.
|
||||||
-- @param Core.Zone#ZONE DisembarkZone Zone where assets are disembarked to.
|
-- @param Core.Zone#ZONE DisembarkZone Zone where assets are disembarked to.
|
||||||
-- @param #table Categories Group categories.
|
-- @param #table Categories Group categories.
|
||||||
-- @param #table Attributes Generalizes group attributes.
|
-- @param #table Attributes Generalizes group attributes.
|
||||||
@@ -3499,8 +3498,8 @@ end
|
|||||||
|
|
||||||
--- **[LEGION, COMMANDER, CHIEF]** Set number of required carrier groups if an OPSTRANSPORT assignment is required.
|
--- **[LEGION, COMMANDER, CHIEF]** Set number of required carrier groups if an OPSTRANSPORT assignment is required.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #number NcarriersMin Number of carriers *at least* required. Default 1.
|
-- @param #number NcarriersMin (Optional) Number of carriers *at least* required. Default 1.
|
||||||
-- @param #number NcarriersMax Number of carriers *at most* used for transportation. Default is same as `NcarriersMin`.
|
-- @param #number NcarriersMax (Optional) Number of carriers *at most* used for transportation. Default is same as `NcarriersMin`.
|
||||||
-- @param #table Categories Group categories.
|
-- @param #table Categories Group categories.
|
||||||
-- @param #table Attributes Group attributes. See `GROUP.Attribute.`
|
-- @param #table Attributes Group attributes. See `GROUP.Attribute.`
|
||||||
-- @param #table Properties DCS attributes.
|
-- @param #table Properties DCS attributes.
|
||||||
@@ -3765,7 +3764,7 @@ end
|
|||||||
--- Set radio frequency and modulation for this mission.
|
--- Set radio frequency and modulation for this mission.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #number Frequency Frequency in MHz.
|
-- @param #number Frequency Frequency in MHz.
|
||||||
-- @param #number Modulation Radio modulation. Default 0=AM.
|
-- @param #number Modulation (Optional) Radio modulation. Default 0=AM.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetRadio(Frequency, Modulation)
|
function AUFTRAG:SetRadio(Frequency, Modulation)
|
||||||
|
|
||||||
@@ -3779,9 +3778,9 @@ end
|
|||||||
--- Set TACAN beacon channel and Morse code for this mission.
|
--- Set TACAN beacon channel and Morse code for this mission.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #number Channel TACAN channel.
|
-- @param #number Channel TACAN channel.
|
||||||
-- @param #string Morse Morse code. Default "XXX".
|
-- @param #string Morse (Optional) Morse code. Default "XXX".
|
||||||
-- @param #string UnitName Name of the unit in the group for which acts as TACAN beacon. Default is the first unit in the group.
|
-- @param #string UnitName (Optional) Name of the unit in the group for which acts as TACAN beacon. Default is the first unit in the group.
|
||||||
-- @param #string Band Tacan channel mode ("X" or "Y"). Default is "X" for ground/naval and "Y" for aircraft.
|
-- @param #string Band (Optional) Tacan channel mode ("X" or "Y"). Default is "X" for ground/naval and "Y" for aircraft.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetTACAN(Channel, Morse, UnitName, Band)
|
function AUFTRAG:SetTACAN(Channel, Morse, UnitName, Band)
|
||||||
|
|
||||||
@@ -3797,8 +3796,8 @@ end
|
|||||||
--- Set ICLS beacon channel and Morse code for this mission.
|
--- Set ICLS beacon channel and Morse code for this mission.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #number Channel ICLS channel.
|
-- @param #number Channel ICLS channel.
|
||||||
-- @param #string Morse Morse code. Default "XXX".
|
-- @param #string Morse (Optional) Morse code. Default "XXX".
|
||||||
-- @param #string UnitName Name of the unit in the group for which acts as ICLS beacon. Default is the first unit in the group.
|
-- @param #string UnitName (Optional) Name of the unit in the group for which acts as ICLS beacon. Default is the first unit in the group.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetICLS(Channel, Morse, UnitName)
|
function AUFTRAG:SetICLS(Channel, Morse, UnitName)
|
||||||
|
|
||||||
@@ -3812,7 +3811,7 @@ end
|
|||||||
|
|
||||||
--- Set time interval between mission done and success/failure evaluation.
|
--- Set time interval between mission done and success/failure evaluation.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #number Teval Time in seconds before the mission result is evaluated. Default depends on mission type.
|
-- @param #number Teval (Optional) Time in seconds before the mission result is evaluated. Default depends on mission type.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetEvaluationTime(Teval)
|
function AUFTRAG:SetEvaluationTime(Teval)
|
||||||
|
|
||||||
@@ -6010,7 +6009,7 @@ end
|
|||||||
|
|
||||||
--- Set randomization of the mission waypoint coordinate. Each assigned group will get a random ingress coordinate, where the mission is executed.
|
--- Set randomization of the mission waypoint coordinate. Each assigned group will get a random ingress coordinate, where the mission is executed.
|
||||||
-- @param #AUFTRAG self
|
-- @param #AUFTRAG self
|
||||||
-- @param #number Radius Distance in meters. Default `#nil`.
|
-- @param #number Radius (Optional) Distance in meters. Default `#nil`.
|
||||||
-- @return #AUFTRAG self
|
-- @return #AUFTRAG self
|
||||||
function AUFTRAG:SetMissionWaypointRandomization(Radius)
|
function AUFTRAG:SetMissionWaypointRandomization(Radius)
|
||||||
self.missionWaypointRadius=Radius
|
self.missionWaypointRadius=Radius
|
||||||
|
|||||||
@@ -1410,9 +1410,9 @@ end
|
|||||||
|
|
||||||
--- [User] Set the tactical information option, create 10 radio channels groups can subscribe and get Bogey Dope on a specific frequency automatically. You **need** to set up SRS first before using this!
|
--- [User] Set the tactical information option, create 10 radio channels groups can subscribe and get Bogey Dope on a specific frequency automatically. You **need** to set up SRS first before using this!
|
||||||
-- @param #AWACS self
|
-- @param #AWACS self
|
||||||
-- @param #number BaseFreq Base Frequency to use, defaults to 130.
|
-- @param #number BaseFreq (Optional) Base Frequency to use, defaults to 130.
|
||||||
-- @param #number Increase Increase to use, defaults to 0.5, thus channels created are 130, 130.5, 131 .. etc.
|
-- @param #number Increase (Optional) Increase to use, defaults to 0.5, thus channels created are 130, 130.5, 131 .. etc.
|
||||||
-- @param #number Modulation Modulation to use, defaults to radio.modulation.AM.
|
-- @param #number Modulation (Optional) Modulation to use, defaults to radio.modulation.AM.
|
||||||
-- @param #number Interval Seconds between each update call.
|
-- @param #number Interval Seconds between each update call.
|
||||||
-- @param #number Number Number of Frequencies to create, can be 1..10.
|
-- @param #number Number Number of Frequencies to create, can be 1..10.
|
||||||
-- @return #AWACS self
|
-- @return #AWACS self
|
||||||
@@ -1694,8 +1694,8 @@ end
|
|||||||
|
|
||||||
--- [User] Set TOS Time-on-Station in Hours
|
--- [User] Set TOS Time-on-Station in Hours
|
||||||
-- @param #AWACS self
|
-- @param #AWACS self
|
||||||
-- @param #number AICHours AWACS stays this number of hours on station before shift change, default is 4.
|
-- @param #number AICHours (Optional) AWACS stays this number of hours on station before shift change, default is 4.
|
||||||
-- @param #number CapHours (optional) CAP stays this number of hours on station before shift change, default is 4.
|
-- @param #number CapHours (Optional) CAP stays this number of hours on station before shift change, default is 4.
|
||||||
-- @return #AWACS self
|
-- @return #AWACS self
|
||||||
function AWACS:SetTOS(AICHours,CapHours)
|
function AWACS:SetTOS(AICHours,CapHours)
|
||||||
self:T(self.lid.."SetTOS")
|
self:T(self.lid.."SetTOS")
|
||||||
@@ -1990,7 +1990,7 @@ end
|
|||||||
|
|
||||||
--- [User] Set AWACS Player Guidance - influences missile callout and the "New" label in group callouts.
|
--- [User] Set AWACS Player Guidance - influences missile callout and the "New" label in group callouts.
|
||||||
-- @param #AWACS self
|
-- @param #AWACS self
|
||||||
-- @param #boolean Switch If true (default) it is on, if false, it is off.
|
-- @param #boolean Switch (Optional) If true (default) it is on, if false, it is off.
|
||||||
-- @return #AWACS self
|
-- @return #AWACS self
|
||||||
function AWACS:SetPlayerGuidance(Switch)
|
function AWACS:SetPlayerGuidance(Switch)
|
||||||
if (Switch == nil) or (Switch == true) then
|
if (Switch == nil) or (Switch == true) then
|
||||||
@@ -2010,9 +2010,9 @@ end
|
|||||||
|
|
||||||
--- [User] Set AWACS intercept timeline support distance.
|
--- [User] Set AWACS intercept timeline support distance.
|
||||||
-- @param #AWACS self
|
-- @param #AWACS self
|
||||||
-- @param #number TacDistance Distance for TAC call, default 45nm
|
-- @param #number TacDistance (Optional) Distance for TAC call, default 45nm
|
||||||
-- @param #number MeldDistance Distance for Meld call, default 35nm
|
-- @param #number MeldDistance (Optional) Distance for Meld call, default 35nm
|
||||||
-- @param #number ThreatDistance Distance for Threat call, default 25nm
|
-- @param #number ThreatDistance (Optional) Distance for Threat call, default 25nm
|
||||||
-- @return #AWACS self
|
-- @return #AWACS self
|
||||||
function AWACS:SetInterceptTimeline(TacDistance, MeldDistance, ThreatDistance)
|
function AWACS:SetInterceptTimeline(TacDistance, MeldDistance, ThreatDistance)
|
||||||
self.TacDistance = TacDistance or 45
|
self.TacDistance = TacDistance or 45
|
||||||
@@ -2119,12 +2119,12 @@ end
|
|||||||
|
|
||||||
--- [User] Set AWACS flight details
|
--- [User] Set AWACS flight details
|
||||||
-- @param #AWACS self
|
-- @param #AWACS self
|
||||||
-- @param #number CallSign Defaults to CALLSIGN.AWACS.Magic
|
-- @param #number CallSign (Optional) Defaults to CALLSIGN.AWACS.Magic
|
||||||
-- @param #number CallSignNo Defaults to 1
|
-- @param #number CallSignNo (Optional) Defaults to 1
|
||||||
-- @param #number Angels Defaults to 25 (i.e. 25000 ft)
|
-- @param #number Angels (Optional) Defaults to 25 (i.e. 25000 ft)
|
||||||
-- @param #number Speed Defaults to 250kn
|
-- @param #number Speed (Optional) Defaults to 250kn
|
||||||
-- @param #number Heading Defaults to 0 (North)
|
-- @param #number Heading (Optional) Defaults to 0 (North)
|
||||||
-- @param #number Leg Defaults to 25nm
|
-- @param #number Leg (Optional) Defaults to 25nm
|
||||||
-- @return #AWACS self
|
-- @return #AWACS self
|
||||||
function AWACS:SetAwacsDetails(CallSign,CallSignNo,Angels,Speed,Heading,Leg)
|
function AWACS:SetAwacsDetails(CallSign,CallSignNo,Angels,Speed,Heading,Leg)
|
||||||
self:T(self.lid.."SetAwacsDetails")
|
self:T(self.lid.."SetAwacsDetails")
|
||||||
@@ -2176,13 +2176,13 @@ end
|
|||||||
|
|
||||||
--- [User] Set AWACS SRS TTS details - see @{Sound.SRS} for details. `SetSRS()` will try to use as many attributes configured with @{Sound.SRS#MSRS.LoadConfigFile}() as possible.
|
--- [User] Set AWACS SRS TTS details - see @{Sound.SRS} for details. `SetSRS()` will try to use as many attributes configured with @{Sound.SRS#MSRS.LoadConfigFile}() as possible.
|
||||||
-- @param #AWACS self
|
-- @param #AWACS self
|
||||||
-- @param #string PathToSRS Defaults to "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
|
-- @param #string PathToSRS (Optional) Defaults to "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
|
||||||
-- @param #string Gender Defaults to "male"
|
-- @param #string Gender (Optional) Defaults to "male"
|
||||||
-- @param #string Culture Defaults to "en-US"
|
-- @param #string Culture (Optional) Defaults to "en-US"
|
||||||
-- @param #number Port Defaults to 5002
|
-- @param #number Port (Optional) Defaults to 5002
|
||||||
-- @param #string Voice (Optional) Use a specifc voice with the @{Sound.SRS#SetVoice} function, e.g, `:SetVoice("Microsoft Hedda Desktop")`.
|
-- @param #string Voice (Optional) Use a specifc voice with the @{Sound.SRS#SetVoice} function, e.g, `:SetVoice("Microsoft Hedda Desktop")`.
|
||||||
-- Note that this must be installed on your windows system. Can also be Google voice types, if you are using Google TTS.
|
-- Note that this must be installed on your windows system. Can also be Google voice types, if you are using Google TTS.
|
||||||
-- @param #number Volume Volume - between 0.0 (silent) and 1.0 (loudest)
|
-- @param #number Volume (Optional) Volume - between 0.0 (silent) and 1.0 (loudest) Defaults to 1.0.
|
||||||
-- @param #string PathToGoogleKey (Optional) Path to your google key if you want to use google TTS; if you use a config file for MSRS, hand in nil here.
|
-- @param #string PathToGoogleKey (Optional) Path to your google key if you want to use google TTS; if you use a config file for MSRS, hand in nil here.
|
||||||
-- @param #string AccessKey (Optional) Your Google API access key. This is necessary if DCS-gRPC is used as backend; if you use a config file for MSRS, hand in nil here.
|
-- @param #string AccessKey (Optional) Your Google API access key. This is necessary if DCS-gRPC is used as backend; if you use a config file for MSRS, hand in nil here.
|
||||||
-- @param #string Backend (Optional) Your MSRS Backend if different from your config file settings, e.g. MSRS.Backend.SRSEXE or MSRS.Backend.GRPC
|
-- @param #string Backend (Optional) Your MSRS Backend if different from your config file settings, e.g. MSRS.Backend.SRSEXE or MSRS.Backend.GRPC
|
||||||
@@ -2223,8 +2223,8 @@ end
|
|||||||
|
|
||||||
--- [User] Set AWACS Voice Details for AI CAP Planes - SRS TTS - see @{Sound.SRS} for details
|
--- [User] Set AWACS Voice Details for AI CAP Planes - SRS TTS - see @{Sound.SRS} for details
|
||||||
-- @param #AWACS self
|
-- @param #AWACS self
|
||||||
-- @param #string Gender Defaults to "male"
|
-- @param #string Gender (Optional) Defaults to "male"
|
||||||
-- @param #string Culture Defaults to "en-US"
|
-- @param #string Culture (Optional) Defaults to "en-US"
|
||||||
-- @param #string Voice (Optional) Use a specifc voice with the @{#MSRS.SetVoice} function, e.g, `:SetVoice("Microsoft Hedda Desktop")`.
|
-- @param #string Voice (Optional) Use a specifc voice with the @{#MSRS.SetVoice} function, e.g, `:SetVoice("Microsoft Hedda Desktop")`.
|
||||||
-- Note that this must be installed on your windows system. Can also be Google voice types, if you are using Google TTS.
|
-- Note that this must be installed on your windows system. Can also be Google voice types, if you are using Google TTS.
|
||||||
-- @return #AWACS self
|
-- @return #AWACS self
|
||||||
@@ -2238,10 +2238,10 @@ end
|
|||||||
|
|
||||||
--- [User] Set AI CAP Plane Details
|
--- [User] Set AI CAP Plane Details
|
||||||
-- @param #AWACS self
|
-- @param #AWACS self
|
||||||
-- @param #number Callsign Callsign name of AI CAP, e.g. CALLSIGN.Aircraft.Dodge. Defaults to CALLSIGN.Aircraft.Colt. Note that not all available callsigns work for all plane types.
|
-- @param #number Callsign (Optional) Callsign name of AI CAP, e.g. CALLSIGN.Aircraft.Dodge. Defaults to CALLSIGN.Aircraft.Colt. Note that not all available callsigns work for all plane types.
|
||||||
-- @param #number MaxAICap Maximum number of AI CAP planes on station that AWACS will set up automatically. Default to 4.
|
-- @param #number MaxAICap (Optional) Maximum number of AI CAP planes on station that AWACS will set up automatically. Default to 4.
|
||||||
-- @param #number TOS Time on station, in hours. AI planes might go back to base earlier if they run out of fuel or missiles.
|
-- @param #number TOS (Optional) Time on station, in hours. AI planes might go back to base earlier if they run out of fuel or missiles. Defaults to 4.
|
||||||
-- @param #number Speed Airspeed to be used in knots. Will be adjusted to flight height automatically. Defaults to 270.
|
-- @param #number Speed (Optional) Airspeed to be used in knots. Will be adjusted to flight height automatically. Defaults to 270.
|
||||||
-- @return #AWACS self
|
-- @return #AWACS self
|
||||||
function AWACS:SetAICAPDetails(Callsign,MaxAICap,TOS,Speed)
|
function AWACS:SetAICAPDetails(Callsign,MaxAICap,TOS,Speed)
|
||||||
self:T(self.lid.."SetAICAPDetails")
|
self:T(self.lid.."SetAICAPDetails")
|
||||||
@@ -2257,7 +2257,7 @@ end
|
|||||||
-- @param #number EscortNumber Number of fighther plane GROUPs to accompany this AWACS. 0 or nil means no escorts. If you want >1 plane in an escort group, you can either set the respective squadron grouping to the desired number, or use a template for escorts with >1 unit.
|
-- @param #number EscortNumber Number of fighther plane GROUPs to accompany this AWACS. 0 or nil means no escorts. If you want >1 plane in an escort group, you can either set the respective squadron grouping to the desired number, or use a template for escorts with >1 unit.
|
||||||
-- @param #number Formation Formation the escort should take (if more than one plane), e.g. `ENUMS.Formation.FixedWing.FingerFour.Group`. Formation is used on GROUP level, multiple groups of one unit will NOT conform to this formation.
|
-- @param #number Formation Formation the escort should take (if more than one plane), e.g. `ENUMS.Formation.FixedWing.FingerFour.Group`. Formation is used on GROUP level, multiple groups of one unit will NOT conform to this formation.
|
||||||
-- @param #table OffsetVector Offset the escorts should fly behind the AWACS, given as table, distance in meters, e.g. `{x=-500,y=0,z=500}` - 500m behind (negative value) and to the right (negative for left), no vertical separation (positive over, negative under the AWACS flight). For multiple groups, the vectors will be slightly changed to avoid collisions.
|
-- @param #table OffsetVector Offset the escorts should fly behind the AWACS, given as table, distance in meters, e.g. `{x=-500,y=0,z=500}` - 500m behind (negative value) and to the right (negative for left), no vertical separation (positive over, negative under the AWACS flight). For multiple groups, the vectors will be slightly changed to avoid collisions.
|
||||||
-- @param #number EscortEngageMaxDistance Escorts engage air targets max this NM away, defaults to 45NM.
|
-- @param #number EscortEngageMaxDistance (Optional) Escorts engage air targets max this NM away, defaults to 45NM.
|
||||||
-- @return #AWACS self
|
-- @return #AWACS self
|
||||||
function AWACS:SetEscort(EscortNumber,Formation,OffsetVector,EscortEngageMaxDistance)
|
function AWACS:SetEscort(EscortNumber,Formation,OffsetVector,EscortEngageMaxDistance)
|
||||||
self:T(self.lid.."SetEscort")
|
self:T(self.lid.."SetEscort")
|
||||||
|
|||||||
@@ -1450,9 +1450,9 @@ end
|
|||||||
|
|
||||||
--- [User] Set SRS TTS details - see @{Sound.SRS} for details.`SetSRS()` will try to use as many attributes configured with @{Sound.SRS#MSRS.LoadConfigFile}() as possible.
|
--- [User] Set SRS TTS details - see @{Sound.SRS} for details.`SetSRS()` will try to use as many attributes configured with @{Sound.SRS#MSRS.LoadConfigFile}() as possible.
|
||||||
-- @param #CTLD self
|
-- @param #CTLD self
|
||||||
-- @param #number Frequency Frequency to be used. Can also be given as a table of multiple frequencies, e.g. 30 or {30,124.5}. Defaults to {30,124.5}. There needs to be exactly the same number of modulations!
|
-- @param #number Frequency (Optional) Frequency to be used. Can also be given as a table of multiple frequencies, e.g. 30 or {30,124.5}. Defaults to {30,124.5}. There needs to be exactly the same number of modulations!
|
||||||
-- @param #number Modulation Modulation to be used. Can also be given as a table of multiple modulations, e.g. radio.modulation.AM or {radio.modulation.FM,radio.modulation.AM}. There needs to be exactly the same number of frequencies!
|
-- @param #number Modulation (Optional) Modulation to be used. Can also be given as a table of multiple modulations, e.g. radio.modulation.AM or {radio.modulation.FM,radio.modulation.AM}. There needs to be exactly the same number of frequencies!
|
||||||
-- @param #string PathToSRS Defaults to "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
|
-- @param #string PathToSRS (Optional) Defaults to "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
|
||||||
-- @param #string Gender (Optional) Defaults to "male"
|
-- @param #string Gender (Optional) Defaults to "male"
|
||||||
-- @param #string Culture (Optional) Defaults to "en-US"
|
-- @param #string Culture (Optional) Defaults to "en-US"
|
||||||
-- @param #number Port (Optional) Defaults to 5002
|
-- @param #number Port (Optional) Defaults to 5002
|
||||||
@@ -7637,12 +7637,12 @@ end
|
|||||||
--- User - Function to add/adjust unittype capabilities.
|
--- User - Function to add/adjust unittype capabilities.
|
||||||
-- @param #CTLD self
|
-- @param #CTLD self
|
||||||
-- @param #string Unittype The unittype to adjust. If passed as Wrapper.Unit#UNIT, it will search for the unit in the mission.
|
-- @param #string Unittype The unittype to adjust. If passed as Wrapper.Unit#UNIT, it will search for the unit in the mission.
|
||||||
-- @param #boolean Cancrates Unit can load crates. Default false.
|
-- @param #boolean Cancrates (Optional) Unit can load crates. Default false.
|
||||||
-- @param #boolean Cantroops Unit can load troops. Default false.
|
-- @param #boolean Cantroops (Optional) Unit can load troops. Default false.
|
||||||
-- @param #number Cratelimit Unit can carry number of crates. Default 0.
|
-- @param #number Cratelimit (Optional) Unit can carry number of crates. Default 0.
|
||||||
-- @param #number Trooplimit Unit can carry number of troops. Default 0.
|
-- @param #number Trooplimit (Optional) Unit can carry number of troops. Default 0.
|
||||||
-- @param #number Length Unit lenght (in metres) for the load radius. Default 20.
|
-- @param #number Length (Optional) Unit lenght (in metres) for the load radius. Default 20.
|
||||||
-- @param #number Maxcargoweight Maxmimum weight in kgs this helo can carry. Default 500.
|
-- @param #number Maxcargoweight (Optional) Maxmimum weight in kgs this helo can carry. Default 500.
|
||||||
function CTLD:SetUnitCapabilities(Unittype, Cancrates, Cantroops, Cratelimit, Trooplimit, Length, Maxcargoweight)
|
function CTLD:SetUnitCapabilities(Unittype, Cancrates, Cantroops, Cratelimit, Trooplimit, Length, Maxcargoweight)
|
||||||
self:T(self.lid .. " UnitCapabilities")
|
self:T(self.lid .. " UnitCapabilities")
|
||||||
local unittype = nil
|
local unittype = nil
|
||||||
@@ -7687,12 +7687,12 @@ end
|
|||||||
--- [Deprecated] - Function to add/adjust unittype capabilities. Has been replaced with `SetUnitCapabilities()` - pls use the new one going forward!
|
--- [Deprecated] - Function to add/adjust unittype capabilities. Has been replaced with `SetUnitCapabilities()` - pls use the new one going forward!
|
||||||
-- @param #CTLD self
|
-- @param #CTLD self
|
||||||
-- @param #string Unittype The unittype to adjust. If passed as Wrapper.Unit#UNIT, it will search for the unit in the mission.
|
-- @param #string Unittype The unittype to adjust. If passed as Wrapper.Unit#UNIT, it will search for the unit in the mission.
|
||||||
-- @param #boolean Cancrates Unit can load crates. Default false.
|
-- @param #boolean Cancrates (Optional) Unit can load crates. Default false.
|
||||||
-- @param #boolean Cantroops Unit can load troops. Default false.
|
-- @param #boolean Cantroops (Optional) Unit can load troops. Default false.
|
||||||
-- @param #number Cratelimit Unit can carry number of crates. Default 0.
|
-- @param #number Cratelimit (Optional) Unit can carry number of crates. Default 0.
|
||||||
-- @param #number Trooplimit Unit can carry number of troops. Default 0.
|
-- @param #number Trooplimit (Optional) Unit can carry number of troops. Default 0.
|
||||||
-- @param #number Length Unit lenght (in metres) for the load radius. Default 20.
|
-- @param #number Length (Optional) Unit lenght (in metres) for the load radius. Default 20.
|
||||||
-- @param #number Maxcargoweight Maxmimum weight in kgs this helo can carry. Default 500.
|
-- @param #number Maxcargoweight (Optional) Maxmimum weight in kgs this helo can carry. Default 500.
|
||||||
function CTLD:UnitCapabilities(Unittype, Cancrates, Cantroops, Cratelimit, Trooplimit, Length, Maxcargoweight)
|
function CTLD:UnitCapabilities(Unittype, Cancrates, Cantroops, Cratelimit, Trooplimit, Length, Maxcargoweight)
|
||||||
self:I(self.lid.."This function been replaced with `SetUnitCapabilities()` - pls use the new one going forward!")
|
self:I(self.lid.."This function been replaced with `SetUnitCapabilities()` - pls use the new one going forward!")
|
||||||
self:SetUnitCapabilities(Unittype, Cancrates, Cantroops, Cratelimit, Trooplimit, Length, Maxcargoweight)
|
self:SetUnitCapabilities(Unittype, Cancrates, Cantroops, Cratelimit, Trooplimit, Length, Maxcargoweight)
|
||||||
@@ -7922,7 +7922,7 @@ end
|
|||||||
--- User - Count both the stock and groups in the field for available cargo types. Counts only limited cargo items and only troops and vehicle/FOB crates!
|
--- User - Count both the stock and groups in the field for available cargo types. Counts only limited cargo items and only troops and vehicle/FOB crates!
|
||||||
-- @param #CTLD self
|
-- @param #CTLD self
|
||||||
-- @param #boolean Restock If true, restock the cargo and troop items.
|
-- @param #boolean Restock If true, restock the cargo and troop items.
|
||||||
-- @param #number Threshold Percentage below which to restock, used in conjunction with Restock (must be true). Defaults to 75 (percent).
|
-- @param #number Threshold (Optional) Percentage below which to restock, used in conjunction with Restock (must be true). Defaults to 75 (percent).
|
||||||
-- @return #table Table A table of contents with numbers.
|
-- @return #table Table A table of contents with numbers.
|
||||||
-- @usage
|
-- @usage
|
||||||
-- The index is the unique cargo name.
|
-- The index is the unique cargo name.
|
||||||
|
|||||||
@@ -88,8 +88,8 @@ CTLD_CARGO = {
|
|||||||
-- @param #number PerCrateMass Mass in kg
|
-- @param #number PerCrateMass Mass in kg
|
||||||
-- @param #number Stock Number of builds available, nil for unlimited
|
-- @param #number Stock Number of builds available, nil for unlimited
|
||||||
-- @param #string Subcategory Name of subcategory, handy if using > 10 types to load.
|
-- @param #string Subcategory Name of subcategory, handy if using > 10 types to load.
|
||||||
-- @param #boolean DontShowInMenu Show this item in menu or not (default: false == show it).
|
-- @param #boolean DontShowInMenu (Optional) Show this item in menu or not (default: false == show it).
|
||||||
-- @param Core.Zone#ZONE Location (optional) Where the cargo is available (one location only).
|
-- @param Core.Zone#ZONE Location (Optional) Where the cargo is available (one location only).
|
||||||
-- @return #CTLD_CARGO self
|
-- @return #CTLD_CARGO self
|
||||||
function CTLD_CARGO:New(ID, Name, Templates, Sorte, HasBeenMoved, LoadDirectly, CratesNeeded, Positionable, Dropped, PerCrateMass, Stock, Subcategory, DontShowInMenu, Location)
|
function CTLD_CARGO:New(ID, Name, Templates, Sorte, HasBeenMoved, LoadDirectly, CratesNeeded, Positionable, Dropped, PerCrateMass, Stock, Subcategory, DontShowInMenu, Location)
|
||||||
-- Inherit everything from BASE class.
|
-- Inherit everything from BASE class.
|
||||||
|
|||||||
@@ -362,8 +362,8 @@ CHIEF.version="0.7.0"
|
|||||||
--- Create a new CHIEF object and start the FSM.
|
--- Create a new CHIEF object and start the FSM.
|
||||||
-- @param #CHIEF self
|
-- @param #CHIEF self
|
||||||
-- @param #number Coalition Coalition side, e.g. `coaliton.side.BLUE`. Can also be passed as a string "red", "blue" or "neutral".
|
-- @param #number Coalition Coalition side, e.g. `coaliton.side.BLUE`. Can also be passed as a string "red", "blue" or "neutral".
|
||||||
-- @param Core.Set#SET_GROUP AgentSet Set of agents (groups) providing intel. Default is an empty set.
|
-- @param Core.Set#SET_GROUP AgentSet (Optional) Set of agents (groups) providing intel. Default is an empty set.
|
||||||
-- @param #string Alias An *optional* alias how this object is called in the logs etc.
|
-- @param #string Alias (Optional) An *optional* alias how this object is called in the logs etc.
|
||||||
-- @return #CHIEF self
|
-- @return #CHIEF self
|
||||||
function CHIEF:New(Coalition, AgentSet, Alias)
|
function CHIEF:New(Coalition, AgentSet, Alias)
|
||||||
|
|
||||||
@@ -739,8 +739,8 @@ end
|
|||||||
--- Set a threat level range that will be engaged. Threat level is a number between 0 and 10, where 10 is a very dangerous threat.
|
--- Set a threat level range that will be engaged. Threat level is a number between 0 and 10, where 10 is a very dangerous threat.
|
||||||
-- Targets with threat level 0 are usually harmless.
|
-- Targets with threat level 0 are usually harmless.
|
||||||
-- @param #CHIEF self
|
-- @param #CHIEF self
|
||||||
-- @param #number ThreatLevelMin Min threat level. Default 1.
|
-- @param #number ThreatLevelMin (Optional) Min threat level. Default 1.
|
||||||
-- @param #number ThreatLevelMax Max threat level. Default 10.
|
-- @param #number ThreatLevelMax (Optional) Max threat level. Default 10.
|
||||||
-- @return #CHIEF self
|
-- @return #CHIEF self
|
||||||
function CHIEF:SetThreatLevelRange(ThreatLevelMin, ThreatLevelMax)
|
function CHIEF:SetThreatLevelRange(ThreatLevelMin, ThreatLevelMax)
|
||||||
|
|
||||||
@@ -782,10 +782,10 @@ end
|
|||||||
--- Create a new resource list of required assets.
|
--- Create a new resource list of required assets.
|
||||||
-- @param #CHIEF self
|
-- @param #CHIEF self
|
||||||
-- @param #string MissionType The mission type.
|
-- @param #string MissionType The mission type.
|
||||||
-- @param #number Nmin Min number of required assets. Default 1.
|
-- @param #number Nmin (Optional) Min number of required assets. Default 1.
|
||||||
-- @param #number Nmax Max number of requried assets. Default 1.
|
-- @param #number Nmax (Optional) Max number of requried assets. Default 1.
|
||||||
-- @param #table Attributes Generalized attribute(s). Default `nil`.
|
-- @param #table Attributes (Optional) Generalized attribute(s). Default `nil`.
|
||||||
-- @param #table Properties DCS attribute(s). Default `nil`.
|
-- @param #table Properties (Optional) DCS attribute(s). Default `nil`.
|
||||||
-- @param #table Categories Group categories.
|
-- @param #table Categories Group categories.
|
||||||
-- @return #CHIEF.Resources The newly created resource list table.
|
-- @return #CHIEF.Resources The newly created resource list table.
|
||||||
-- @return #CHIEF.Resource The resource object that was added.
|
-- @return #CHIEF.Resource The resource object that was added.
|
||||||
@@ -802,8 +802,8 @@ end
|
|||||||
-- @param #CHIEF self
|
-- @param #CHIEF self
|
||||||
-- @param #CHIEF.Resources Resource List of resources.
|
-- @param #CHIEF.Resources Resource List of resources.
|
||||||
-- @param #string MissionType Mission Type.
|
-- @param #string MissionType Mission Type.
|
||||||
-- @param #number Nmin Min number of required assets. Default 1.
|
-- @param #number Nmin (Optional) Min number of required assets. Default 1.
|
||||||
-- @param #number Nmax Max number of requried assets. Default equal `Nmin`.
|
-- @param #number Nmax (Optional) Max number of requried assets. Default equal `Nmin`.
|
||||||
-- @param #table Attributes Generalized attribute(s).
|
-- @param #table Attributes Generalized attribute(s).
|
||||||
-- @param #table Properties DCS attribute(s). Default `nil`.
|
-- @param #table Properties DCS attribute(s). Default `nil`.
|
||||||
-- @param #table Categories Group categories.
|
-- @param #table Categories Group categories.
|
||||||
@@ -845,8 +845,8 @@ end
|
|||||||
--- Define which assets will be transported and define the number and attributes/properties of the cargo carrier assets.
|
--- Define which assets will be transported and define the number and attributes/properties of the cargo carrier assets.
|
||||||
-- @param #CHIEF self
|
-- @param #CHIEF self
|
||||||
-- @param #CHIEF.Resource Resource Resource table.
|
-- @param #CHIEF.Resource Resource Resource table.
|
||||||
-- @param #number Nmin Min number of required assets. Default 1.
|
-- @param #number Nmin (Optional) Min number of required assets. Default 1.
|
||||||
-- @param #number Nmax Max number of requried assets. Default is equal to `Nmin`.
|
-- @param #number Nmax (Optional) Max number of requried assets. Default is equal to `Nmin`.
|
||||||
-- @param #table CarrierAttributes Generalized attribute(s) of the carrier assets.
|
-- @param #table CarrierAttributes Generalized attribute(s) of the carrier assets.
|
||||||
-- @param #table CarrierProperties DCS attribute(s) of the carrier assets.
|
-- @param #table CarrierProperties DCS attribute(s) of the carrier assets.
|
||||||
-- @param #table CarrierCategories Group categories of the carrier assets.
|
-- @param #table CarrierCategories Group categories of the carrier assets.
|
||||||
@@ -884,12 +884,12 @@ end
|
|||||||
|
|
||||||
--- Set number of assets requested for detected targets.
|
--- Set number of assets requested for detected targets.
|
||||||
-- @param #CHIEF self
|
-- @param #CHIEF self
|
||||||
-- @param #number NassetsMin Min number of assets. Should be at least 1. Default 1.
|
-- @param #number NassetsMin (Optional) Min number of assets. Should be at least 1. Default 1.
|
||||||
-- @param #number NassetsMax Max number of assets. Default is same as `NassetsMin`.
|
-- @param #number NassetsMax (Optional) Max number of assets. Default is same as `NassetsMin`.
|
||||||
-- @param #number ThreatLevel Only apply this setting if the target threat level is greater or equal this number. Default 0.
|
-- @param #number ThreatLevel (Optional) Only apply this setting if the target threat level is greater or equal this number. Default 0.
|
||||||
-- @param #string TargetCategory Only apply this setting if the target is of this category, e.g. `TARGET.Category.AIRCRAFT`.
|
-- @param #string TargetCategory Only apply this setting if the target is of this category, e.g. `TARGET.Category.AIRCRAFT`.
|
||||||
-- @param #string MissionType Only apply this setting for this mission type, e.g. `AUFTRAG.Type.INTERCEPT`.
|
-- @param #string MissionType Only apply this setting for this mission type, e.g. `AUFTRAG.Type.INTERCEPT`.
|
||||||
-- @param #string Nunits Only apply this setting if the number of enemy units is greater or equal this number.
|
-- @param #string Nunits (Optional) Only apply this setting if the number of enemy units is greater or equal this number. Defaults to 1.
|
||||||
-- @param #string Defcon Only apply this setting if this defense condition is in place.
|
-- @param #string Defcon Only apply this setting if this defense condition is in place.
|
||||||
-- @param #string Strategy Only apply this setting if this strategy is in currently. place.
|
-- @param #string Strategy Only apply this setting if this strategy is in currently. place.
|
||||||
-- @return #CHIEF self
|
-- @return #CHIEF self
|
||||||
@@ -1038,8 +1038,8 @@ end
|
|||||||
|
|
||||||
--- Set limit for number of total or specific missions to be executed simultaniously.
|
--- Set limit for number of total or specific missions to be executed simultaniously.
|
||||||
-- @param #CHIEF self
|
-- @param #CHIEF self
|
||||||
-- @param #number Limit Number of max. mission of this type. Default 10.
|
-- @param #number Limit (Optional) Number of max. mission of this type. Default 10.
|
||||||
-- @param #string MissionType Type of mission, e.g. `AUFTRAG.Type.BAI`. Default `"Total"` for total number of missions.
|
-- @param #string MissionType (Optional) Type of mission, e.g. `AUFTRAG.Type.BAI`. Default `"Total"` for total number of missions.
|
||||||
-- @return #CHIEF self
|
-- @return #CHIEF self
|
||||||
function CHIEF:SetLimitMission(Limit, MissionType)
|
function CHIEF:SetLimitMission(Limit, MissionType)
|
||||||
self.commander:SetLimitMission(Limit, MissionType)
|
self.commander:SetLimitMission(Limit, MissionType)
|
||||||
@@ -1065,7 +1065,7 @@ end
|
|||||||
|
|
||||||
--- Set strategy.
|
--- Set strategy.
|
||||||
-- @param #CHIEF self
|
-- @param #CHIEF self
|
||||||
-- @param #string Strategy Strategy. See @{#CHIEF.strategy}, e.g. `CHIEF.Strategy.DEFENSIVE` (default).
|
-- @param #string Strategy (Optional) Strategy. See @{#CHIEF.strategy}, e.g. `CHIEF.Strategy.DEFENSIVE` (default).
|
||||||
-- @return #CHIEF self
|
-- @return #CHIEF self
|
||||||
function CHIEF:SetStrategy(Strategy)
|
function CHIEF:SetStrategy(Strategy)
|
||||||
|
|
||||||
@@ -1295,8 +1295,8 @@ end
|
|||||||
--
|
--
|
||||||
-- @param #CHIEF self
|
-- @param #CHIEF self
|
||||||
-- @param Ops.OpsZone#OPSZONE OpsZone OPS zone object.
|
-- @param Ops.OpsZone#OPSZONE OpsZone OPS zone object.
|
||||||
-- @param #number Priority Priority. Default 50.
|
-- @param #number Priority (Optional) Priority. Default 50.
|
||||||
-- @param #number Importance Importance. Default `#nil`.
|
-- @param #number Importance (Optional) Importance. Default `#nil`.
|
||||||
-- @param #CHIEF.Resources ResourceOccupied (Optional) Resources used then zone is occupied by the enemy.
|
-- @param #CHIEF.Resources ResourceOccupied (Optional) Resources used then zone is occupied by the enemy.
|
||||||
-- @param #CHIEF.Resources ResourceEmpty (Optional) Resources used then zone is empty.
|
-- @param #CHIEF.Resources ResourceEmpty (Optional) Resources used then zone is empty.
|
||||||
-- @return #CHIEF.StrategicZone The strategic zone.
|
-- @return #CHIEF.StrategicZone The strategic zone.
|
||||||
@@ -1393,7 +1393,7 @@ end
|
|||||||
--- Remove strategically important zone. All runing missions are cancelled.
|
--- Remove strategically important zone. All runing missions are cancelled.
|
||||||
-- @param #CHIEF self
|
-- @param #CHIEF self
|
||||||
-- @param Ops.OpsZone#OPSZONE OpsZone OPS zone object.
|
-- @param Ops.OpsZone#OPSZONE OpsZone OPS zone object.
|
||||||
-- @param #number Delay Delay in seconds before the zone is removed. Default immidiately.
|
-- @param #number Delay (Optional) Delay in seconds before the zone is removed. Default immidiately.
|
||||||
-- @return #CHIEF self
|
-- @return #CHIEF self
|
||||||
function CHIEF:RemoveStrategicZone(OpsZone, Delay)
|
function CHIEF:RemoveStrategicZone(OpsZone, Delay)
|
||||||
|
|
||||||
@@ -1467,10 +1467,10 @@ end
|
|||||||
--- Add a CAP zone. Flights will engage detected targets inside this zone.
|
--- Add a CAP zone. Flights will engage detected targets inside this zone.
|
||||||
-- @param #CHIEF self
|
-- @param #CHIEF self
|
||||||
-- @param Core.Zone#ZONE Zone CAP Zone. Has to be a circular zone.
|
-- @param Core.Zone#ZONE Zone CAP Zone. Has to be a circular zone.
|
||||||
-- @param #number Altitude Orbit altitude in feet. Default is 12,000 feet.
|
-- @param #number Altitude (Optional) Orbit altitude in feet. Default is 12,000 feet.
|
||||||
-- @param #number Speed Orbit speed in KIAS. Default 350 kts.
|
-- @param #number Speed (Optional) Orbit speed in KIAS. Default 350 kts.
|
||||||
-- @param #number Heading Heading of race-track pattern in degrees. Default 270 (East to West).
|
-- @param #number Heading(Optional) Heading of race-track pattern in degrees. Default 270 (East to West).
|
||||||
-- @param #number Leg Length of race-track in NM. Default 30 NM.
|
-- @param #number Leg (Optional) Length of race-track in NM. Default 30 NM.
|
||||||
-- @return Ops.Airwing#AIRWING.PatrolZone The CAP zone data.
|
-- @return Ops.Airwing#AIRWING.PatrolZone The CAP zone data.
|
||||||
function CHIEF:AddCapZone(Zone, Altitude, Speed, Heading, Leg)
|
function CHIEF:AddCapZone(Zone, Altitude, Speed, Heading, Leg)
|
||||||
|
|
||||||
@@ -1483,10 +1483,10 @@ end
|
|||||||
--- Add a GCI CAP.
|
--- Add a GCI CAP.
|
||||||
-- @param #CHIEF self
|
-- @param #CHIEF self
|
||||||
-- @param Core.Zone#ZONE Zone Zone, where the flight orbits.
|
-- @param Core.Zone#ZONE Zone Zone, where the flight orbits.
|
||||||
-- @param #number Altitude Orbit altitude in feet. Default is 12,000 feet.
|
-- @param #number Altitude (Optional) Orbit altitude in feet. Default is 12,000 feet.
|
||||||
-- @param #number Speed Orbit speed in KIAS. Default 350 kts.
|
-- @param #number Speed (Optional) Orbit speed in KIAS. Default 350 kts.
|
||||||
-- @param #number Heading Heading of race-track pattern in degrees. Default 270 (East to West).
|
-- @param #number Heading (Optional) Heading of race-track pattern in degrees. Default 270 (East to West).
|
||||||
-- @param #number Leg Length of race-track in NM. Default 30 NM.
|
-- @param #number Leg (Optional) Length of race-track in NM. Default 30 NM.
|
||||||
-- @return Ops.Airwing#AIRWING.PatrolZone The CAP zone data.
|
-- @return Ops.Airwing#AIRWING.PatrolZone The CAP zone data.
|
||||||
function CHIEF:AddGciCapZone(Zone, Altitude, Speed, Heading, Leg)
|
function CHIEF:AddGciCapZone(Zone, Altitude, Speed, Heading, Leg)
|
||||||
|
|
||||||
@@ -1510,10 +1510,10 @@ end
|
|||||||
--- Add an AWACS zone.
|
--- Add an AWACS zone.
|
||||||
-- @param #CHIEF self
|
-- @param #CHIEF self
|
||||||
-- @param Core.Zone#ZONE Zone Zone.
|
-- @param Core.Zone#ZONE Zone Zone.
|
||||||
-- @param #number Altitude Orbit altitude in feet. Default is 12,000 feet.
|
-- @param #number Altitude (Optional) Orbit altitude in feet. Default is 12,000 feet.
|
||||||
-- @param #number Speed Orbit speed in KIAS. Default 350 kts.
|
-- @param #number Speed (Optional) Orbit speed in KIAS. Default 350 kts.
|
||||||
-- @param #number Heading Heading of race-track pattern in degrees. Default 270 (East to West).
|
-- @param #number Heading (Optional) Heading of race-track pattern in degrees. Default 270 (East to West).
|
||||||
-- @param #number Leg Length of race-track in NM. Default 30 NM.
|
-- @param #number Leg (Optional) Length of race-track in NM. Default 30 NM.
|
||||||
-- @return Ops.Airwing#AIRWING.PatrolZone The AWACS zone data.
|
-- @return Ops.Airwing#AIRWING.PatrolZone The AWACS zone data.
|
||||||
function CHIEF:AddAwacsZone(Zone, Altitude, Speed, Heading, Leg)
|
function CHIEF:AddAwacsZone(Zone, Altitude, Speed, Heading, Leg)
|
||||||
|
|
||||||
@@ -1537,10 +1537,10 @@ end
|
|||||||
--- Add a refuelling tanker zone.
|
--- Add a refuelling tanker zone.
|
||||||
-- @param #CHIEF self
|
-- @param #CHIEF self
|
||||||
-- @param Core.Zone#ZONE Zone Zone.
|
-- @param Core.Zone#ZONE Zone Zone.
|
||||||
-- @param #number Altitude Orbit altitude in feet. Default is 12,000 feet.
|
-- @param #number Altitude (Optional) Orbit altitude in feet. Default is 12,000 feet.
|
||||||
-- @param #number Speed Orbit speed in KIAS. Default 350 kts.
|
-- @param #number Speed (Optional) Orbit speed in KIAS. Default 350 kts.
|
||||||
-- @param #number Heading Heading of race-track pattern in degrees. Default 270 (East to West).
|
-- @param #number Heading (Optional) Heading of race-track pattern in degrees. Default 270 (East to West).
|
||||||
-- @param #number Leg Length of race-track in NM. Default 30 NM.
|
-- @param #number Leg (Optional) Length of race-track in NM. Default 30 NM.
|
||||||
-- @param #number RefuelSystem Refuelling system.
|
-- @param #number RefuelSystem Refuelling system.
|
||||||
-- @return Ops.Airwing#AIRWING.TankerZone The tanker zone data.
|
-- @return Ops.Airwing#AIRWING.TankerZone The tanker zone data.
|
||||||
function CHIEF:AddTankerZone(Zone, Altitude, Speed, Heading, Leg, RefuelSystem)
|
function CHIEF:AddTankerZone(Zone, Altitude, Speed, Heading, Leg, RefuelSystem)
|
||||||
|
|||||||
@@ -109,8 +109,8 @@ _COHORTNAMES={}
|
|||||||
--- Create a new COHORT object and start the FSM.
|
--- Create a new COHORT object and start the FSM.
|
||||||
-- @param #COHORT self
|
-- @param #COHORT self
|
||||||
-- @param #string TemplateGroupName Name of the template group.
|
-- @param #string TemplateGroupName Name of the template group.
|
||||||
-- @param #number Ngroups Number of asset groups of this Cohort. Default 3.
|
-- @param #number Ngroups (Optional) Number of asset groups of this Cohort. Default 3.
|
||||||
-- @param #string CohortName Name of the cohort.
|
-- @param #string CohortName (Optional) Name of the cohort. Defaults to TemplateGroupName.
|
||||||
-- @return #COHORT self
|
-- @return #COHORT self
|
||||||
function COHORT:New(TemplateGroupName, Ngroups, CohortName)
|
function COHORT:New(TemplateGroupName, Ngroups, CohortName)
|
||||||
|
|
||||||
@@ -357,7 +357,7 @@ end
|
|||||||
|
|
||||||
--- Set verbosity level.
|
--- Set verbosity level.
|
||||||
-- @param #COHORT self
|
-- @param #COHORT self
|
||||||
-- @param #number VerbosityLevel Level of output (higher=more). Default 0.
|
-- @param #number VerbosityLevel (Optional) Level of output (higher=more). Default 0.
|
||||||
-- @return #COHORT self
|
-- @return #COHORT self
|
||||||
function COHORT:SetVerbosity(VerbosityLevel)
|
function COHORT:SetVerbosity(VerbosityLevel)
|
||||||
self.verbose=VerbosityLevel or 0
|
self.verbose=VerbosityLevel or 0
|
||||||
@@ -366,8 +366,8 @@ end
|
|||||||
|
|
||||||
--- Set turnover and repair time. If an asset returns from a mission, it will need some time until the asset is available for further missions.
|
--- Set turnover and repair time. If an asset returns from a mission, it will need some time until the asset is available for further missions.
|
||||||
-- @param #COHORT self
|
-- @param #COHORT self
|
||||||
-- @param #number MaintenanceTime Time in minutes it takes until a flight is combat ready again. Default is 0 min.
|
-- @param #number MaintenanceTime (Optional) Time in minutes it takes until a flight is combat ready again. Default is 0 min.
|
||||||
-- @param #number RepairTime Time in minutes it takes to repair a flight for each life point taken. Default is 0 min.
|
-- @param #number RepairTime (Optional) Time in minutes it takes to repair a flight for each life point taken. Default is 0 min.
|
||||||
-- @return #COHORT self
|
-- @return #COHORT self
|
||||||
function COHORT:SetTurnoverTime(MaintenanceTime, RepairTime)
|
function COHORT:SetTurnoverTime(MaintenanceTime, RepairTime)
|
||||||
self.maintenancetime=MaintenanceTime and MaintenanceTime*60 or 0
|
self.maintenancetime=MaintenanceTime and MaintenanceTime*60 or 0
|
||||||
@@ -377,8 +377,8 @@ end
|
|||||||
|
|
||||||
--- Set radio frequency and modulation the cohort uses.
|
--- Set radio frequency and modulation the cohort uses.
|
||||||
-- @param #COHORT self
|
-- @param #COHORT self
|
||||||
-- @param #number Frequency Radio frequency in MHz. Default 251 MHz.
|
-- @param #number Frequency (Optional) Radio frequency in MHz. Default 251 MHz.
|
||||||
-- @param #number Modulation Radio modulation. Default 0=AM.
|
-- @param #number Modulation (Optional) Radio modulation. Default 0=AM.
|
||||||
-- @return #COHORT self
|
-- @return #COHORT self
|
||||||
function COHORT:SetRadio(Frequency, Modulation)
|
function COHORT:SetRadio(Frequency, Modulation)
|
||||||
self.radioFreq=Frequency or 251
|
self.radioFreq=Frequency or 251
|
||||||
@@ -388,7 +388,7 @@ end
|
|||||||
|
|
||||||
--- Set number of units in groups.
|
--- Set number of units in groups.
|
||||||
-- @param #COHORT self
|
-- @param #COHORT self
|
||||||
-- @param #number nunits Number of units. Default 2.
|
-- @param #number nunits (Optional) Number of units. Default 2.
|
||||||
-- @return #COHORT self
|
-- @return #COHORT self
|
||||||
function COHORT:SetGrouping(nunits)
|
function COHORT:SetGrouping(nunits)
|
||||||
self.ngrouping=nunits or 2
|
self.ngrouping=nunits or 2
|
||||||
@@ -398,7 +398,7 @@ end
|
|||||||
--- Set mission types this cohort is able to perform.
|
--- Set mission types this cohort is able to perform.
|
||||||
-- @param #COHORT self
|
-- @param #COHORT self
|
||||||
-- @param #table MissionTypes Table of mission types. Can also be passed as a #string if only one type.
|
-- @param #table MissionTypes Table of mission types. Can also be passed as a #string if only one type.
|
||||||
-- @param #number Performance Performance describing how good this mission can be performed. Higher is better. Default 50. Max 100.
|
-- @param #number Performance (Optional) Performance describing how good this mission can be performed. Higher is better. Default 50. Max 100.
|
||||||
-- @return #COHORT self
|
-- @return #COHORT self
|
||||||
function COHORT:AddMissionCapability(MissionTypes, Performance)
|
function COHORT:AddMissionCapability(MissionTypes, Performance)
|
||||||
|
|
||||||
@@ -505,7 +505,7 @@ end
|
|||||||
|
|
||||||
--- Set max mission range. Only missions in a circle of this radius around the cohort base are executed.
|
--- Set max mission range. Only missions in a circle of this radius around the cohort base are executed.
|
||||||
-- @param #COHORT self
|
-- @param #COHORT self
|
||||||
-- @param #number Range Range in NM. Default 150 NM.
|
-- @param #number Range (Optional) Range in NM. Default 150 NM.
|
||||||
-- @return #COHORT self
|
-- @return #COHORT self
|
||||||
function COHORT:SetMissionRange(Range)
|
function COHORT:SetMissionRange(Range)
|
||||||
self.engageRange=UTILS.NMToMeters(Range or 150)
|
self.engageRange=UTILS.NMToMeters(Range or 150)
|
||||||
@@ -628,8 +628,8 @@ end
|
|||||||
|
|
||||||
--- Remove assets from pool. Not that assets must not be spawned or already reserved or requested.
|
--- Remove assets from pool. Not that assets must not be spawned or already reserved or requested.
|
||||||
-- @param #COHORT self
|
-- @param #COHORT self
|
||||||
-- @param #number N Number of assets to be removed. Default 1.
|
-- @param #number N (Optional) Number of assets to be removed. Default 1.
|
||||||
-- @param #number Delay Delay in seconds before assets are removed.
|
-- @param #number Delay (Optional) Delay in seconds before assets are removed. Defaults to 0.
|
||||||
-- @return #COHORT self
|
-- @return #COHORT self
|
||||||
function COHORT:RemoveAssets(N, Delay)
|
function COHORT:RemoveAssets(N, Delay)
|
||||||
self:T2(self.lid..string.format("Remove %d assets of Cohort", N))
|
self:T2(self.lid..string.format("Remove %d assets of Cohort", N))
|
||||||
@@ -818,9 +818,9 @@ end
|
|||||||
|
|
||||||
--- Add a weapon range for ARTY missions (@{Ops.Auftrag#AUFTRAG}).
|
--- Add a weapon range for ARTY missions (@{Ops.Auftrag#AUFTRAG}).
|
||||||
-- @param #COHORT self
|
-- @param #COHORT self
|
||||||
-- @param #number RangeMin Minimum range in nautical miles. Default 0 NM.
|
-- @param #number RangeMin (Optional) Minimum range in nautical miles. Default 0 NM.
|
||||||
-- @param #number RangeMax Maximum range in nautical miles. Default 10 NM.
|
-- @param #number RangeMax (Optional) Maximum range in nautical miles. Default 10 NM.
|
||||||
-- @param #number BitType Bit mask of weapon type for which the given min/max ranges apply. Default is `ENUMS.WeaponFlag.Auto`, i.e. for all weapon types.
|
-- @param #number BitType (Optional) Bit mask of weapon type for which the given min/max ranges apply. Default is `ENUMS.WeaponFlag.Auto`, i.e. for all weapon types.
|
||||||
-- @return #COHORT self
|
-- @return #COHORT self
|
||||||
function COHORT:AddWeaponRange(RangeMin, RangeMax, BitType)
|
function COHORT:AddWeaponRange(RangeMin, RangeMax, BitType)
|
||||||
|
|
||||||
|
|||||||
@@ -389,7 +389,7 @@ end
|
|||||||
|
|
||||||
--- Set verbosity level.
|
--- Set verbosity level.
|
||||||
-- @param #COMMANDER self
|
-- @param #COMMANDER self
|
||||||
-- @param #number VerbosityLevel Level of output (higher=more). Default 0.
|
-- @param #number VerbosityLevel (Optional) Level of output (higher=more). Default 0.
|
||||||
-- @return #COMMANDER self
|
-- @return #COMMANDER self
|
||||||
function COMMANDER:SetVerbosity(VerbosityLevel)
|
function COMMANDER:SetVerbosity(VerbosityLevel)
|
||||||
self.verbose=VerbosityLevel or 0
|
self.verbose=VerbosityLevel or 0
|
||||||
@@ -398,8 +398,8 @@ end
|
|||||||
|
|
||||||
--- Set limit for number of total or specific missions to be executed simultaniously.
|
--- Set limit for number of total or specific missions to be executed simultaniously.
|
||||||
-- @param #COMMANDER self
|
-- @param #COMMANDER self
|
||||||
-- @param #number Limit Number of max. mission of this type. Default 10.
|
-- @param #number Limit (Optional) Number of max. mission of this type. Default 10.
|
||||||
-- @param #string MissionType Type of mission, e.g. `AUFTRAG.Type.BAI`. Default `"Total"` for total number of missions.
|
-- @param #string MissionType (Optional) Type of mission, e.g. `AUFTRAG.Type.BAI`. Default `"Total"` for total number of missions.
|
||||||
-- @return #COMMANDER self
|
-- @return #COMMANDER self
|
||||||
function COMMANDER:SetLimitMission(Limit, MissionType)
|
function COMMANDER:SetLimitMission(Limit, MissionType)
|
||||||
MissionType=MissionType or "Total"
|
MissionType=MissionType or "Total"
|
||||||
@@ -664,10 +664,10 @@ end
|
|||||||
--- Add a CAP zone.
|
--- Add a CAP zone.
|
||||||
-- @param #COMMANDER self
|
-- @param #COMMANDER self
|
||||||
-- @param Core.Zone#ZONE Zone CapZone Zone.
|
-- @param Core.Zone#ZONE Zone CapZone Zone.
|
||||||
-- @param #number Altitude Orbit altitude in feet. Default is 12,000 feet.
|
-- @param #number Altitude (Optional) Orbit altitude in feet. Default is 12,000 feet.
|
||||||
-- @param #number Speed Orbit speed in KIAS. Default 350 kts.
|
-- @param #number Speed (Optional) Orbit speed in KIAS. Default 350 kts.
|
||||||
-- @param #number Heading Heading of race-track pattern in degrees. Default 270 (East to West).
|
-- @param #number Heading (Optional) Heading of race-track pattern in degrees. Default 270 (East to West).
|
||||||
-- @param #number Leg Length of race-track in NM. Default 30 NM.
|
-- @param #number Leg (Optional) Length of race-track in NM. Default 30 NM.
|
||||||
-- @return Ops.Airwing#AIRWING.PatrolZone The CAP zone data.
|
-- @return Ops.Airwing#AIRWING.PatrolZone The CAP zone data.
|
||||||
function COMMANDER:AddCapZone(Zone, Altitude, Speed, Heading, Leg)
|
function COMMANDER:AddCapZone(Zone, Altitude, Speed, Heading, Leg)
|
||||||
|
|
||||||
@@ -690,10 +690,10 @@ end
|
|||||||
--- Add a GCICAP zone.
|
--- Add a GCICAP zone.
|
||||||
-- @param #COMMANDER self
|
-- @param #COMMANDER self
|
||||||
-- @param Core.Zone#ZONE Zone CapZone Zone.
|
-- @param Core.Zone#ZONE Zone CapZone Zone.
|
||||||
-- @param #number Altitude Orbit altitude in feet. Default is 12,000 feet.
|
-- @param #number Altitude (Optional) Orbit altitude in feet. Default is 12,000 feet.
|
||||||
-- @param #number Speed Orbit speed in KIAS. Default 350 kts.
|
-- @param #number Speed (Optional) Orbit speed in KIAS. Default 350 kts.
|
||||||
-- @param #number Heading Heading of race-track pattern in degrees. Default 270 (East to West).
|
-- @param #number Heading (Optional) Heading of race-track pattern in degrees. Default 270 (East to West).
|
||||||
-- @param #number Leg Length of race-track in NM. Default 30 NM.
|
-- @param #number Leg (Optional) Length of race-track in NM. Default 30 NM.
|
||||||
-- @return Ops.Airwing#AIRWING.PatrolZone The CAP zone data.
|
-- @return Ops.Airwing#AIRWING.PatrolZone The CAP zone data.
|
||||||
function COMMANDER:AddGciCapZone(Zone, Altitude, Speed, Heading, Leg)
|
function COMMANDER:AddGciCapZone(Zone, Altitude, Speed, Heading, Leg)
|
||||||
|
|
||||||
@@ -736,10 +736,10 @@ end
|
|||||||
--- Add an AWACS zone.
|
--- Add an AWACS zone.
|
||||||
-- @param #COMMANDER self
|
-- @param #COMMANDER self
|
||||||
-- @param Core.Zone#ZONE Zone Zone.
|
-- @param Core.Zone#ZONE Zone Zone.
|
||||||
-- @param #number Altitude Orbit altitude in feet. Default is 12,000 feet.
|
-- @param #number Altitude (Optional) Orbit altitude in feet. Default is 12,000 feet.
|
||||||
-- @param #number Speed Orbit speed in KIAS. Default 350 kts.
|
-- @param #number Speed (Optional) Orbit speed in KIAS. Default 350 kts.
|
||||||
-- @param #number Heading Heading of race-track pattern in degrees. Default 270 (East to West).
|
-- @param #number Heading (Optional) Heading of race-track pattern in degrees. Default 270 (East to West).
|
||||||
-- @param #number Leg Length of race-track in NM. Default 30 NM.
|
-- @param #number Leg (Optional) Length of race-track in NM. Default 30 NM.
|
||||||
-- @return Ops.Airwing#AIRWING.PatrolZone The AWACS zone data.
|
-- @return Ops.Airwing#AIRWING.PatrolZone The AWACS zone data.
|
||||||
function COMMANDER:AddAwacsZone(Zone, Altitude, Speed, Heading, Leg)
|
function COMMANDER:AddAwacsZone(Zone, Altitude, Speed, Heading, Leg)
|
||||||
|
|
||||||
@@ -783,10 +783,10 @@ end
|
|||||||
--- Add a refuelling tanker zone.
|
--- Add a refuelling tanker zone.
|
||||||
-- @param #COMMANDER self
|
-- @param #COMMANDER self
|
||||||
-- @param Core.Zone#ZONE Zone Zone.
|
-- @param Core.Zone#ZONE Zone Zone.
|
||||||
-- @param #number Altitude Orbit altitude in feet. Default is 12,000 feet.
|
-- @param #number Altitude (Optional) Orbit altitude in feet. Default is 12,000 feet.
|
||||||
-- @param #number Speed Orbit speed in KIAS. Default 350 kts.
|
-- @param #number Speed (Optional) Orbit speed in KIAS. Default 350 kts.
|
||||||
-- @param #number Heading Heading of race-track pattern in degrees. Default 270 (East to West).
|
-- @param #number Heading (Optional) Heading of race-track pattern in degrees. Default 270 (East to West).
|
||||||
-- @param #number Leg Length of race-track in NM. Default 30 NM.
|
-- @param #number Leg (Optional) Length of race-track in NM. Default 30 NM.
|
||||||
-- @param #number RefuelSystem Refuelling system.
|
-- @param #number RefuelSystem Refuelling system.
|
||||||
-- @return Ops.Airwing#AIRWING.TankerZone The tanker zone data.
|
-- @return Ops.Airwing#AIRWING.TankerZone The tanker zone data.
|
||||||
function COMMANDER:AddTankerZone(Zone, Altitude, Speed, Heading, Leg, RefuelSystem)
|
function COMMANDER:AddTankerZone(Zone, Altitude, Speed, Heading, Leg, RefuelSystem)
|
||||||
@@ -851,10 +851,10 @@ end
|
|||||||
-- @param #COMMANDER self
|
-- @param #COMMANDER self
|
||||||
-- @param Ops.Cohort#COHORT Cohort The cohort to be relocated.
|
-- @param Ops.Cohort#COHORT Cohort The cohort to be relocated.
|
||||||
-- @param Ops.Legion#LEGION Legion The legion where the cohort is relocated to.
|
-- @param Ops.Legion#LEGION Legion The legion where the cohort is relocated to.
|
||||||
-- @param #number Delay Delay in seconds before relocation takes place. Default `nil`, *i.e.* ASAP.
|
-- @param #number Delay (Optional) Delay in seconds before relocation takes place. Default `nil`, *i.e.* ASAP.
|
||||||
-- @param #number NcarriersMin Min number of transport carriers in case the troops should be transported. Default `nil` for no transport.
|
-- @param #number NcarriersMin (Optional) Min number of transport carriers in case the troops should be transported. Default `nil` for no transport.
|
||||||
-- @param #number NcarriersMax Max number of transport carriers.
|
-- @param #number NcarriersMax Max number of transport carriers.
|
||||||
-- @param #table TransportLegions Legion(s) assigned for transportation. Default is all legions of the commander.
|
-- @param #table TransportLegions (Optional) Legion(s) assigned for transportation. Default is all legions of the commander.
|
||||||
-- @return #COMMANDER self
|
-- @return #COMMANDER self
|
||||||
function COMMANDER:RelocateCohort(Cohort, Legion, Delay, NcarriersMin, NcarriersMax, TransportLegions)
|
function COMMANDER:RelocateCohort(Cohort, Legion, Delay, NcarriersMin, NcarriersMax, TransportLegions)
|
||||||
|
|
||||||
@@ -1620,7 +1620,7 @@ end
|
|||||||
--- Set how many missions can be assigned in a single status iteration. (eg. This is useful for persistent missions where you need to load all AUFTRAGs on mission start and then change it back to default)
|
--- Set how many missions can be assigned in a single status iteration. (eg. This is useful for persistent missions where you need to load all AUFTRAGs on mission start and then change it back to default)
|
||||||
--- Warning: Increasing this value will increase the number of missions started per iteration and thus may lead to performance issues if too many missions are started at once.
|
--- Warning: Increasing this value will increase the number of missions started per iteration and thus may lead to performance issues if too many missions are started at once.
|
||||||
-- @param #COMMANDER self
|
-- @param #COMMANDER self
|
||||||
-- @param #number Number of missions assigned per status iteration. Default is 1.
|
-- @param #number MaxMissionsAssignPerCycle (Optional) Number of missions assigned per status iteration. Default is 1.
|
||||||
-- @return #COMMANDER self.
|
-- @return #COMMANDER self.
|
||||||
function COMMANDER:SetMaxMissionsAssignPerCycle(MaxMissionsAssignPerCycle)
|
function COMMANDER:SetMaxMissionsAssignPerCycle(MaxMissionsAssignPerCycle)
|
||||||
self.maxMissionsAssignPerCycle = MaxMissionsAssignPerCycle or 1
|
self.maxMissionsAssignPerCycle = MaxMissionsAssignPerCycle or 1
|
||||||
@@ -2229,7 +2229,7 @@ end
|
|||||||
|
|
||||||
--- Get assets on given mission or missions.
|
--- Get assets on given mission or missions.
|
||||||
-- @param #COMMANDER self
|
-- @param #COMMANDER self
|
||||||
-- @param #table MissionTypes Types on mission to be checked. Default all.
|
-- @param #table MissionTypes (Optional) Types on mission to be checked. Default all.
|
||||||
-- @return #table Assets on pending requests.
|
-- @return #table Assets on pending requests.
|
||||||
function COMMANDER:GetAssetsOnMission(MissionTypes)
|
function COMMANDER:GetAssetsOnMission(MissionTypes)
|
||||||
|
|
||||||
|
|||||||
@@ -408,7 +408,7 @@ end
|
|||||||
|
|
||||||
--- Set Tanker and Scouts to be invisible to enemy AI eyes
|
--- Set Tanker and Scouts to be invisible to enemy AI eyes
|
||||||
-- @param #EASYA2G self
|
-- @param #EASYA2G self
|
||||||
-- @param #boolean Switch Set to true or false, by default this is set to true already
|
-- @param #boolean Switch (Optional) Set to true or false, by default this is set to true already
|
||||||
-- @return #EASYA2G self
|
-- @return #EASYA2G self
|
||||||
function EASYA2G:SetTankerAndScoutsInvisible(Switch)
|
function EASYA2G:SetTankerAndScoutsInvisible(Switch)
|
||||||
self:T(self.lid.."SetTankerAndScoutsInvisible")
|
self:T(self.lid.."SetTankerAndScoutsInvisible")
|
||||||
@@ -418,7 +418,7 @@ end
|
|||||||
|
|
||||||
--- Set default A2G Speed in knots
|
--- Set default A2G Speed in knots
|
||||||
-- @param #EASYA2G self
|
-- @param #EASYA2G self
|
||||||
-- @param #number Speed Speed defaults to 300
|
-- @param #number Speed (Optional) Speed defaults to 300
|
||||||
-- @return #EASYA2G self
|
-- @return #EASYA2G self
|
||||||
function EASYA2G:SetDefaultA2GSpeed(Speed)
|
function EASYA2G:SetDefaultA2GSpeed(Speed)
|
||||||
self:T(self.lid.."SetDefaultSpeed")
|
self:T(self.lid.."SetDefaultSpeed")
|
||||||
@@ -428,7 +428,7 @@ end
|
|||||||
|
|
||||||
--- Set A2G Flight formation.
|
--- Set A2G Flight formation.
|
||||||
-- @param #EASYA2G self
|
-- @param #EASYA2G self
|
||||||
-- @param #number Formation Formation to fly, defaults to ENUMS.Formation.FixedWing.FingerFour.Group
|
-- @param #number Formation (Optional) Formation to fly, defaults to ENUMS.Formation.FixedWing.FingerFour.Group
|
||||||
-- @return #EASYA2G self
|
-- @return #EASYA2G self
|
||||||
function EASYA2G:SetA2GFormation(Formation)
|
function EASYA2G:SetA2GFormation(Formation)
|
||||||
self:T(self.lid.."SetA2GFormation")
|
self:T(self.lid.."SetA2GFormation")
|
||||||
@@ -438,7 +438,7 @@ end
|
|||||||
|
|
||||||
--- Set default A2G Altitude in feet
|
--- Set default A2G Altitude in feet
|
||||||
-- @param #EASYA2G self
|
-- @param #EASYA2G self
|
||||||
-- @param #number Altitude Altitude defaults to 25000
|
-- @param #number Altitude (Optional) Altitude defaults to 25000
|
||||||
-- @return #EASYA2G self
|
-- @return #EASYA2G self
|
||||||
function EASYA2G:SetDefaultA2GAlt(Altitude)
|
function EASYA2G:SetDefaultA2GAlt(Altitude)
|
||||||
self:T(self.lid.."SetDefaultAltitude")
|
self:T(self.lid.."SetDefaultAltitude")
|
||||||
@@ -448,7 +448,7 @@ end
|
|||||||
|
|
||||||
--- Set default A2G lieg initial direction in degrees
|
--- Set default A2G lieg initial direction in degrees
|
||||||
-- @param #EASYA2G self
|
-- @param #EASYA2G self
|
||||||
-- @param #number Direction Direction defaults to 90 (East)
|
-- @param #number Direction (Optional) Direction defaults to 90 (East)
|
||||||
-- @return #EASYA2G self
|
-- @return #EASYA2G self
|
||||||
function EASYA2G:SetDefaultA2GDirection(Direction)
|
function EASYA2G:SetDefaultA2GDirection(Direction)
|
||||||
self:T(self.lid.."SetDefaultDirection")
|
self:T(self.lid.."SetDefaultDirection")
|
||||||
@@ -458,7 +458,7 @@ end
|
|||||||
|
|
||||||
--- Set default leg length in NM
|
--- Set default leg length in NM
|
||||||
-- @param #EASYA2G self
|
-- @param #EASYA2G self
|
||||||
-- @param #number Leg Leg defaults to 5
|
-- @param #number Leg (Optional) Leg defaults to 5
|
||||||
-- @return #EASYA2G self
|
-- @return #EASYA2G self
|
||||||
function EASYA2G:SetDefaultA2GLeg(Leg)
|
function EASYA2G:SetDefaultA2GLeg(Leg)
|
||||||
self:T(self.lid.."SetDefaultLeg")
|
self:T(self.lid.."SetDefaultLeg")
|
||||||
@@ -468,7 +468,7 @@ end
|
|||||||
|
|
||||||
--- Set default grouping, i.e. how many airplanes per A2G point
|
--- Set default grouping, i.e. how many airplanes per A2G point
|
||||||
-- @param #EASYA2G self
|
-- @param #EASYA2G self
|
||||||
-- @param #number Grouping Grouping defaults to 2
|
-- @param #number Grouping (Optional) Grouping defaults to 2
|
||||||
-- @return #EASYA2G self
|
-- @return #EASYA2G self
|
||||||
function EASYA2G:SetDefaultA2GGrouping(Grouping)
|
function EASYA2G:SetDefaultA2GGrouping(Grouping)
|
||||||
self:T(self.lid.."SetDefaultA2GGrouping")
|
self:T(self.lid.."SetDefaultA2GGrouping")
|
||||||
@@ -489,7 +489,7 @@ end
|
|||||||
|
|
||||||
--- Set which target types A2G flights will prefer to engage, defaults to {"Ground"}
|
--- Set which target types A2G flights will prefer to engage, defaults to {"Ground"}
|
||||||
-- @param #EASYA2G self
|
-- @param #EASYA2G self
|
||||||
-- @param #table types Table of comma separated #string entries, defaults to {"Ground"} (everything that is ground and is not a weapon). Useful other options are e.g. {"Armored vehicles"}, {"Tanks"},
|
-- @param #table types (Optional) Table of comma separated #string entries, defaults to {"Ground"} (everything that is ground and is not a weapon). Useful other options are e.g. {"Armored vehicles"}, {"Tanks"},
|
||||||
-- or {"APC"} or combinations like {"APC", "Tanks", "Artillery"}. See [Hoggit Wiki](https://wiki.hoggitworld.com/view/DCS_enum_attributes).
|
-- or {"APC"} or combinations like {"APC", "Tanks", "Artillery"}. See [Hoggit Wiki](https://wiki.hoggitworld.com/view/DCS_enum_attributes).
|
||||||
-- @return #EASYA2G self
|
-- @return #EASYA2G self
|
||||||
function EASYA2G:SetA2GEngageTargetTypes(types)
|
function EASYA2G:SetA2GEngageTargetTypes(types)
|
||||||
@@ -501,10 +501,10 @@ end
|
|||||||
-- @param #EASYA2G self
|
-- @param #EASYA2G self
|
||||||
-- @param #string AirbaseName Name of the Wing's airbase
|
-- @param #string AirbaseName Name of the Wing's airbase
|
||||||
-- @param Core.Point#COORDINATE Coordinate. Can be handed as a Core.Zone#ZONE object (e.g. in case you want the point to align with a moving zone).
|
-- @param Core.Point#COORDINATE Coordinate. Can be handed as a Core.Zone#ZONE object (e.g. in case you want the point to align with a moving zone).
|
||||||
-- @param #number Altitude Defaults to 25000 feet ASL.
|
-- @param #number Altitude (Optional) Defaults to 25000 feet ASL.
|
||||||
-- @param #number Speed Defaults to 300 knots TAS.
|
-- @param #number Speed (Optional) Defaults to 300 knots TAS.
|
||||||
-- @param #number Heading Defaults to 90 degrees (East).
|
-- @param #number Heading (Optional) Defaults to 90 degrees (East).
|
||||||
-- @param #number LegLength Defaults to 15 NM.
|
-- @param #number LegLength (Optional) Defaults to 15 NM.
|
||||||
-- @return #EASYA2G self
|
-- @return #EASYA2G self
|
||||||
function EASYA2G:AddHoldingPointA2G(AirbaseName,Coordinate,Altitude,Speed,Heading,LegLength)
|
function EASYA2G:AddHoldingPointA2G(AirbaseName,Coordinate,Altitude,Speed,Heading,LegLength)
|
||||||
self:T(self.lid.."AddHoldingPointA2G")--..Coordinate:ToStringLLDDM())
|
self:T(self.lid.."AddHoldingPointA2G")--..Coordinate:ToStringLLDDM())
|
||||||
|
|||||||
@@ -447,7 +447,7 @@ end
|
|||||||
|
|
||||||
--- Set "fuel low" threshold for CAP and INTERCEPT flights.
|
--- Set "fuel low" threshold for CAP and INTERCEPT flights.
|
||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #number Percent RTB if fuel at this percent. Values: 1..100, defaults to 25.
|
-- @param #number Percent (Optional) RTB if fuel at this percent. Values: 1..100, defaults to 25.
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:SetFuelLow(Percent)
|
function EASYGCICAP:SetFuelLow(Percent)
|
||||||
self:T(self.lid.."SetFuelLow")
|
self:T(self.lid.."SetFuelLow")
|
||||||
@@ -470,7 +470,7 @@ end
|
|||||||
|
|
||||||
--- Set "fuel critical" threshold for CAP and INTERCEPT flights.
|
--- Set "fuel critical" threshold for CAP and INTERCEPT flights.
|
||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #number Percent RTB if fuel at this percent. Values: 1..100, defaults to 10.
|
-- @param #number Percent (Optional) RTB if fuel at this percent. Values: 1..100, defaults to 10.
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:SetFuelCritical(Percent)
|
function EASYGCICAP:SetFuelCritical(Percent)
|
||||||
self:T(self.lid.."SetFuelCritical")
|
self:T(self.lid.."SetFuelCritical")
|
||||||
@@ -480,7 +480,7 @@ end
|
|||||||
|
|
||||||
--- Set CAP formation.
|
--- Set CAP formation.
|
||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #number Formation Formation to fly, defaults to ENUMS.Formation.FixedWing.FingerFour.Group
|
-- @param #number Formation (Optional) Formation to fly, defaults to ENUMS.Formation.FixedWing.FingerFour.Group
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:SetCAPFormation(Formation)
|
function EASYGCICAP:SetCAPFormation(Formation)
|
||||||
self:T(self.lid.."SetCAPFormation")
|
self:T(self.lid.."SetCAPFormation")
|
||||||
@@ -514,7 +514,7 @@ end
|
|||||||
|
|
||||||
--- Set Maximum of alive missions created by this instance to stop airplanes spamming the map
|
--- Set Maximum of alive missions created by this instance to stop airplanes spamming the map
|
||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #number Maxiumum Maxmimum number of parallel missions allowed. Count is Intercept-Missions + Alert5-Missions, default is 8
|
-- @param #number Maxiumum (Optional) Maxmimum number of parallel missions allowed. Count is Intercept-Missions + Alert5-Missions, default is 8
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:SetMaxAliveMissions(Maxiumum)
|
function EASYGCICAP:SetMaxAliveMissions(Maxiumum)
|
||||||
self:T(self.lid.."SetMaxAliveMissions")
|
self:T(self.lid.."SetMaxAliveMissions")
|
||||||
@@ -524,7 +524,7 @@ end
|
|||||||
|
|
||||||
--- Add default time to resurrect Airwing building if destroyed
|
--- Add default time to resurrect Airwing building if destroyed
|
||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #number Seconds Seconds, defaults to 900
|
-- @param #number Seconds (Optional) Seconds, defaults to 900
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:SetDefaultResurrection(Seconds)
|
function EASYGCICAP:SetDefaultResurrection(Seconds)
|
||||||
self:T(self.lid.."SetDefaultResurrection")
|
self:T(self.lid.."SetDefaultResurrection")
|
||||||
@@ -534,7 +534,7 @@ end
|
|||||||
|
|
||||||
--- Add default repeat attempts if an Intruder intercepts fails.
|
--- Add default repeat attempts if an Intruder intercepts fails.
|
||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #number Retries Retries, defaults to 3
|
-- @param #number Retries (Optional) Retries, defaults to 3
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:SetDefaultRepeatOnFailure(Retries)
|
function EASYGCICAP:SetDefaultRepeatOnFailure(Retries)
|
||||||
self:T(self.lid.."SetDefaultRepeatOnFailure")
|
self:T(self.lid.."SetDefaultRepeatOnFailure")
|
||||||
@@ -544,7 +544,7 @@ end
|
|||||||
|
|
||||||
--- Add default take off type for the airwings.
|
--- Add default take off type for the airwings.
|
||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #string Takeoff Can be "hot", "cold", or "air" - default is "hot".
|
-- @param #string Takeoff (Optional) Can be "hot", "cold", or "air" - default is "hot".
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:SetDefaultTakeOffType(Takeoff)
|
function EASYGCICAP:SetDefaultTakeOffType(Takeoff)
|
||||||
self:T(self.lid.."SetDefaultTakeOffType")
|
self:T(self.lid.."SetDefaultTakeOffType")
|
||||||
@@ -554,7 +554,7 @@ end
|
|||||||
|
|
||||||
--- Set default CAP Speed in knots
|
--- Set default CAP Speed in knots
|
||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #number Speed Speed defaults to 300
|
-- @param #number Speed (Optional) Speed defaults to 300
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:SetDefaultCAPSpeed(Speed)
|
function EASYGCICAP:SetDefaultCAPSpeed(Speed)
|
||||||
self:T(self.lid.."SetDefaultSpeed")
|
self:T(self.lid.."SetDefaultSpeed")
|
||||||
@@ -564,7 +564,7 @@ end
|
|||||||
|
|
||||||
--- Set default CAP Altitude in feet
|
--- Set default CAP Altitude in feet
|
||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #number Altitude Altitude defaults to 25000
|
-- @param #number Altitude (Optional) Altitude defaults to 25000
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:SetDefaultCAPAlt(Altitude)
|
function EASYGCICAP:SetDefaultCAPAlt(Altitude)
|
||||||
self:T(self.lid.."SetDefaultAltitude")
|
self:T(self.lid.."SetDefaultAltitude")
|
||||||
@@ -574,7 +574,7 @@ end
|
|||||||
|
|
||||||
--- Set default CAP lieg initial direction in degrees
|
--- Set default CAP lieg initial direction in degrees
|
||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #number Direction Direction defaults to 90 (East)
|
-- @param #number Direction (Optional) Direction defaults to 90 (East)
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:SetDefaultCAPDirection(Direction)
|
function EASYGCICAP:SetDefaultCAPDirection(Direction)
|
||||||
self:T(self.lid.."SetDefaultDirection")
|
self:T(self.lid.."SetDefaultDirection")
|
||||||
@@ -584,7 +584,7 @@ end
|
|||||||
|
|
||||||
--- Set default leg length in NM
|
--- Set default leg length in NM
|
||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #number Leg Leg defaults to 15
|
-- @param #number Leg (Optional) Leg defaults to 15
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:SetDefaultCAPLeg(Leg)
|
function EASYGCICAP:SetDefaultCAPLeg(Leg)
|
||||||
self:T(self.lid.."SetDefaultLeg")
|
self:T(self.lid.."SetDefaultLeg")
|
||||||
@@ -594,7 +594,7 @@ end
|
|||||||
|
|
||||||
--- Set default grouping, i.e. how many airplanes per CAP point
|
--- Set default grouping, i.e. how many airplanes per CAP point
|
||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #number Grouping Grouping defaults to 2
|
-- @param #number Grouping (Optional) Grouping defaults to 2
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:SetDefaultCAPGrouping(Grouping)
|
function EASYGCICAP:SetDefaultCAPGrouping(Grouping)
|
||||||
self:T(self.lid.."SetDefaultCAPGrouping")
|
self:T(self.lid.."SetDefaultCAPGrouping")
|
||||||
@@ -604,7 +604,7 @@ end
|
|||||||
|
|
||||||
--- Set default range planes can fly from their homebase in NM
|
--- Set default range planes can fly from their homebase in NM
|
||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #number Range Range defaults to 100 NM
|
-- @param #number Range (Optional) Range defaults to 100 NM
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:SetDefaultMissionRange(Range)
|
function EASYGCICAP:SetDefaultMissionRange(Range)
|
||||||
self:T(self.lid.."SetDefaultMissionRange")
|
self:T(self.lid.."SetDefaultMissionRange")
|
||||||
@@ -614,8 +614,8 @@ end
|
|||||||
|
|
||||||
--- Set default turnover times for squadrons in minutes
|
--- Set default turnover times for squadrons in minutes
|
||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #number MaintenanceTime Time in minutes it takes until a flight is combat ready again. Default is 5 min.
|
-- @param #number MaintenanceTime (Optional) Time in minutes it takes until a flight is combat ready again. Default is 5 min.
|
||||||
-- @param #number RepairTime Time in minutes it takes to repair a flight for each life point taken. Default is 10 min.
|
-- @param #number RepairTime (Optional) Time in minutes it takes to repair a flight for each life point taken. Default is 10 min.
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:SetDefaultTurnoverTime(MaintenanceTime,RepairTime)
|
function EASYGCICAP:SetDefaultTurnoverTime(MaintenanceTime,RepairTime)
|
||||||
self:T(self.lid.."SetDefaultTurnoverTime")
|
self:T(self.lid.."SetDefaultTurnoverTime")
|
||||||
@@ -626,7 +626,7 @@ end
|
|||||||
|
|
||||||
--- Set default number of airframes standing by for intercept tasks (visible on the airfield)
|
--- Set default number of airframes standing by for intercept tasks (visible on the airfield)
|
||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #number Airframes defaults to 2
|
-- @param #number Airframes (Optional) defaults to 2
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:SetDefaultNumberAlert5Standby(Airframes)
|
function EASYGCICAP:SetDefaultNumberAlert5Standby(Airframes)
|
||||||
self:T(self.lid.."SetDefaultNumberAlert5Standby")
|
self:T(self.lid.."SetDefaultNumberAlert5Standby")
|
||||||
@@ -636,7 +636,7 @@ end
|
|||||||
|
|
||||||
--- Set default engage range for intruders detected by CAP flights in NM.
|
--- Set default engage range for intruders detected by CAP flights in NM.
|
||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #number Range defaults to 50NM
|
-- @param #number Range (Optional) defaults to 50NM
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:SetDefaultEngageRange(Range)
|
function EASYGCICAP:SetDefaultEngageRange(Range)
|
||||||
self:T(self.lid.."SetDefaultEngageRange")
|
self:T(self.lid.."SetDefaultEngageRange")
|
||||||
@@ -689,7 +689,7 @@ end
|
|||||||
|
|
||||||
--- Set which target types CAP flights will prefer to engage, defaults to {"Air"}
|
--- Set which target types CAP flights will prefer to engage, defaults to {"Air"}
|
||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #table types Table of comma separated #string entries, defaults to {"Air"} (everything that flies and is not a weapon). Useful other options are e.g. {"Bombers"}, {"Fighters"},
|
-- @param #table types (Optional) Table of comma separated #string entries, defaults to {"Air"} (everything that flies and is not a weapon). Useful other options are e.g. {"Bombers"}, {"Fighters"},
|
||||||
-- or {"Helicopters"} or combinations like {"Bombers", "Fighters", "UAVs"}. See [Hoggit Wiki](https://wiki.hoggitworld.com/view/DCS_enum_attributes).
|
-- or {"Helicopters"} or combinations like {"Bombers", "Fighters", "UAVs"}. See [Hoggit Wiki](https://wiki.hoggitworld.com/view/DCS_enum_attributes).
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:SetCAPEngageTargetTypes(types)
|
function EASYGCICAP:SetCAPEngageTargetTypes(types)
|
||||||
@@ -860,10 +860,10 @@ end
|
|||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #string AirbaseName Name of the Wing's airbase
|
-- @param #string AirbaseName Name of the Wing's airbase
|
||||||
-- @param Core.Point#COORDINATE Coordinate. Can be handed as a Core.Zone#ZONE object (e.g. in case you want the point to align with a moving zone).
|
-- @param Core.Point#COORDINATE Coordinate. Can be handed as a Core.Zone#ZONE object (e.g. in case you want the point to align with a moving zone).
|
||||||
-- @param #number Altitude Defaults to 25000 feet ASL.
|
-- @param #number Altitude (Optional) Defaults to 25000 feet ASL.
|
||||||
-- @param #number Speed Defaults to 300 knots TAS.
|
-- @param #number Speed (Optional) Defaults to 300 knots TAS.
|
||||||
-- @param #number Heading Defaults to 90 degrees (East).
|
-- @param #number Heading (Optional) Defaults to 90 degrees (East).
|
||||||
-- @param #number LegLength Defaults to 15 NM.
|
-- @param #number LegLength(Optional) Defaults to 15 NM.
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:AddPatrolPointCAP(AirbaseName,Coordinate,Altitude,Speed,Heading,LegLength)
|
function EASYGCICAP:AddPatrolPointCAP(AirbaseName,Coordinate,Altitude,Speed,Heading,LegLength)
|
||||||
self:T(self.lid.."AddPatrolPointCAP")--..Coordinate:ToStringLLDDM())
|
self:T(self.lid.."AddPatrolPointCAP")--..Coordinate:ToStringLLDDM())
|
||||||
@@ -891,10 +891,10 @@ end
|
|||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #string AirbaseName Name of the Wing's airbase
|
-- @param #string AirbaseName Name of the Wing's airbase
|
||||||
-- @param Core.Point#COORDINATE Coordinate. Can be handed as a Core.Zone#ZONE object (e.g. in case you want the point to align with a moving zone).
|
-- @param Core.Point#COORDINATE Coordinate. Can be handed as a Core.Zone#ZONE object (e.g. in case you want the point to align with a moving zone).
|
||||||
-- @param #number Altitude Defaults to 25000 feet.
|
-- @param #number Altitude (Optional) Defaults to 25000 feet.
|
||||||
-- @param #number Speed Defaults to 300 knots.
|
-- @param #number Speed (Optional) Defaults to 300 knots.
|
||||||
-- @param #number Heading Defaults to 90 degrees (East).
|
-- @param #number Heading (Optional) Defaults to 90 degrees (East).
|
||||||
-- @param #number LegLength Defaults to 15 NM.
|
-- @param #number LegLength (Optional) Defaults to 15 NM.
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:AddPatrolPointRecon(AirbaseName,Coordinate,Altitude,Speed,Heading,LegLength)
|
function EASYGCICAP:AddPatrolPointRecon(AirbaseName,Coordinate,Altitude,Speed,Heading,LegLength)
|
||||||
self:T(self.lid.."AddPatrolPointRecon "..Coordinate:ToStringLLDDM())
|
self:T(self.lid.."AddPatrolPointRecon "..Coordinate:ToStringLLDDM())
|
||||||
@@ -916,10 +916,10 @@ end
|
|||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #string AirbaseName Name of the Wing's airbase
|
-- @param #string AirbaseName Name of the Wing's airbase
|
||||||
-- @param Core.Point#COORDINATE Coordinate. Can be handed as a Core.Zone#ZONE object (e.g. in case you want the point to align with a moving zone).
|
-- @param Core.Point#COORDINATE Coordinate. Can be handed as a Core.Zone#ZONE object (e.g. in case you want the point to align with a moving zone).
|
||||||
-- @param #number Altitude Defaults to 25000 feet.
|
-- @param #number Altitude (Optional) Defaults to 25000 feet.
|
||||||
-- @param #number Speed Defaults to 300 knots.
|
-- @param #number Speed (Optional) Defaults to 300 knots.
|
||||||
-- @param #number Heading Defaults to 90 degrees (East).
|
-- @param #number Heading (Optional) Defaults to 90 degrees (East).
|
||||||
-- @param #number LegLength Defaults to 15 NM.
|
-- @param #number LegLength (Optional) Defaults to 15 NM.
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:AddPatrolPointTanker(AirbaseName,Coordinate,Altitude,Speed,Heading,LegLength)
|
function EASYGCICAP:AddPatrolPointTanker(AirbaseName,Coordinate,Altitude,Speed,Heading,LegLength)
|
||||||
self:T(self.lid.."AddPatrolPointTanker "..Coordinate:ToStringLLDDM())
|
self:T(self.lid.."AddPatrolPointTanker "..Coordinate:ToStringLLDDM())
|
||||||
@@ -941,10 +941,10 @@ end
|
|||||||
-- @param #EASYGCICAP self
|
-- @param #EASYGCICAP self
|
||||||
-- @param #string AirbaseName Name of the Wing's airbase
|
-- @param #string AirbaseName Name of the Wing's airbase
|
||||||
-- @param Core.Point#COORDINATE Coordinate. Can be handed as a Core.Zone#ZONE object (e.g. in case you want the point to align with a moving zone).
|
-- @param Core.Point#COORDINATE Coordinate. Can be handed as a Core.Zone#ZONE object (e.g. in case you want the point to align with a moving zone).
|
||||||
-- @param #number Altitude Defaults to 25000 feet.
|
-- @param #number Altitude (Optional) Defaults to 25000 feet.
|
||||||
-- @param #number Speed Defaults to 300 knots.
|
-- @param #number Speed (Optional) Defaults to 300 knots.
|
||||||
-- @param #number Heading Defaults to 90 degrees (East).
|
-- @param #number Heading (Optional) Defaults to 90 degrees (East).
|
||||||
-- @param #number LegLength Defaults to 15 NM.
|
-- @param #number LegLength (Optional) Defaults to 15 NM.
|
||||||
-- @return #EASYGCICAP self
|
-- @return #EASYGCICAP self
|
||||||
function EASYGCICAP:AddPatrolPointAwacs(AirbaseName,Coordinate,Altitude,Speed,Heading,LegLength)
|
function EASYGCICAP:AddPatrolPointAwacs(AirbaseName,Coordinate,Altitude,Speed,Heading,LegLength)
|
||||||
self:T(self.lid.."AddPatrolPointAwacs "..Coordinate:ToStringLLDDM())
|
self:T(self.lid.."AddPatrolPointAwacs "..Coordinate:ToStringLLDDM())
|
||||||
|
|||||||
@@ -359,11 +359,11 @@ FLIGHTCONTROL.version="0.7.7"
|
|||||||
--- Create a new FLIGHTCONTROL class object for an associated airbase.
|
--- Create a new FLIGHTCONTROL class object for an associated airbase.
|
||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param #string AirbaseName Name of the airbase.
|
-- @param #string AirbaseName Name of the airbase.
|
||||||
-- @param #number Frequency Radio frequency in MHz. Default 143.00 MHz. Can also be given as a `#table` of multiple frequencies.
|
-- @param #number Frequency (Optional) Radio frequency in MHz. Default 143.00 MHz. Can also be given as a `#table` of multiple frequencies.
|
||||||
-- @param #number Modulation Radio modulation: 0=AM (default), 1=FM. See `radio.modulation.AM` and `radio.modulation.FM` enumerators. Can also be given as a `#table` of multiple modulations.
|
-- @param #number Modulation (Optional) Radio modulation: 0=AM (default), 1=FM. See `radio.modulation.AM` and `radio.modulation.FM` enumerators. Can also be given as a `#table` of multiple modulations.
|
||||||
-- @param #string PathToSRS Path to the directory, where SRS is located.
|
-- @param #string PathToSRS (Optional) Path to the directory, where SRS is located.
|
||||||
-- @param #number Port Port of SRS Server, defaults to 5002
|
-- @param #number Port (Optional) Port of SRS Server, defaults to 5002
|
||||||
-- @param #string GoogleKey Path to the Google JSON-Key.
|
-- @param #string GoogleKey (Optional) Path to the Google JSON-Key.
|
||||||
-- @return #FLIGHTCONTROL self
|
-- @return #FLIGHTCONTROL self
|
||||||
function FLIGHTCONTROL:New(AirbaseName, Frequency, Modulation, PathToSRS, Port, GoogleKey)
|
function FLIGHTCONTROL:New(AirbaseName, Frequency, Modulation, PathToSRS, Port, GoogleKey)
|
||||||
|
|
||||||
@@ -570,7 +570,7 @@ end
|
|||||||
|
|
||||||
--- Set verbosity level.
|
--- Set verbosity level.
|
||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param #number VerbosityLevel Level of output (higher=more). Default 0.
|
-- @param #number VerbosityLevel (Optional) Level of output (higher=more). Default 0.
|
||||||
-- @return #FLIGHTCONTROL self
|
-- @return #FLIGHTCONTROL self
|
||||||
function FLIGHTCONTROL:SetVerbosity(VerbosityLevel)
|
function FLIGHTCONTROL:SetVerbosity(VerbosityLevel)
|
||||||
self.verbose=VerbosityLevel or 0
|
self.verbose=VerbosityLevel or 0
|
||||||
@@ -620,8 +620,8 @@ end
|
|||||||
|
|
||||||
--- Set the tower frequency.
|
--- Set the tower frequency.
|
||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param #number Frequency Frequency in MHz. Default 305 MHz.
|
-- @param #number Frequency (Optional) Frequency in MHz. Default 305 MHz.
|
||||||
-- @param #number Modulation Modulation `radio.modulation.AM`=0, `radio.modulation.FM`=1. Default `radio.modulation.AM`.
|
-- @param #number Modulation (Optional) Modulation `radio.modulation.AM`=0, `radio.modulation.FM`=1. Default `radio.modulation.AM`.
|
||||||
-- @return #FLIGHTCONTROL self
|
-- @return #FLIGHTCONTROL self
|
||||||
function FLIGHTCONTROL:SetFrequency(Frequency, Modulation)
|
function FLIGHTCONTROL:SetFrequency(Frequency, Modulation)
|
||||||
|
|
||||||
@@ -643,7 +643,7 @@ end
|
|||||||
|
|
||||||
--- Set the SRS server port.
|
--- Set the SRS server port.
|
||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param #number Port Port to be used. Defaults to 5002.
|
-- @param #number Port (Optional) Port to be used. Defaults to 5002.
|
||||||
-- @return #FLIGHTCONTROL self
|
-- @return #FLIGHTCONTROL self
|
||||||
function FLIGHTCONTROL:SetSRSPort(Port)
|
function FLIGHTCONTROL:SetSRSPort(Port)
|
||||||
self.Port = Port or 5002
|
self.Port = Port or 5002
|
||||||
@@ -653,13 +653,13 @@ end
|
|||||||
--- Set SRS options for a given MSRS object.
|
--- Set SRS options for a given MSRS object.
|
||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param Sound.SRS#MSRS msrs Moose SRS object.
|
-- @param Sound.SRS#MSRS msrs Moose SRS object.
|
||||||
-- @param #string Gender Gender: "male" or "female" (default).
|
-- @param #string Gender (Optional) Gender: "male" or "female" (default).
|
||||||
-- @param #string Culture Culture, e.g. "en-GB" (default).
|
-- @param #string Culture (Optional) Culture, e.g. "en-GB" (default).
|
||||||
-- @param #string Voice Specific voice. Overrides `Gender` and `Culture`.
|
-- @param #string Voice Specific voice. Overrides `Gender` and `Culture`.
|
||||||
-- @param #number Volume Volume. Default 1.0.
|
-- @param #number Volume (Optional) Volume. Default 1.0.
|
||||||
-- @param #string Label Name under which SRS transmits.
|
-- @param #string Label Name under which SRS transmits.
|
||||||
-- @param #string PathToGoogleCredentials Path to google credentials json file.
|
-- @param #string PathToGoogleCredentials (Optional) Path to google credentials json file.
|
||||||
-- @param #number Port Server port for SRS
|
-- @param #number Port (Optional) Server port for SRS. Defaults to 5002.
|
||||||
-- @return #FLIGHTCONTROL self
|
-- @return #FLIGHTCONTROL self
|
||||||
function FLIGHTCONTROL:_SetSRSOptions(msrs, Gender, Culture, Voice, Volume, Label, PathToGoogleCredentials, Port)
|
function FLIGHTCONTROL:_SetSRSOptions(msrs, Gender, Culture, Voice, Volume, Label, PathToGoogleCredentials, Port)
|
||||||
|
|
||||||
@@ -683,11 +683,11 @@ end
|
|||||||
|
|
||||||
--- Set SRS options for tower voice.
|
--- Set SRS options for tower voice.
|
||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param #string Gender Gender: "male" or "female" (default).
|
-- @param #string Gender (Optional) Gender: "male" or "female" (default).
|
||||||
-- @param #string Culture Culture, e.g. "en-GB" (default).
|
-- @param #string Culture (Optional) Culture, e.g. "en-GB" (default).
|
||||||
-- @param #string Voice Specific voice. Overrides `Gender` and `Culture`. See [Google Voices](https://cloud.google.com/text-to-speech/docs/voices).
|
-- @param #string Voice Specific voice. Overrides `Gender` and `Culture`. See [Google Voices](https://cloud.google.com/text-to-speech/docs/voices).
|
||||||
-- @param #number Volume Volume. Default 1.0.
|
-- @param #number Volume (Optional) Volume. Default 1.0.
|
||||||
-- @param #string Label Name under which SRS transmits. Default `self.alias`.
|
-- @param #string Label (Optional) Name under which SRS transmits. Default `self.alias`.
|
||||||
-- @return #FLIGHTCONTROL self
|
-- @return #FLIGHTCONTROL self
|
||||||
function FLIGHTCONTROL:SetSRSTower(Gender, Culture, Voice, Volume, Label)
|
function FLIGHTCONTROL:SetSRSTower(Gender, Culture, Voice, Volume, Label)
|
||||||
|
|
||||||
@@ -700,11 +700,11 @@ end
|
|||||||
|
|
||||||
--- Set SRS options for pilot voice.
|
--- Set SRS options for pilot voice.
|
||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param #string Gender Gender: "male" (default) or "female".
|
-- @param #string Gender (Optional) Gender: "male" (default) or "female".
|
||||||
-- @param #string Culture Culture, e.g. "en-US" (default).
|
-- @param #string Culture (Optional) Culture, e.g. "en-US" (default).
|
||||||
-- @param #string Voice Specific voice. Overrides `Gender` and `Culture`.
|
-- @param #string Voice Specific voice. Overrides `Gender` and `Culture`.
|
||||||
-- @param #number Volume Volume. Default 1.0.
|
-- @param #number Volume (Optional) Volume. Default 1.0.
|
||||||
-- @param #string Label Name under which SRS transmits. Default "Pilot".
|
-- @param #string Label (Optional) Name under which SRS transmits. Default "Pilot".
|
||||||
-- @return #FLIGHTCONTROL self
|
-- @return #FLIGHTCONTROL self
|
||||||
function FLIGHTCONTROL:SetSRSPilot(Gender, Culture, Voice, Volume, Label)
|
function FLIGHTCONTROL:SetSRSPilot(Gender, Culture, Voice, Volume, Label)
|
||||||
|
|
||||||
@@ -726,8 +726,8 @@ end
|
|||||||
-- in cases where simultaneous takeoffs and landings are unproblematic. Note that only because there are multiple runways, it does not mean the AI uses them.
|
-- in cases where simultaneous takeoffs and landings are unproblematic. Note that only because there are multiple runways, it does not mean the AI uses them.
|
||||||
--
|
--
|
||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param #number Nlanding Max number of aircraft landing simultaneously. Default 2.
|
-- @param #number Nlanding (Optional) Max number of aircraft landing simultaneously. Default 2.
|
||||||
-- @param #number Ntakeoff Allowed number of aircraft taking off for groups to get landing clearance. Default 0.
|
-- @param #number Ntakeoff (Optional) Allowed number of aircraft taking off for groups to get landing clearance. Default 0.
|
||||||
-- @return #FLIGHTCONTROL self
|
-- @return #FLIGHTCONTROL self
|
||||||
function FLIGHTCONTROL:SetLimitLanding(Nlanding, Ntakeoff)
|
function FLIGHTCONTROL:SetLimitLanding(Nlanding, Ntakeoff)
|
||||||
|
|
||||||
@@ -740,7 +740,7 @@ end
|
|||||||
|
|
||||||
--- Set time interval between landing clearance of groups.
|
--- Set time interval between landing clearance of groups.
|
||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param #number dt Time interval in seconds. Default 180 sec (3 min).
|
-- @param #number dt (Optional) Time interval in seconds. Default 180 sec (3 min).
|
||||||
-- @return #FLIGHTCONTROL self
|
-- @return #FLIGHTCONTROL self
|
||||||
function FLIGHTCONTROL:SetLandingInterval(dt)
|
function FLIGHTCONTROL:SetLandingInterval(dt)
|
||||||
|
|
||||||
@@ -763,9 +763,9 @@ end
|
|||||||
-- NOTE that human players are *not* restricted as they should behave better (hopefully) than the AI.
|
-- NOTE that human players are *not* restricted as they should behave better (hopefully) than the AI.
|
||||||
--
|
--
|
||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param #number Ntaxi Max number of groups allowed to taxi. Default 2.
|
-- @param #number Ntaxi (Optional) Max number of groups allowed to taxi. Default 2.
|
||||||
-- @param #boolean IncludeInbound If `true`, the above
|
-- @param #boolean IncludeInbound If `true`, the above
|
||||||
-- @param #number Nlanding Max number of landing flights. Default 0.
|
-- @param #number Nlanding (Optional) Max number of landing flights. Default 0.
|
||||||
-- @return #FLIGHTCONTROL self
|
-- @return #FLIGHTCONTROL self
|
||||||
function FLIGHTCONTROL:SetLimitTaxi(Ntaxi, IncludeInbound, Nlanding)
|
function FLIGHTCONTROL:SetLimitTaxi(Ntaxi, IncludeInbound, Nlanding)
|
||||||
|
|
||||||
@@ -783,10 +783,10 @@ end
|
|||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param Core.Zone#ZONE ArrivalZone Zone where planes arrive.
|
-- @param Core.Zone#ZONE ArrivalZone Zone where planes arrive.
|
||||||
-- @param #number Heading Heading in degrees.
|
-- @param #number Heading Heading in degrees.
|
||||||
-- @param #number Length Length in nautical miles. Default 15 NM.
|
-- @param #number Length (Optional) Length in nautical miles. Default 15 NM.
|
||||||
-- @param #number FlightlevelMin Min flight level. Default 5.
|
-- @param #number FlightlevelMin (Optional) Min flight level. Default 5.
|
||||||
-- @param #number FlightlevelMax Max flight level. Default 15.
|
-- @param #number FlightlevelMax (Optional) Max flight level. Default 15.
|
||||||
-- @param #number Prio Priority. Lower is higher. Default 50.
|
-- @param #number Prio (Optional) Priority. Lower is higher. Default 50.
|
||||||
-- @return #FLIGHTCONTROL.HoldingPattern Holding pattern table.
|
-- @return #FLIGHTCONTROL.HoldingPattern Holding pattern table.
|
||||||
function FLIGHTCONTROL:AddHoldingPattern(ArrivalZone, Heading, Length, FlightlevelMin, FlightlevelMax, Prio)
|
function FLIGHTCONTROL:AddHoldingPattern(ArrivalZone, Heading, Length, FlightlevelMin, FlightlevelMax, Prio)
|
||||||
|
|
||||||
@@ -946,7 +946,7 @@ end
|
|||||||
-- Note that this is the time, the DCS engine uses not something we can control on a user level or we could get via scripting.
|
-- Note that this is the time, the DCS engine uses not something we can control on a user level or we could get via scripting.
|
||||||
-- You need to input the value. On the DCS forum it was stated that this is currently one hour. Hence this is the default value.
|
-- You need to input the value. On the DCS forum it was stated that this is currently one hour. Hence this is the default value.
|
||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param #number RepairTime Time in seconds until the runway is repaired. Default 3600sec (one hour).
|
-- @param #number RepairTime (Optional) Time in seconds until the runway is repaired. Default 3600sec (one hour).
|
||||||
-- @return #FLIGHTCONTROL self
|
-- @return #FLIGHTCONTROL self
|
||||||
function FLIGHTCONTROL:SetRunwayRepairtime(RepairTime)
|
function FLIGHTCONTROL:SetRunwayRepairtime(RepairTime)
|
||||||
self.runwayrepairtime=RepairTime or 3600
|
self.runwayrepairtime=RepairTime or 3600
|
||||||
@@ -2020,7 +2020,7 @@ end
|
|||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param #string Status Return only flights in this flightcontrol status, e.g. `FLIGHTCONTROL.Status.XXX`.
|
-- @param #string Status Return only flights in this flightcontrol status, e.g. `FLIGHTCONTROL.Status.XXX`.
|
||||||
-- @param #string GroupStatus Return only flights in this FSM status, e.g. `OPSGROUP.GroupStatus.TAXIING`.
|
-- @param #string GroupStatus Return only flights in this FSM status, e.g. `OPSGROUP.GroupStatus.TAXIING`.
|
||||||
-- @param #boolean AI If `true` only AI flights are returned. If `false`, only flights with clients are returned. If `nil` (default), all flights are returned.
|
-- @param #boolean AI (Optional) If `true` only AI flights are returned. If `false`, only flights with clients are returned. If `nil` (default), all flights are returned.
|
||||||
-- @return #table Table of flights.
|
-- @return #table Table of flights.
|
||||||
function FLIGHTCONTROL:GetFlights(Status, GroupStatus, AI)
|
function FLIGHTCONTROL:GetFlights(Status, GroupStatus, AI)
|
||||||
|
|
||||||
@@ -2054,7 +2054,7 @@ end
|
|||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param #string Status Return only flights in this status.
|
-- @param #string Status Return only flights in this status.
|
||||||
-- @param #string GroupStatus Count only flights in this FSM status, e.g. `OPSGROUP.GroupStatus.TAXIING`.
|
-- @param #string GroupStatus Count only flights in this FSM status, e.g. `OPSGROUP.GroupStatus.TAXIING`.
|
||||||
-- @param #boolean AI If `true` only AI flights are counted. If `false`, only flights with clients are counted. If `nil` (default), all flights are counted.
|
-- @param #boolean AI (Optional) If `true` only AI flights are counted. If `false`, only flights with clients are counted. If `nil` (default), all flights are counted.
|
||||||
-- @return #number Number of flights.
|
-- @return #number Number of flights.
|
||||||
function FLIGHTCONTROL:CountFlights(Status, GroupStatus, AI)
|
function FLIGHTCONTROL:CountFlights(Status, GroupStatus, AI)
|
||||||
|
|
||||||
@@ -2101,7 +2101,7 @@ end
|
|||||||
|
|
||||||
--- Get the name of the active runway.
|
--- Get the name of the active runway.
|
||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param #boolean Takeoff If true, return takeoff runway name. Default is landing.
|
-- @param #boolean Takeoff (Optional) If true, return takeoff runway name. Default is landing.
|
||||||
-- @return #string Runway text, e.g. "31L" or "09".
|
-- @return #string Runway text, e.g. "31L" or "09".
|
||||||
function FLIGHTCONTROL:GetActiveRunwayText(Takeoff)
|
function FLIGHTCONTROL:GetActiveRunwayText(Takeoff)
|
||||||
|
|
||||||
@@ -2243,7 +2243,7 @@ end
|
|||||||
--- Set parking spot to RESERVED and update F10 marker.
|
--- Set parking spot to RESERVED and update F10 marker.
|
||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param Wrapper.Airbase#AIRBASE.ParkingSpot spot The parking spot data table.
|
-- @param Wrapper.Airbase#AIRBASE.ParkingSpot spot The parking spot data table.
|
||||||
-- @param #string unitname Name of the unit occupying the spot. Default "unknown".
|
-- @param #string unitname (Optional) Name of the unit occupying the spot. Default "unknown".
|
||||||
function FLIGHTCONTROL:SetParkingReserved(spot, unitname)
|
function FLIGHTCONTROL:SetParkingReserved(spot, unitname)
|
||||||
|
|
||||||
-- Get spot.
|
-- Get spot.
|
||||||
@@ -2263,7 +2263,7 @@ end
|
|||||||
--- Set parking spot to OCCUPIED and update F10 marker.
|
--- Set parking spot to OCCUPIED and update F10 marker.
|
||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param Wrapper.Airbase#AIRBASE.ParkingSpot spot The parking spot data table.
|
-- @param Wrapper.Airbase#AIRBASE.ParkingSpot spot The parking spot data table.
|
||||||
-- @param #string unitname Name of the unit occupying the spot. Default "unknown".
|
-- @param #string unitname (Optional) Name of the unit occupying the spot. Default "unknown".
|
||||||
function FLIGHTCONTROL:SetParkingOccupied(spot, unitname)
|
function FLIGHTCONTROL:SetParkingOccupied(spot, unitname)
|
||||||
|
|
||||||
-- Get spot.
|
-- Get spot.
|
||||||
@@ -4351,7 +4351,7 @@ end
|
|||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param #string Text The text to transmit.
|
-- @param #string Text The text to transmit.
|
||||||
-- @param Ops.FlightGroup#FLIGHTGROUP Flight The flight.
|
-- @param Ops.FlightGroup#FLIGHTGROUP Flight The flight.
|
||||||
-- @param #number Delay Delay in seconds before the text is transmitted. Default 0 sec.
|
-- @param #number Delay (Optional) Delay in seconds before the text is transmitted. Default 0 sec.
|
||||||
function FLIGHTCONTROL:TransmissionTower(Text, Flight, Delay)
|
function FLIGHTCONTROL:TransmissionTower(Text, Flight, Delay)
|
||||||
|
|
||||||
if self.radioOnlyIfPlayers==true and self.Nplayers==0 then
|
if self.radioOnlyIfPlayers==true and self.Nplayers==0 then
|
||||||
@@ -4387,7 +4387,7 @@ end
|
|||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param #string Text The text to transmit.
|
-- @param #string Text The text to transmit.
|
||||||
-- @param Ops.FlightGroup#FLIGHTGROUP Flight The flight.
|
-- @param Ops.FlightGroup#FLIGHTGROUP Flight The flight.
|
||||||
-- @param #number Delay Delay in seconds before the text is transmitted. Default 0 sec.
|
-- @param #number Delay (Optional) Delay in seconds before the text is transmitted. Default 0 sec.
|
||||||
function FLIGHTCONTROL:TransmissionPilot(Text, Flight, Delay)
|
function FLIGHTCONTROL:TransmissionPilot(Text, Flight, Delay)
|
||||||
|
|
||||||
if self.radioOnlyIfPlayers==true and self.Nplayers==0 then
|
if self.radioOnlyIfPlayers==true and self.Nplayers==0 then
|
||||||
@@ -4445,9 +4445,9 @@ end
|
|||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param #string Text The text to transmit.
|
-- @param #string Text The text to transmit.
|
||||||
-- @param Ops.FlightGroup#FLIGHTGROUP Flight The flight.
|
-- @param Ops.FlightGroup#FLIGHTGROUP Flight The flight.
|
||||||
-- @param #number Duration Duration in seconds. Default 5.
|
-- @param #number Duration (Optional) Duration in seconds. Default 5.
|
||||||
-- @param #boolean Clear Clear screen.
|
-- @param #boolean Clear Clear screen.
|
||||||
-- @param #number Delay Delay in seconds before the text is transmitted. Default 0 sec.
|
-- @param #number Delay (Optional) Delay in seconds before the text is transmitted. Default 0 sec.
|
||||||
function FLIGHTCONTROL:TextMessageToFlight(Text, Flight, Duration, Clear, Delay)
|
function FLIGHTCONTROL:TextMessageToFlight(Text, Flight, Duration, Clear, Delay)
|
||||||
|
|
||||||
if Delay and Delay>0 then
|
if Delay and Delay>0 then
|
||||||
@@ -4591,8 +4591,8 @@ end
|
|||||||
|
|
||||||
--- [User] Set callsign options for TTS output. See @{Wrapper.Group#GROUP.GetCustomCallSign}() on how to set customized callsigns.
|
--- [User] Set callsign options for TTS output. See @{Wrapper.Group#GROUP.GetCustomCallSign}() on how to set customized callsigns.
|
||||||
-- @param #FLIGHTCONTROL self
|
-- @param #FLIGHTCONTROL self
|
||||||
-- @param #boolean ShortCallsign If true, only call out the major flight number. Default = `true`.
|
-- @param #boolean ShortCallsign (Optional) If true, only call out the major flight number. Default = `true`.
|
||||||
-- @param #boolean Keepnumber If true, keep the **customized callsign** in the #GROUP name for players as-is, no amendments or numbers. Default = `true`.
|
-- @param #boolean Keepnumber (Optional) If true, keep the **customized callsign** in the #GROUP name for players as-is, no amendments or numbers. Default = `true`.
|
||||||
-- @param #table CallsignTranslations (optional) Table to translate between DCS standard callsigns and bespoke ones. Does not apply if using customized
|
-- @param #table CallsignTranslations (optional) Table to translate between DCS standard callsigns and bespoke ones. Does not apply if using customized
|
||||||
-- callsigns from playername or group name.
|
-- callsigns from playername or group name.
|
||||||
-- @return #FLIGHTCONTROL self
|
-- @return #FLIGHTCONTROL self
|
||||||
|
|||||||
@@ -837,7 +837,7 @@ end
|
|||||||
--- Set if group is ready for taxi/takeoff if controlled by a `FLIGHTCONTROL`.
|
--- Set if group is ready for taxi/takeoff if controlled by a `FLIGHTCONTROL`.
|
||||||
-- @param #FLIGHTGROUP self
|
-- @param #FLIGHTGROUP self
|
||||||
-- @param #boolean ReadyTO If `true`, flight is ready for takeoff.
|
-- @param #boolean ReadyTO If `true`, flight is ready for takeoff.
|
||||||
-- @param #number Delay Delay in seconds before value is set. Default 0 sec.
|
-- @param #number Delay (Optional) Delay in seconds before value is set. Default 0 sec.
|
||||||
-- @return #FLIGHTGROUP self
|
-- @return #FLIGHTGROUP self
|
||||||
function FLIGHTGROUP:SetReadyForTakeoff(ReadyTO, Delay)
|
function FLIGHTGROUP:SetReadyForTakeoff(ReadyTO, Delay)
|
||||||
if Delay and Delay>0 then
|
if Delay and Delay>0 then
|
||||||
@@ -922,7 +922,7 @@ end
|
|||||||
|
|
||||||
--- Set low fuel threshold. Triggers event "FuelLow" and calls event function "OnAfterFuelLow".
|
--- Set low fuel threshold. Triggers event "FuelLow" and calls event function "OnAfterFuelLow".
|
||||||
-- @param #FLIGHTGROUP self
|
-- @param #FLIGHTGROUP self
|
||||||
-- @param #number threshold Fuel threshold in percent. Default 25 %.
|
-- @param #number threshold (Optional) Fuel threshold in percent. Default 25 %.
|
||||||
-- @return #FLIGHTGROUP self
|
-- @return #FLIGHTGROUP self
|
||||||
function FLIGHTGROUP:SetFuelLowThreshold(threshold)
|
function FLIGHTGROUP:SetFuelLowThreshold(threshold)
|
||||||
self.fuellowthresh=threshold or 25
|
self.fuellowthresh=threshold or 25
|
||||||
@@ -983,7 +983,7 @@ end
|
|||||||
|
|
||||||
--- Set fuel critical threshold. Triggers event "FuelCritical" and event function "OnAfterFuelCritical".
|
--- Set fuel critical threshold. Triggers event "FuelCritical" and event function "OnAfterFuelCritical".
|
||||||
-- @param #FLIGHTGROUP self
|
-- @param #FLIGHTGROUP self
|
||||||
-- @param #number threshold Fuel threshold in percent. Default 10 %.
|
-- @param #number threshold (Optional) Fuel threshold in percent. Default 10 %.
|
||||||
-- @return #FLIGHTGROUP self
|
-- @return #FLIGHTGROUP self
|
||||||
function FLIGHTGROUP:SetFuelCriticalThreshold(threshold)
|
function FLIGHTGROUP:SetFuelCriticalThreshold(threshold)
|
||||||
self.fuelcriticalthresh=threshold or 10
|
self.fuelcriticalthresh=threshold or 10
|
||||||
@@ -2629,8 +2629,8 @@ end
|
|||||||
-- @param #string From From state.
|
-- @param #string From From state.
|
||||||
-- @param #string Event Event.
|
-- @param #string Event Event.
|
||||||
-- @param #string To To state.
|
-- @param #string To To state.
|
||||||
-- @param #number n Next waypoint index. Default is the one coming after that one that has been passed last.
|
-- @param #number n (Optional) Next waypoint index. Default is the one coming after that one that has been passed last.
|
||||||
-- @param #number N Waypoint Max waypoint index to be included in the route. Default is the final waypoint.
|
-- @param #number N(Optional) Waypoint Max waypoint index to be included in the route. Default is the final waypoint.
|
||||||
-- @return #boolean Transision allowed?
|
-- @return #boolean Transision allowed?
|
||||||
function FLIGHTGROUP:onbeforeUpdateRoute(From, Event, To, n, N)
|
function FLIGHTGROUP:onbeforeUpdateRoute(From, Event, To, n, N)
|
||||||
|
|
||||||
@@ -2752,8 +2752,8 @@ end
|
|||||||
-- @param #string From From state.
|
-- @param #string From From state.
|
||||||
-- @param #string Event Event.
|
-- @param #string Event Event.
|
||||||
-- @param #string To To state.
|
-- @param #string To To state.
|
||||||
-- @param #number n Next waypoint index. Default is the one coming after that one that has been passed last.
|
-- @param #number n (Optional) Next waypoint index. Default is the one coming after that one that has been passed last.
|
||||||
-- @param #number N Waypoint Max waypoint index to be included in the route. Default is the final waypoint.
|
-- @param #number N (Optional) Waypoint Max waypoint index to be included in the route. Default is the final waypoint.
|
||||||
function FLIGHTGROUP:onafterUpdateRoute(From, Event, To, n, N)
|
function FLIGHTGROUP:onafterUpdateRoute(From, Event, To, n, N)
|
||||||
|
|
||||||
-- Update route from this waypoint number onwards.
|
-- Update route from this waypoint number onwards.
|
||||||
@@ -3100,9 +3100,9 @@ end
|
|||||||
-- @param #string Event Event.
|
-- @param #string Event Event.
|
||||||
-- @param #string To To state.
|
-- @param #string To To state.
|
||||||
-- @param Wrapper.Airbase#AIRBASE airbase The airbase to hold at.
|
-- @param Wrapper.Airbase#AIRBASE airbase The airbase to hold at.
|
||||||
-- @param #number SpeedTo Speed used for traveling from current position to holding point in knots. Default 75% of max speed.
|
-- @param #number SpeedTo (Optional) Speed used for traveling from current position to holding point in knots. Default 75% of max speed.
|
||||||
-- @param #number SpeedHold Holding speed in knots. Default 250 kts.
|
-- @param #number SpeedHold (Optional) Holding speed in knots. Default 250 kts.
|
||||||
-- @param #number SpeedLand Landing speed in knots. Default 170 kts.
|
-- @param #number SpeedLand (Optional) Landing speed in knots. Default 170 kts.
|
||||||
function FLIGHTGROUP:onafterRTB(From, Event, To, airbase, SpeedTo, SpeedHold, SpeedLand)
|
function FLIGHTGROUP:onafterRTB(From, Event, To, airbase, SpeedTo, SpeedHold, SpeedLand)
|
||||||
|
|
||||||
-- Debug info.
|
-- Debug info.
|
||||||
@@ -3195,9 +3195,9 @@ end
|
|||||||
--- Land at an airbase.
|
--- Land at an airbase.
|
||||||
-- @param #FLIGHTGROUP self
|
-- @param #FLIGHTGROUP self
|
||||||
-- @param Wrapper.Airbase#AIRBASE airbase Airbase where the group shall land.
|
-- @param Wrapper.Airbase#AIRBASE airbase Airbase where the group shall land.
|
||||||
-- @param #number SpeedTo Speed used for travelling from current position to holding point in knots.
|
-- @param #number (Optional) SpeedTo Speed used for travelling from current position to holding point in knots. Defaults to speedCruise.
|
||||||
-- @param #number SpeedHold Holding speed in knots.
|
-- @param #number (Optional) SpeedHold Holding speed in knots. Defaults to 250kts.
|
||||||
-- @param #number SpeedLand Landing speed in knots. Default 170 kts.
|
-- @param #number (Optional) SpeedLand Landing speed in knots. Default 170 kts.
|
||||||
function FLIGHTGROUP:_LandAtAirbase(airbase, SpeedTo, SpeedHold, SpeedLand)
|
function FLIGHTGROUP:_LandAtAirbase(airbase, SpeedTo, SpeedHold, SpeedLand)
|
||||||
|
|
||||||
-- Set current airbase.
|
-- Set current airbase.
|
||||||
@@ -3381,9 +3381,9 @@ end
|
|||||||
-- @param #string From From state.
|
-- @param #string From From state.
|
||||||
-- @param #string Event Event.
|
-- @param #string Event Event.
|
||||||
-- @param #string To To state.
|
-- @param #string To To state.
|
||||||
-- @param #number Duration Duration how long the group will be waiting in seconds. Default `nil` (=forever).
|
-- @param #number Duration (Optional) Duration how long the group will be waiting in seconds. Default `nil` (=forever).
|
||||||
-- @param #number Altitude Altitude in feet. Default 10,000 ft for airplanes and 1,000 feet for helos.
|
-- @param #number Altitude (Optional) Altitude in feet. Default 10,000 ft for airplanes and 1,000 feet for helos.
|
||||||
-- @param #number Speed Speed in knots. Default 250 kts for airplanes and 20 kts for helos.
|
-- @param #number Speed (Optional) Speed in knots. Default 250 kts for airplanes and 20 kts for helos.
|
||||||
function FLIGHTGROUP:onbeforeWait(From, Event, To, Duration, Altitude, Speed)
|
function FLIGHTGROUP:onbeforeWait(From, Event, To, Duration, Altitude, Speed)
|
||||||
|
|
||||||
local allowed=true
|
local allowed=true
|
||||||
@@ -3417,9 +3417,9 @@ end
|
|||||||
-- @param #string From From state.
|
-- @param #string From From state.
|
||||||
-- @param #string Event Event.
|
-- @param #string Event Event.
|
||||||
-- @param #string To To state.
|
-- @param #string To To state.
|
||||||
-- @param #number Duration Duration how long the group will be waiting in seconds. Default `nil` (=forever).
|
-- @param #number Duration (Optional) Duration how long the group will be waiting in seconds. Default `nil` (=forever).
|
||||||
-- @param #number Altitude Altitude in feet. Default 10,000 ft for airplanes and 1,000 feet for helos.
|
-- @param #number Altitude (Optional) Altitude in feet. Default 10,000 ft for airplanes and 1,000 feet for helos.
|
||||||
-- @param #number Speed Speed in knots. Default 250 kts for airplanes and 20 kts for helos.
|
-- @param #number Speed (Optional) Speed in knots. Default 250 kts for airplanes and 20 kts for helos.
|
||||||
function FLIGHTGROUP:onafterWait(From, Event, To, Duration, Altitude, Speed)
|
function FLIGHTGROUP:onafterWait(From, Event, To, Duration, Altitude, Speed)
|
||||||
|
|
||||||
-- Group will orbit at its current position.
|
-- Group will orbit at its current position.
|
||||||
@@ -3696,8 +3696,8 @@ end
|
|||||||
-- @param #string From From state.
|
-- @param #string From From state.
|
||||||
-- @param #string Event Event.
|
-- @param #string Event Event.
|
||||||
-- @param #string To To state.
|
-- @param #string To To state.
|
||||||
-- @param Core.Point#COORDINATE Coordinate The coordinate where to land. Default is current position.
|
-- @param Core.Point#COORDINATE (Optional) Coordinate The coordinate where to land. Default is current position.
|
||||||
-- @param #number Duration The duration in seconds to remain on ground. Default 600 sec (10 min).
|
-- @param #number Duration (Optional) The duration in seconds to remain on ground. Default 600 sec (10 min).
|
||||||
function FLIGHTGROUP:onbeforeLandAt(From, Event, To, Coordinate, Duration)
|
function FLIGHTGROUP:onbeforeLandAt(From, Event, To, Coordinate, Duration)
|
||||||
return self.isHelo
|
return self.isHelo
|
||||||
end
|
end
|
||||||
@@ -3707,8 +3707,8 @@ end
|
|||||||
-- @param #string From From state.
|
-- @param #string From From state.
|
||||||
-- @param #string Event Event.
|
-- @param #string Event Event.
|
||||||
-- @param #string To To state.
|
-- @param #string To To state.
|
||||||
-- @param Core.Point#COORDINATE Coordinate The coordinate where to land. Default is current position.
|
-- @param Core.Point#COORDINATE (Optional) Coordinate The coordinate where to land. Default is current position.
|
||||||
-- @param #number Duration The duration in seconds to remain on ground. Default `nil` = forever.
|
-- @param #number Duration (Optional) The duration in seconds to remain on ground. Default `nil` = forever.
|
||||||
function FLIGHTGROUP:onafterLandAt(From, Event, To, Coordinate, Duration)
|
function FLIGHTGROUP:onafterLandAt(From, Event, To, Coordinate, Duration)
|
||||||
|
|
||||||
-- Duration.
|
-- Duration.
|
||||||
@@ -3879,8 +3879,8 @@ end
|
|||||||
|
|
||||||
--- Initialize group parameters. Also initializes waypoints if self.waypoints is nil.
|
--- Initialize group parameters. Also initializes waypoints if self.waypoints is nil.
|
||||||
-- @param #FLIGHTGROUP self
|
-- @param #FLIGHTGROUP self
|
||||||
-- @param #table Template Template used to init the group. Default is `self.template`.
|
-- @param #table Template (Optional) Template used to init the group. Default is `self.template`.
|
||||||
-- @param #number Delay Delay in seconds before group is initialized. Default `nil`, *i.e.* instantaneous.
|
-- @param #number Delay (Optional) Delay in seconds before group is initialized. Default `nil`, *i.e.* instantaneous.
|
||||||
-- @return #FLIGHTGROUP self
|
-- @return #FLIGHTGROUP self
|
||||||
function FLIGHTGROUP:_InitGroup(Template, Delay)
|
function FLIGHTGROUP:_InitGroup(Template, Delay)
|
||||||
|
|
||||||
@@ -4040,7 +4040,7 @@ end
|
|||||||
|
|
||||||
--- Find the nearest friendly airbase (same or neutral coalition).
|
--- Find the nearest friendly airbase (same or neutral coalition).
|
||||||
-- @param #FLIGHTGROUP self
|
-- @param #FLIGHTGROUP self
|
||||||
-- @param #number Radius Search radius in NM. Default 50 NM.
|
-- @param #number Radius (Optional) Search radius in NM. Default 50 NM.
|
||||||
-- @return Wrapper.Airbase#AIRBASE Closest tanker group #nil.
|
-- @return Wrapper.Airbase#AIRBASE Closest tanker group #nil.
|
||||||
function FLIGHTGROUP:FindNearestAirbase(Radius)
|
function FLIGHTGROUP:FindNearestAirbase(Radius)
|
||||||
|
|
||||||
@@ -4075,7 +4075,7 @@ end
|
|||||||
|
|
||||||
--- Find the nearest tanker.
|
--- Find the nearest tanker.
|
||||||
-- @param #FLIGHTGROUP self
|
-- @param #FLIGHTGROUP self
|
||||||
-- @param #number Radius Search radius in NM. Default 50 NM.
|
-- @param #number Radius (Optional) Search radius in NM. Default 50 NM.
|
||||||
-- @return Wrapper.Group#GROUP Closest tanker group or `nil` if no tanker is in the given radius.
|
-- @return Wrapper.Group#GROUP Closest tanker group or `nil` if no tanker is in the given radius.
|
||||||
function FLIGHTGROUP:FindNearestTanker(Radius)
|
function FLIGHTGROUP:FindNearestTanker(Radius)
|
||||||
|
|
||||||
@@ -4226,7 +4226,7 @@ end
|
|||||||
|
|
||||||
--- Check if the final waypoint is in the air.
|
--- Check if the final waypoint is in the air.
|
||||||
-- @param #FLIGHTGROUP self
|
-- @param #FLIGHTGROUP self
|
||||||
-- @param #table wp Waypoint. Default final waypoint.
|
-- @param #table wp (Optional) Waypoint. Default final waypoint.
|
||||||
-- @return #boolean If `true` final waypoint is a turning or flyover but not a landing type waypoint.
|
-- @return #boolean If `true` final waypoint is a turning or flyover but not a landing type waypoint.
|
||||||
function FLIGHTGROUP:IsLandingAir(wp)
|
function FLIGHTGROUP:IsLandingAir(wp)
|
||||||
|
|
||||||
@@ -4247,7 +4247,7 @@ end
|
|||||||
|
|
||||||
--- Check if the final waypoint is at an airbase.
|
--- Check if the final waypoint is at an airbase.
|
||||||
-- @param #FLIGHTGROUP self
|
-- @param #FLIGHTGROUP self
|
||||||
-- @param #table wp Waypoint. Default final waypoint.
|
-- @param #table wp (Optional) Waypoint. Default final waypoint.
|
||||||
-- @return #boolean If `true`, final waypoint is a landing waypoint at an airbase.
|
-- @return #boolean If `true`, final waypoint is a landing waypoint at an airbase.
|
||||||
function FLIGHTGROUP:IsLandingAirbase(wp)
|
function FLIGHTGROUP:IsLandingAirbase(wp)
|
||||||
|
|
||||||
@@ -4270,10 +4270,10 @@ end
|
|||||||
--- Add an AIR waypoint to the flight plan.
|
--- Add an AIR waypoint to the flight plan.
|
||||||
-- @param #FLIGHTGROUP self
|
-- @param #FLIGHTGROUP self
|
||||||
-- @param Core.Point#COORDINATE Coordinate The coordinate of the waypoint. Use COORDINATE:SetAltitude(altitude) to define the altitude.
|
-- @param Core.Point#COORDINATE Coordinate The coordinate of the waypoint. Use COORDINATE:SetAltitude(altitude) to define the altitude.
|
||||||
-- @param #number Speed Speed in knots. Default is cruise speed.
|
-- @param #number Speed (Optional) Speed in knots. Default is cruise speed.
|
||||||
-- @param #number AfterWaypointWithID Insert waypoint after waypoint given ID. Default is to insert as last waypoint.
|
-- @param #number AfterWaypointWithID (Optional) Insert waypoint after waypoint given ID. Default is to insert as last waypoint.
|
||||||
-- @param #number Altitude Altitude in feet. Default is y-component of Coordinate. Note that these altitudes are wrt to sea level (barometric altitude).
|
-- @param #number Altitude (Optional) Altitude in feet. Default is y-component of Coordinate. Note that these altitudes are wrt to sea level (barometric altitude).
|
||||||
-- @param #boolean Updateroute If true or nil, call UpdateRoute. If false, no call.
|
-- @param #boolean Updateroute (Optional) If true or nil, call UpdateRoute. If false, no call.
|
||||||
-- @return Ops.OpsGroup#OPSGROUP.Waypoint Waypoint table.
|
-- @return Ops.OpsGroup#OPSGROUP.Waypoint Waypoint table.
|
||||||
function FLIGHTGROUP:AddWaypoint(Coordinate, Speed, AfterWaypointWithID, Altitude, Updateroute)
|
function FLIGHTGROUP:AddWaypoint(Coordinate, Speed, AfterWaypointWithID, Altitude, Updateroute)
|
||||||
|
|
||||||
@@ -4323,10 +4323,10 @@ end
|
|||||||
--- Add an LANDING waypoint to the flight plan.
|
--- Add an LANDING waypoint to the flight plan.
|
||||||
-- @param #FLIGHTGROUP self
|
-- @param #FLIGHTGROUP self
|
||||||
-- @param Wrapper.Airbase#AIRBASE Airbase The airbase where the group should land.
|
-- @param Wrapper.Airbase#AIRBASE Airbase The airbase where the group should land.
|
||||||
-- @param #number Speed Speed in knots. Default 350 kts.
|
-- @param #number Speed (Optional) Speed in knots. Default 350 kts.
|
||||||
-- @param #number AfterWaypointWithID Insert waypoint after waypoint given ID. Default is to insert as last waypoint.
|
-- @param #number AfterWaypointWithID (Optional) Insert waypoint after waypoint given ID. Default is to insert as last waypoint.
|
||||||
-- @param #number Altitude Altitude in feet. Default is y-component of Coordinate. Note that these altitudes are wrt to sea level (barometric altitude).
|
-- @param #number Altitude (Optional) Altitude in feet. Default is y-component of Coordinate. Note that these altitudes are wrt to sea level (barometric altitude).
|
||||||
-- @param #boolean Updateroute If true or nil, call UpdateRoute. If false, no call.
|
-- @param #boolean Updateroute (Optional) If true or nil, call UpdateRoute. If false, no call.
|
||||||
-- @return Ops.OpsGroup#OPSGROUP.Waypoint Waypoint table.
|
-- @return Ops.OpsGroup#OPSGROUP.Waypoint Waypoint table.
|
||||||
function FLIGHTGROUP:AddWaypointLanding(Airbase, Speed, AfterWaypointWithID, Altitude, Updateroute)
|
function FLIGHTGROUP:AddWaypointLanding(Airbase, Speed, AfterWaypointWithID, Altitude, Updateroute)
|
||||||
|
|
||||||
@@ -4541,7 +4541,7 @@ end
|
|||||||
--- Returns the parking spot of the element.
|
--- Returns the parking spot of the element.
|
||||||
-- @param #FLIGHTGROUP self
|
-- @param #FLIGHTGROUP self
|
||||||
-- @param Ops.OpsGroup#OPSGROUP.Element element Element of the flight group.
|
-- @param Ops.OpsGroup#OPSGROUP.Element element Element of the flight group.
|
||||||
-- @param #number maxdist Distance threshold in meters. Default 5 m.
|
-- @param #number maxdist (Optional) Distance threshold in meters. Default 5 m.
|
||||||
-- @param Wrapper.Airbase#AIRBASE airbase (Optional) The airbase to check for parking. Default is closest airbase to the element.
|
-- @param Wrapper.Airbase#AIRBASE airbase (Optional) The airbase to check for parking. Default is closest airbase to the element.
|
||||||
-- @return Wrapper.Airbase#AIRBASE.ParkingSpot Parking spot or nil if no spot is within distance threshold.
|
-- @return Wrapper.Airbase#AIRBASE.ParkingSpot Parking spot or nil if no spot is within distance threshold.
|
||||||
function FLIGHTGROUP:GetParkingSpot(element, maxdist, airbase)
|
function FLIGHTGROUP:GetParkingSpot(element, maxdist, airbase)
|
||||||
|
|||||||
@@ -56,7 +56,7 @@ FLOTILLA.version="0.1.0"
|
|||||||
--- Create a new FLOTILLA object and start the FSM.
|
--- Create a new FLOTILLA object and start the FSM.
|
||||||
-- @param #FLOTILLA self
|
-- @param #FLOTILLA self
|
||||||
-- @param #string TemplateGroupName Name of the template group.
|
-- @param #string TemplateGroupName Name of the template group.
|
||||||
-- @param #number Ngroups Number of asset groups of this flotilla. Default 3.
|
-- @param #number Ngroups (Optional) Number of asset groups of this flotilla. Default 3.
|
||||||
-- @param #string FlotillaName Name of the flotilla. Must be **unique**!
|
-- @param #string FlotillaName Name of the flotilla. Must be **unique**!
|
||||||
-- @return #FLOTILLA self
|
-- @return #FLOTILLA self
|
||||||
function FLOTILLA:New(TemplateGroupName, Ngroups, FlotillaName)
|
function FLOTILLA:New(TemplateGroupName, Ngroups, FlotillaName)
|
||||||
|
|||||||
@@ -411,8 +411,8 @@ end
|
|||||||
|
|
||||||
--- Set to accept accoustic detection.
|
--- Set to accept accoustic detection.
|
||||||
-- @param #INTEL self
|
-- @param #INTEL self
|
||||||
-- @param #number Radius Radius in which we can "hear" units. Defaults to 1000 meters.
|
-- @param #number Radius (Optional) Radius in which we can "hear" units. Defaults to 1000 meters.
|
||||||
-- @param #table UnitCategories Set what Unit Categories we can "hear". Defaults to `{Unit.Category.GROUND_UNIT,Unit.Category.HELICOPTER}`
|
-- @param #table UnitCategories(Optional) Set what Unit Categories we can "hear". Defaults to `{Unit.Category.GROUND_UNIT,Unit.Category.HELICOPTER}`
|
||||||
-- @return #INTEL self
|
-- @return #INTEL self
|
||||||
function INTEL:SetAccousticDetectionOn(Radius,UnitCategories)
|
function INTEL:SetAccousticDetectionOn(Radius,UnitCategories)
|
||||||
self.DetectAccoustic = true
|
self.DetectAccoustic = true
|
||||||
@@ -572,7 +572,7 @@ end
|
|||||||
-- Previously known contacts that are not detected any more, are "lost" after this time.
|
-- Previously known contacts that are not detected any more, are "lost" after this time.
|
||||||
-- This avoids fast oscillations between a contact being detected and undetected.
|
-- This avoids fast oscillations between a contact being detected and undetected.
|
||||||
-- @param #INTEL self
|
-- @param #INTEL self
|
||||||
-- @param #number TimeInterval Time interval in seconds. Default is 120 sec.
|
-- @param #number TimeInterval (Optional) Time interval in seconds. Default is 120 sec.
|
||||||
-- @return #INTEL self
|
-- @return #INTEL self
|
||||||
function INTEL:SetForgetTime(TimeInterval)
|
function INTEL:SetForgetTime(TimeInterval)
|
||||||
return self
|
return self
|
||||||
@@ -607,10 +607,10 @@ end
|
|||||||
|
|
||||||
--- Method to make the radar detection less accurate, e.g. for WWII scenarios.
|
--- Method to make the radar detection less accurate, e.g. for WWII scenarios.
|
||||||
-- @param #INTEL self
|
-- @param #INTEL self
|
||||||
-- @param #number minheight Minimum flight height to be detected, in meters AGL (above ground)
|
-- @param #number minheight (Optional) Minimum flight height to be detected, in meters AGL (above ground). Defaults to 250m.
|
||||||
-- @param #number thresheight Threshold to escape the radar if flying below minheight, defaults to 90 (90% escape chance)
|
-- @param #number thresheight (Optional) Threshold to escape the radar if flying below minheight, defaults to 90 (90% escape chance)
|
||||||
-- @param #number thresblur Threshold to be detected by the radar overall, defaults to 85 (85% chance to be found)
|
-- @param #number thresblur (Optional) Threshold to be detected by the radar overall, defaults to 85 (85% chance to be found)
|
||||||
-- @param #number closing Closing-in in km - the limit of km from which on it becomes increasingly difficult to escape radar detection if flying towards the radar position. Should be about 1/3 of the radar detection radius in kilometers, defaults to 20.
|
-- @param #number closing (Optional) Closing-in in km - the limit of km from which on it becomes increasingly difficult to escape radar detection if flying towards the radar position. Should be about 1/3 of the radar detection radius in kilometers, defaults to 20.
|
||||||
-- @return #INTEL self
|
-- @return #INTEL self
|
||||||
function INTEL:SetRadarBlur(minheight,thresheight,thresblur,closing)
|
function INTEL:SetRadarBlur(minheight,thresheight,thresblur,closing)
|
||||||
self.RadarBlur = true
|
self.RadarBlur = true
|
||||||
@@ -737,7 +737,7 @@ end
|
|||||||
|
|
||||||
--- Change radius of the Clusters.
|
--- Change radius of the Clusters.
|
||||||
-- @param #INTEL self
|
-- @param #INTEL self
|
||||||
-- @param #number radius The radius of the clusters in kilometers. Default 15 km.
|
-- @param #number radius (Optional) The radius of the clusters in kilometers. Default 15 km.
|
||||||
-- @return #INTEL self
|
-- @return #INTEL self
|
||||||
function INTEL:SetClusterRadius(radius)
|
function INTEL:SetClusterRadius(radius)
|
||||||
self.clusterradius = (radius or 15)*1000
|
self.clusterradius = (radius or 15)*1000
|
||||||
@@ -1445,7 +1445,7 @@ end
|
|||||||
-- @param #INTEL self
|
-- @param #INTEL self
|
||||||
-- @param Wrapper.Positionable#POSITIONABLE Positionable Group or static object.
|
-- @param Wrapper.Positionable#POSITIONABLE Positionable Group or static object.
|
||||||
-- @param #string RecceName Name of the recce group that detected this object.
|
-- @param #string RecceName Name of the recce group that detected this object.
|
||||||
-- @param #number Tdetected Abs. mission time in seconds, when the object is detected. Default now.
|
-- @param #number Tdetected (Optional) Abs. mission time in seconds, when the object is detected. Default now.
|
||||||
-- @return #INTEL self
|
-- @return #INTEL self
|
||||||
function INTEL:KnowObject(Positionable, RecceName, Tdetected)
|
function INTEL:KnowObject(Positionable, RecceName, Tdetected)
|
||||||
|
|
||||||
@@ -2016,7 +2016,7 @@ end
|
|||||||
--- Calculate cluster future position after given seconds.
|
--- Calculate cluster future position after given seconds.
|
||||||
-- @param #INTEL self
|
-- @param #INTEL self
|
||||||
-- @param #INTEL.Cluster cluster The cluster of contacts.
|
-- @param #INTEL.Cluster cluster The cluster of contacts.
|
||||||
-- @param #number seconds Time interval in seconds. Default is `self.prediction`.
|
-- @param #number seconds (Optional) Time interval in seconds. Default is `self.prediction`.
|
||||||
-- @return Core.Point#COORDINATE Calculated future position of the cluster.
|
-- @return Core.Point#COORDINATE Calculated future position of the cluster.
|
||||||
function INTEL:CalcClusterFuturePosition(cluster, seconds)
|
function INTEL:CalcClusterFuturePosition(cluster, seconds)
|
||||||
|
|
||||||
@@ -2258,7 +2258,7 @@ end
|
|||||||
--- Get the coordinate of a cluster.
|
--- Get the coordinate of a cluster.
|
||||||
-- @param #INTEL self
|
-- @param #INTEL self
|
||||||
-- @param #INTEL.Cluster Cluster The cluster.
|
-- @param #INTEL.Cluster Cluster The cluster.
|
||||||
-- @param #boolean Update If `true`, update the coordinate. Default is to just return the last stored position.
|
-- @param #boolean Update (Optional) If `true`, update the coordinate. Default is to just return the last stored position.
|
||||||
-- @return Core.Point#COORDINATE The coordinate of this cluster.
|
-- @return Core.Point#COORDINATE The coordinate of this cluster.
|
||||||
function INTEL:GetClusterCoordinate(Cluster, Update)
|
function INTEL:GetClusterCoordinate(Cluster, Update)
|
||||||
|
|
||||||
@@ -2309,8 +2309,8 @@ end
|
|||||||
--- Check if the coordindate of the cluster changed.
|
--- Check if the coordindate of the cluster changed.
|
||||||
-- @param #INTEL self
|
-- @param #INTEL self
|
||||||
-- @param #INTEL.Cluster Cluster The cluster.
|
-- @param #INTEL.Cluster Cluster The cluster.
|
||||||
-- @param #number Threshold in meters. Default 100 m.
|
-- @param #number (Optional) Threshold in meters. Default 100 m.
|
||||||
-- @param Core.Point#COORDINATE Coordinate Reference coordinate. Default is the last known coordinate of the cluster.
|
-- @param Core.Point#COORDINATE Coordinate (Optional) Reference coordinate. Default is the last known coordinate of the cluster.
|
||||||
-- @return #boolean If `true`, the coordinate changed by more than the given threshold.
|
-- @return #boolean If `true`, the coordinate changed by more than the given threshold.
|
||||||
function INTEL:_CheckClusterCoordinateChanged(Cluster, Coordinate, Threshold)
|
function INTEL:_CheckClusterCoordinateChanged(Cluster, Coordinate, Threshold)
|
||||||
|
|
||||||
@@ -2641,7 +2641,7 @@ end
|
|||||||
|
|
||||||
--- Function to set how long INTEL DLINK remembers contacts.
|
--- Function to set how long INTEL DLINK remembers contacts.
|
||||||
-- @param #INTEL_DLINK self
|
-- @param #INTEL_DLINK self
|
||||||
-- @param #number seconds Remember this many seconds. Defaults to 180.
|
-- @param #number seconds (Optional) Remember this many seconds. Defaults to 120.
|
||||||
-- @return #INTEL_DLINK self
|
-- @return #INTEL_DLINK self
|
||||||
function INTEL_DLINK:SetDLinkCacheTime(seconds)
|
function INTEL_DLINK:SetDLinkCacheTime(seconds)
|
||||||
self.cachetime = math.abs(seconds or 120)
|
self.cachetime = math.abs(seconds or 120)
|
||||||
|
|||||||
@@ -316,7 +316,7 @@ end
|
|||||||
|
|
||||||
--- Set verbosity level.
|
--- Set verbosity level.
|
||||||
-- @param #LEGION self
|
-- @param #LEGION self
|
||||||
-- @param #number VerbosityLevel Level of output (higher=more). Default 0.
|
-- @param #number VerbosityLevel (Optional) Level of output (higher=more). Default 0.
|
||||||
-- @return #LEGION self
|
-- @return #LEGION self
|
||||||
function LEGION:SetVerbosity(VerbosityLevel)
|
function LEGION:SetVerbosity(VerbosityLevel)
|
||||||
self.verbose=VerbosityLevel or 0
|
self.verbose=VerbosityLevel or 0
|
||||||
@@ -468,10 +468,10 @@ end
|
|||||||
-- @param #LEGION self
|
-- @param #LEGION self
|
||||||
-- @param Ops.Cohort#COHORT Cohort The cohort to be relocated.
|
-- @param Ops.Cohort#COHORT Cohort The cohort to be relocated.
|
||||||
-- @param Ops.Legion#LEGION Legion The legion where the cohort is relocated to.
|
-- @param Ops.Legion#LEGION Legion The legion where the cohort is relocated to.
|
||||||
-- @param #number Delay Delay in seconds before relocation takes place. Default `nil`, *i.e.* ASAP.
|
-- @param #number Delay (Optional) Delay in seconds before relocation takes place. Default `nil`, *i.e.* ASAP.
|
||||||
-- @param #number NcarriersMin Min number of transport carriers in case the troops should be transported. Default `nil` for no transport.
|
-- @param #number NcarriersMin (Optional) Min number of transport carriers in case the troops should be transported. Default `nil` for no transport.
|
||||||
-- @param #number NcarriersMax Max number of transport carriers.
|
-- @param #number NcarriersMax Max number of transport carriers.
|
||||||
-- @param #table TransportLegions Legion(s) assigned for transportation. Default is that transport assets can only be recruited from this legion.
|
-- @param #table TransportLegions (Optional) Legion(s) assigned for transportation. Default is that transport assets can only be recruited from this legion.
|
||||||
-- @return #LEGION self
|
-- @return #LEGION self
|
||||||
function LEGION:RelocateCohort(Cohort, Legion, Delay, NcarriersMin, NcarriersMax, TransportLegions)
|
function LEGION:RelocateCohort(Cohort, Legion, Delay, NcarriersMin, NcarriersMax, TransportLegions)
|
||||||
|
|
||||||
@@ -1927,7 +1927,7 @@ end
|
|||||||
--- Check if an asset is currently on a mission (STARTED or EXECUTING).
|
--- Check if an asset is currently on a mission (STARTED or EXECUTING).
|
||||||
-- @param #LEGION self
|
-- @param #LEGION self
|
||||||
-- @param Functional.Warehouse#WAREHOUSE.Assetitem asset The asset.
|
-- @param Functional.Warehouse#WAREHOUSE.Assetitem asset The asset.
|
||||||
-- @param #table MissionTypes Types on mission to be checked. Default all.
|
-- @param #table MissionTypes (Optional) Types on mission to be checked. Default all.
|
||||||
-- @return #boolean If true, asset has at least one mission of that type in the queue.
|
-- @return #boolean If true, asset has at least one mission of that type in the queue.
|
||||||
function LEGION:IsAssetOnMission(asset, MissionTypes)
|
function LEGION:IsAssetOnMission(asset, MissionTypes)
|
||||||
|
|
||||||
@@ -1980,7 +1980,7 @@ end
|
|||||||
|
|
||||||
--- Count payloads in stock.
|
--- Count payloads in stock.
|
||||||
-- @param #LEGION self
|
-- @param #LEGION self
|
||||||
-- @param #table MissionTypes Types on mission to be checked. Default *all* possible types `AUFTRAG.Type`.
|
-- @param #table MissionTypes (Optional) Types on mission to be checked. Default *all* possible types `AUFTRAG.Type`.
|
||||||
-- @param #table UnitTypes Types of units.
|
-- @param #table UnitTypes Types of units.
|
||||||
-- @param #table Payloads Specific payloads to be counted only.
|
-- @param #table Payloads Specific payloads to be counted only.
|
||||||
-- @return #number Count of available payloads in stock.
|
-- @return #number Count of available payloads in stock.
|
||||||
@@ -2056,7 +2056,7 @@ end
|
|||||||
|
|
||||||
--- Count missions in mission queue.
|
--- Count missions in mission queue.
|
||||||
-- @param #LEGION self
|
-- @param #LEGION self
|
||||||
-- @param #table MissionTypes Types on mission to be checked. Default *all* possible types `AUFTRAG.Type`.
|
-- @param #table MissionTypes (Optional) Types on mission to be checked. Default *all* possible types `AUFTRAG.Type`.
|
||||||
-- @param #boolean OnlyRunning If `true`, only count running missions.
|
-- @param #boolean OnlyRunning If `true`, only count running missions.
|
||||||
-- @return #number Number of missions that are not over yet.
|
-- @return #number Number of missions that are not over yet.
|
||||||
function LEGION:CountMissionsInQueue(MissionTypes, OnlyRunning)
|
function LEGION:CountMissionsInQueue(MissionTypes, OnlyRunning)
|
||||||
@@ -2171,8 +2171,8 @@ end
|
|||||||
|
|
||||||
--- Count assets on mission.
|
--- Count assets on mission.
|
||||||
-- @param #LEGION self
|
-- @param #LEGION self
|
||||||
-- @param #table MissionTypes Types on mission to be checked. Default all.
|
-- @param #table MissionTypes (Optional) Types on mission to be checked. Default all.
|
||||||
-- @param Ops.Cohort#COHORT Cohort Only count assets of this cohort. Default count assets of all cohorts.
|
-- @param Ops.Cohort#COHORT Cohort (Optional) Only count assets of this cohort. Default count assets of all cohorts.
|
||||||
-- @return #number Number of pending and queued assets.
|
-- @return #number Number of pending and queued assets.
|
||||||
-- @return #number Number of pending assets.
|
-- @return #number Number of pending assets.
|
||||||
-- @return #number Number of queued assets.
|
-- @return #number Number of queued assets.
|
||||||
@@ -2215,7 +2215,7 @@ end
|
|||||||
|
|
||||||
--- Get assets on mission.
|
--- Get assets on mission.
|
||||||
-- @param #LEGION self
|
-- @param #LEGION self
|
||||||
-- @param #table MissionTypes Types on mission to be checked. Default all.
|
-- @param #table MissionTypes (Optional) Types on mission to be checked. Default all.
|
||||||
-- @return #table Assets on pending requests.
|
-- @return #table Assets on pending requests.
|
||||||
function LEGION:GetAssetsOnMission(MissionTypes)
|
function LEGION:GetAssetsOnMission(MissionTypes)
|
||||||
|
|
||||||
@@ -2248,7 +2248,7 @@ end
|
|||||||
--- Get the unit types of this legion. These are the unit types of all assigned cohorts.
|
--- Get the unit types of this legion. These are the unit types of all assigned cohorts.
|
||||||
-- @param #LEGION self
|
-- @param #LEGION self
|
||||||
-- @param #boolean onlyactive Count only the active ones.
|
-- @param #boolean onlyactive Count only the active ones.
|
||||||
-- @param #table cohorts Table of cohorts. Default all.
|
-- @param #table cohorts (Optional) Table of cohorts. Default all.
|
||||||
-- @return #table Table of unit types.
|
-- @return #table Table of unit types.
|
||||||
function LEGION:GetAircraftTypes(onlyactive, cohorts)
|
function LEGION:GetAircraftTypes(onlyactive, cohorts)
|
||||||
|
|
||||||
@@ -2789,7 +2789,7 @@ end
|
|||||||
--- Recruit assets from Cohorts for the given parameters. **NOTE** that we set the `asset.isReserved=true` flag so it cannot be recruited by anyone else.
|
--- Recruit assets from Cohorts for the given parameters. **NOTE** that we set the `asset.isReserved=true` flag so it cannot be recruited by anyone else.
|
||||||
-- @param #table Cohorts Cohorts included.
|
-- @param #table Cohorts Cohorts included.
|
||||||
-- @param #string MissionTypeRecruit Mission type for recruiting the cohort assets.
|
-- @param #string MissionTypeRecruit Mission type for recruiting the cohort assets.
|
||||||
-- @param #string MissionTypeOpt Mission type for which the assets are optimized. Default is the same as `MissionTypeRecruit`.
|
-- @param #string MissionTypeOpt (Optional) Mission type for which the assets are optimized. Default is the same as `MissionTypeRecruit`.
|
||||||
-- @param #number NreqMin Minimum number of required assets.
|
-- @param #number NreqMin Minimum number of required assets.
|
||||||
-- @param #number NreqMax Maximum number of required assets.
|
-- @param #number NreqMax Maximum number of required assets.
|
||||||
-- @param DCS#Vec2 TargetVec2 Target position as 2D vector.
|
-- @param DCS#Vec2 TargetVec2 Target position as 2D vector.
|
||||||
|
|||||||
@@ -434,7 +434,7 @@ end
|
|||||||
--- Enable/disable pathfinding.
|
--- Enable/disable pathfinding.
|
||||||
-- @param #NAVYGROUP self
|
-- @param #NAVYGROUP self
|
||||||
-- @param #boolean Switch If true, enable pathfinding.
|
-- @param #boolean Switch If true, enable pathfinding.
|
||||||
-- @param #number CorridorWidth Corridor with in meters. Default 400 m.
|
-- @param #number CorridorWidth (Optional) Corridor with in meters. Default 400 m.
|
||||||
-- @return #NAVYGROUP self
|
-- @return #NAVYGROUP self
|
||||||
function NAVYGROUP:SetPathfinding(Switch, CorridorWidth)
|
function NAVYGROUP:SetPathfinding(Switch, CorridorWidth)
|
||||||
self.pathfindingOn=Switch
|
self.pathfindingOn=Switch
|
||||||
@@ -444,7 +444,7 @@ end
|
|||||||
|
|
||||||
--- Enable pathfinding.
|
--- Enable pathfinding.
|
||||||
-- @param #NAVYGROUP self
|
-- @param #NAVYGROUP self
|
||||||
-- @param #number CorridorWidth Corridor with in meters. Default 400 m.
|
-- @param #number CorridorWidth (Optional) Corridor with in meters. Default 400 m.
|
||||||
-- @return #NAVYGROUP self
|
-- @return #NAVYGROUP self
|
||||||
function NAVYGROUP:SetPathfindingOn(CorridorWidth)
|
function NAVYGROUP:SetPathfindingOn(CorridorWidth)
|
||||||
self:SetPathfinding(true, CorridorWidth)
|
self:SetPathfinding(true, CorridorWidth)
|
||||||
@@ -476,9 +476,9 @@ end
|
|||||||
-- @param #NAVYGROUP self
|
-- @param #NAVYGROUP self
|
||||||
-- @param Core.Point#COORDINATE Coordinate Coordinate of the target.
|
-- @param Core.Point#COORDINATE Coordinate Coordinate of the target.
|
||||||
-- @param #string Clock Time when to start the attack.
|
-- @param #string Clock Time when to start the attack.
|
||||||
-- @param #number Radius Radius in meters. Default 100 m.
|
-- @param #number Radius (Optional) Radius in meters. Default 100 m.
|
||||||
-- @param #number Nshots Number of shots to fire. Default 3.
|
-- @param #number Nshots (Optional) Number of shots to fire. Default 3.
|
||||||
-- @param #number WeaponType Type of weapon. Default auto.
|
-- @param #number WeaponType (Optional) Type of weapon. Default auto.
|
||||||
-- @param #number Prio Priority of the task.
|
-- @param #number Prio Priority of the task.
|
||||||
-- @return Ops.OpsGroup#OPSGROUP.Task The task data.
|
-- @return Ops.OpsGroup#OPSGROUP.Task The task data.
|
||||||
function NAVYGROUP:AddTaskFireAtPoint(Coordinate, Clock, Radius, Nshots, WeaponType, Prio)
|
function NAVYGROUP:AddTaskFireAtPoint(Coordinate, Clock, Radius, Nshots, WeaponType, Prio)
|
||||||
@@ -493,12 +493,12 @@ end
|
|||||||
--- Add a *waypoint* task.
|
--- Add a *waypoint* task.
|
||||||
-- @param #NAVYGROUP self
|
-- @param #NAVYGROUP self
|
||||||
-- @param Core.Point#COORDINATE Coordinate Coordinate of the target.
|
-- @param Core.Point#COORDINATE Coordinate Coordinate of the target.
|
||||||
-- @param Ops.OpsGroup#OPSGROUP.Waypoint Waypoint Where the task is executed. Default is next waypoint.
|
-- @param Ops.OpsGroup#OPSGROUP.Waypoint (Optional) Waypoint Where the task is executed. Default is next waypoint.
|
||||||
-- @param #number Radius Radius in meters. Default 100 m.
|
-- @param #number Radius (Optional) Radius in meters. Default 100 m.
|
||||||
-- @param #number Nshots Number of shots to fire. Default 3.
|
-- @param #number Nshots (Optional) Number of shots to fire. Default 3.
|
||||||
-- @param #number WeaponType Type of weapon. Default auto.
|
-- @param #number WeaponType (Optional) Type of weapon. Default auto.
|
||||||
-- @param #number Prio Priority of the task.
|
-- @param #number Prio (Optional) Priority of the task. Defaults to 50.
|
||||||
-- @param #number Duration Duration in seconds after which the task is cancelled. Default *never*.
|
-- @param #number Duration (Optional) Duration in seconds after which the task is cancelled. Default *never*.
|
||||||
-- @return Ops.OpsGroup#OPSGROUP.Task The task table.
|
-- @return Ops.OpsGroup#OPSGROUP.Task The task table.
|
||||||
function NAVYGROUP:AddTaskWaypointFireAtPoint(Coordinate, Waypoint, Radius, Nshots, WeaponType, Prio, Duration)
|
function NAVYGROUP:AddTaskWaypointFireAtPoint(Coordinate, Waypoint, Radius, Nshots, WeaponType, Prio, Duration)
|
||||||
|
|
||||||
@@ -515,10 +515,10 @@ end
|
|||||||
--- Add a *scheduled* task.
|
--- Add a *scheduled* task.
|
||||||
-- @param #NAVYGROUP self
|
-- @param #NAVYGROUP self
|
||||||
-- @param Wrapper.Group#GROUP TargetGroup Target group.
|
-- @param Wrapper.Group#GROUP TargetGroup Target group.
|
||||||
-- @param #number WeaponExpend How much weapons does are used.
|
-- @param #number WeaponExpend (Optional) How much weapons does are used.
|
||||||
-- @param #number WeaponType Type of weapon. Default auto.
|
-- @param #number WeaponType (Optional) Type of weapon. Default auto.
|
||||||
-- @param #string Clock Time when to start the attack.
|
-- @param #string Clock (Optional) Time when to start the attack.
|
||||||
-- @param #number Prio Priority of the task.
|
-- @param #number Prio (Optional) Priority of the task. Defaults to 50.
|
||||||
-- @return Ops.OpsGroup#OPSGROUP.Task The task data.
|
-- @return Ops.OpsGroup#OPSGROUP.Task The task data.
|
||||||
function NAVYGROUP:AddTaskAttackGroup(TargetGroup, WeaponExpend, WeaponType, Clock, Prio)
|
function NAVYGROUP:AddTaskAttackGroup(TargetGroup, WeaponExpend, WeaponType, Clock, Prio)
|
||||||
|
|
||||||
@@ -531,11 +531,11 @@ end
|
|||||||
|
|
||||||
--- Create a turn into wind window. Note that this is not executed as it not added to the queue.
|
--- Create a turn into wind window. Note that this is not executed as it not added to the queue.
|
||||||
-- @param #NAVYGROUP self
|
-- @param #NAVYGROUP self
|
||||||
-- @param #string starttime Start time, e.g. "8:00" for eight o'clock. Default now.
|
-- @param #string starttime (Optional) Start time, e.g. "8:00" for eight o'clock. Default now.
|
||||||
-- @param #string stoptime Stop time, e.g. "9:00" for nine o'clock. Default 90 minutes after start time.
|
-- @param #string stoptime (Optional) Stop time, e.g. "9:00" for nine o'clock. Default 90 minutes after start time.
|
||||||
-- @param #number speed Speed in knots during turn into wind leg.
|
-- @param #number speed (Optional) Speed in knots during turn into wind leg. Defaults to 20.
|
||||||
-- @param #boolean uturn If true (or nil), carrier wil perform a U-turn and go back to where it came from before resuming its route to the next waypoint. If false, it will go directly to the next waypoint.
|
-- @param #boolean uturn (Optional) If true (or nil), carrier wil perform a U-turn and go back to where it came from before resuming its route to the next waypoint. If false, it will go directly to the next waypoint.
|
||||||
-- @param #number offset Offset angle in degrees, e.g. to account for an angled runway. Default 0 deg.
|
-- @param #number offset (Optional) Offset angle in degrees, e.g. to account for an angled runway. Default 0 deg.
|
||||||
-- @return #NAVYGROUP.IntoWind Recovery window.
|
-- @return #NAVYGROUP.IntoWind Recovery window.
|
||||||
function NAVYGROUP:_CreateTurnIntoWind(starttime, stoptime, speed, uturn, offset)
|
function NAVYGROUP:_CreateTurnIntoWind(starttime, stoptime, speed, uturn, offset)
|
||||||
|
|
||||||
@@ -598,11 +598,11 @@ end
|
|||||||
|
|
||||||
--- Add a time window, where the groups steams into the wind.
|
--- Add a time window, where the groups steams into the wind.
|
||||||
-- @param #NAVYGROUP self
|
-- @param #NAVYGROUP self
|
||||||
-- @param #string starttime Start time, e.g. "8:00" for eight o'clock. Default now.
|
-- @param #string starttime (Optional) Start time, e.g. "8:00" for eight o'clock. Default now.
|
||||||
-- @param #string stoptime Stop time, e.g. "9:00" for nine o'clock. Default 90 minutes after start time.
|
-- @param #string stoptime (Optional) Stop time, e.g. "9:00" for nine o'clock. Default 90 minutes after start time.
|
||||||
-- @param #number speed Wind speed on deck in knots during turn into wind leg. Default 20 knots.
|
-- @param #number speed (Optional) Wind speed on deck in knots during turn into wind leg. Default 20 knots.
|
||||||
-- @param #boolean uturn If `true` (or `nil`), carrier wil perform a U-turn and go back to where it came from before resuming its route to the next waypoint. If false, it will go directly to the next waypoint.
|
-- @param #boolean uturn (Optional) If `true` (or `nil`), carrier wil perform a U-turn and go back to where it came from before resuming its route to the next waypoint. If false, it will go directly to the next waypoint.
|
||||||
-- @param #number offset Offset angle clock-wise in degrees, *e.g.* to account for an angled runway. Default 0 deg. Use around -9.1° for US carriers.
|
-- @param #number offset (Optional) Offset angle clock-wise in degrees, *e.g.* to account for an angled runway. Default 0 deg. Use around -9.1° for US carriers.
|
||||||
-- @return #NAVYGROUP.IntoWind Turn into window data table.
|
-- @return #NAVYGROUP.IntoWind Turn into window data table.
|
||||||
function NAVYGROUP:AddTurnIntoWind(starttime, stoptime, speed, uturn, offset)
|
function NAVYGROUP:AddTurnIntoWind(starttime, stoptime, speed, uturn, offset)
|
||||||
|
|
||||||
@@ -644,7 +644,7 @@ end
|
|||||||
|
|
||||||
--- Extend duration of turn into wind.
|
--- Extend duration of turn into wind.
|
||||||
-- @param #NAVYGROUP self
|
-- @param #NAVYGROUP self
|
||||||
-- @param #number Duration Duration in seconds. Default 300 sec.
|
-- @param #number Duration (Optional) Duration in seconds. Default 300 sec.
|
||||||
-- @param #NAVYGROUP.IntoWind TurnIntoWind (Optional) Turn into window data table. If not given, the currently open one is used (if there is any).
|
-- @param #NAVYGROUP.IntoWind TurnIntoWind (Optional) Turn into window data table. If not given, the currently open one is used (if there is any).
|
||||||
-- @return #NAVYGROUP self
|
-- @return #NAVYGROUP self
|
||||||
function NAVYGROUP:ExtendTurnIntoWind(Duration, TurnIntoWind)
|
function NAVYGROUP:ExtendTurnIntoWind(Duration, TurnIntoWind)
|
||||||
@@ -1832,10 +1832,10 @@ end
|
|||||||
--- Add an a waypoint to the route.
|
--- Add an a waypoint to the route.
|
||||||
-- @param #NAVYGROUP self
|
-- @param #NAVYGROUP self
|
||||||
-- @param Core.Point#COORDINATE Coordinate The coordinate of the waypoint. Use `COORDINATE:SetAltitude()` to define the altitude.
|
-- @param Core.Point#COORDINATE Coordinate The coordinate of the waypoint. Use `COORDINATE:SetAltitude()` to define the altitude.
|
||||||
-- @param #number Speed Speed in knots. Default is default cruise speed or 70% of max speed.
|
-- @param #number Speed (Optional) Speed in knots. Default is default cruise speed or 70% of max speed.
|
||||||
-- @param #number AfterWaypointWithID Insert waypoint after waypoint given ID. Default is to insert as last waypoint.
|
-- @param #number AfterWaypointWithID (Optional) Insert waypoint after waypoint given ID. Default is to insert as last waypoint.
|
||||||
-- @param #number Depth Depth at waypoint in feet. Only for submarines.
|
-- @param #number Depth (Optional) Depth at waypoint in feet. Only for submarines.
|
||||||
-- @param #boolean Updateroute If true or nil, call UpdateRoute. If false, no call.
|
-- @param #boolean Updateroute (Optional) If true or nil, call UpdateRoute. If false, no call.
|
||||||
-- @return Ops.OpsGroup#OPSGROUP.Waypoint Waypoint table.
|
-- @return Ops.OpsGroup#OPSGROUP.Waypoint Waypoint table.
|
||||||
function NAVYGROUP:AddWaypoint(Coordinate, Speed, AfterWaypointWithID, Depth, Updateroute)
|
function NAVYGROUP:AddWaypoint(Coordinate, Speed, AfterWaypointWithID, Depth, Updateroute)
|
||||||
|
|
||||||
@@ -1875,8 +1875,8 @@ end
|
|||||||
|
|
||||||
--- Initialize group parameters. Also initializes waypoints if self.waypoints is nil.
|
--- Initialize group parameters. Also initializes waypoints if self.waypoints is nil.
|
||||||
-- @param #NAVYGROUP self
|
-- @param #NAVYGROUP self
|
||||||
-- @param #table Template Template used to init the group. Default is `self.template`.
|
-- @param #table Template (Optional) Template used to init the group. Default is `self.template`.
|
||||||
-- @param #number Delay Delay in seconds before group is initialized. Default `nil`, *i.e.* instantaneous.
|
-- @param #number Delay (Optional) Delay in seconds before group is initialized. Default `nil`, *i.e.* instantaneous.
|
||||||
-- @return #NAVYGROUP self
|
-- @return #NAVYGROUP self
|
||||||
function NAVYGROUP:_InitGroup(Template, Delay)
|
function NAVYGROUP:_InitGroup(Template, Delay)
|
||||||
|
|
||||||
@@ -1981,7 +1981,7 @@ end
|
|||||||
|
|
||||||
--- Check for possible collisions between two coordinates.
|
--- Check for possible collisions between two coordinates.
|
||||||
-- @param #NAVYGROUP self
|
-- @param #NAVYGROUP self
|
||||||
-- @param #number DistanceMax Max distance in meters ahead to check. Default 5000.
|
-- @param #number DistanceMax (Optional) Max distance in meters ahead to check. Default 5000.
|
||||||
-- @param #number dx
|
-- @param #number dx
|
||||||
-- @return #number Free distance in meters.
|
-- @return #number Free distance in meters.
|
||||||
function NAVYGROUP:_CheckFreePath(DistanceMax, dx)
|
function NAVYGROUP:_CheckFreePath(DistanceMax, dx)
|
||||||
@@ -2167,7 +2167,7 @@ end
|
|||||||
|
|
||||||
--- Get wind direction and speed at current position.
|
--- Get wind direction and speed at current position.
|
||||||
-- @param #NAVYGROUP self
|
-- @param #NAVYGROUP self
|
||||||
-- @param #number Altitude Altitude in meters above main sea level at which the wind is calculated. Default 18 meters.
|
-- @param #number Altitude (Optional) Altitude in meters above main sea level at which the wind is calculated. Default 18 meters.
|
||||||
-- @return #number Direction the wind is blowing **from** in degrees.
|
-- @return #number Direction the wind is blowing **from** in degrees.
|
||||||
-- @return #number Wind speed in m/s.
|
-- @return #number Wind speed in m/s.
|
||||||
function NAVYGROUP:GetWind(Altitude)
|
function NAVYGROUP:GetWind(Altitude)
|
||||||
|
|||||||
@@ -145,7 +145,7 @@ OPERATION.version="0.2.0"
|
|||||||
|
|
||||||
--- Create a new generic OPERATION object.
|
--- Create a new generic OPERATION object.
|
||||||
-- @param #OPERATION self
|
-- @param #OPERATION self
|
||||||
-- @param #string Name Name of the operation. Be creative! Default "Operation-01" where the last number is a running number.
|
-- @param #string Name (Optional) Name of the operation. Be creative! Default "Operation-01" where the last number is a running number.
|
||||||
-- @return #OPERATION self
|
-- @return #OPERATION self
|
||||||
function OPERATION:New(Name)
|
function OPERATION:New(Name)
|
||||||
|
|
||||||
@@ -349,7 +349,7 @@ end
|
|||||||
|
|
||||||
--- Set verbosity level.
|
--- Set verbosity level.
|
||||||
-- @param #OPERATION self
|
-- @param #OPERATION self
|
||||||
-- @param #number VerbosityLevel Level of output (higher=more). Default 0.
|
-- @param #number VerbosityLevel (Optional) Level of output (higher=more). Default 0.
|
||||||
-- @return #OPERATION self
|
-- @return #OPERATION self
|
||||||
function OPERATION:SetVerbosity(VerbosityLevel)
|
function OPERATION:SetVerbosity(VerbosityLevel)
|
||||||
self.verbose=VerbosityLevel or 0
|
self.verbose=VerbosityLevel or 0
|
||||||
@@ -358,7 +358,7 @@ end
|
|||||||
|
|
||||||
--- Set start and stop time of the operation.
|
--- Set start and stop time of the operation.
|
||||||
-- @param #OPERATION self
|
-- @param #OPERATION self
|
||||||
-- @param #string ClockStart Time the mission is started, e.g. "05:00" for 5 am. If specified as a #number, it will be relative (in seconds) to the current mission time. Default is 5 seconds after mission was added.
|
-- @param #string ClockStart (Optional) Time the mission is started, e.g. "05:00" for 5 am. If specified as a #number, it will be relative (in seconds) to the current mission time. Default is 5 seconds after mission was added.
|
||||||
-- @param #string ClockStop (Optional) Time the mission is stopped, e.g. "13:00" for 1 pm. If mission could not be started at that time, it will be removed from the queue. If specified as a #number it will be relative (in seconds) to the current mission time.
|
-- @param #string ClockStop (Optional) Time the mission is stopped, e.g. "13:00" for 1 pm. If mission could not be started at that time, it will be removed from the queue. If specified as a #number it will be relative (in seconds) to the current mission time.
|
||||||
-- @return #OPERATION self
|
-- @return #OPERATION self
|
||||||
function OPERATION:SetTime(ClockStart, ClockStop)
|
function OPERATION:SetTime(ClockStart, ClockStop)
|
||||||
@@ -415,9 +415,9 @@ end
|
|||||||
|
|
||||||
--- Add a new phase to the operation. This is added add the end of all previously added phases (if any).
|
--- Add a new phase to the operation. This is added add the end of all previously added phases (if any).
|
||||||
-- @param #OPERATION self
|
-- @param #OPERATION self
|
||||||
-- @param #string Name Name of the phase. Default "Phase-01" where the last number is a running number.
|
-- @param #string Name (Optional) Name of the phase. Default "Phase-01" where the last number is a running number.
|
||||||
-- @param #OPERATION.Branch Branch The branch to which this phase is added. Default is the master branch.
|
-- @param #OPERATION.Branch Branch (Optional) The branch to which this phase is added. Default is the master branch.
|
||||||
-- @param #number Duration Duration in seconds how long the phase will last. Default `nil`=forever.
|
-- @param #number Duration (Optional) Duration in seconds how long the phase will last. Default `nil`=forever.
|
||||||
-- @return #OPERATION.Phase Phase table object.
|
-- @return #OPERATION.Phase Phase table object.
|
||||||
function OPERATION:AddPhase(Name, Branch, Duration)
|
function OPERATION:AddPhase(Name, Branch, Duration)
|
||||||
|
|
||||||
@@ -445,7 +445,7 @@ end
|
|||||||
---Insert a new phase after an already defined phase of the operation.
|
---Insert a new phase after an already defined phase of the operation.
|
||||||
-- @param #OPERATION self
|
-- @param #OPERATION self
|
||||||
-- @param #OPERATION.Phase PhaseAfter The phase after which the new phase is inserted.
|
-- @param #OPERATION.Phase PhaseAfter The phase after which the new phase is inserted.
|
||||||
-- @param #string Name Name of the phase. Default "Phase-01" where the last number is a running number.
|
-- @param #string Name (Optional) Name of the phase. Default "Phase-01" where the last number is a running number.
|
||||||
-- @return #OPERATION.Phase Phase table object.
|
-- @return #OPERATION.Phase Phase table object.
|
||||||
function OPERATION:InsertPhaseAfter(PhaseAfter, Name)
|
function OPERATION:InsertPhaseAfter(PhaseAfter, Name)
|
||||||
|
|
||||||
@@ -472,7 +472,7 @@ end
|
|||||||
|
|
||||||
--- Get a phase by its name.
|
--- Get a phase by its name.
|
||||||
-- @param #OPERATION self
|
-- @param #OPERATION self
|
||||||
-- @param #string Name Name of the phase. Default "Phase-01" where the last number is a running number.
|
-- @param #string Name (Optional) Name of the phase. Default "Phase-01" where the last number is a running number.
|
||||||
-- @return #OPERATION.Phase Phase table object or nil if phase could not be found.
|
-- @return #OPERATION.Phase Phase table object or nil if phase could not be found.
|
||||||
function OPERATION:GetPhaseByName(Name)
|
function OPERATION:GetPhaseByName(Name)
|
||||||
|
|
||||||
@@ -610,7 +610,7 @@ end
|
|||||||
|
|
||||||
--- Get name of a phase.
|
--- Get name of a phase.
|
||||||
-- @param #OPERATION self
|
-- @param #OPERATION self
|
||||||
-- @param #OPERATION.Phase Phase The phase of which the name is returned. Default is the currently active phase.
|
-- @param #OPERATION.Phase Phase (Optional) The phase of which the name is returned. Default is the currently active phase.
|
||||||
-- @return #string The name of the phase or "None" if no phase is given or active.
|
-- @return #string The name of the phase or "None" if no phase is given or active.
|
||||||
function OPERATION:GetPhaseName(Phase)
|
function OPERATION:GetPhaseName(Phase)
|
||||||
|
|
||||||
@@ -752,7 +752,7 @@ end
|
|||||||
|
|
||||||
--- Get name of the branch.
|
--- Get name of the branch.
|
||||||
-- @param #OPERATION self
|
-- @param #OPERATION self
|
||||||
-- @param #OPERATION.Branch Branch The branch of which the name is requested. Default is the currently active or master branch.
|
-- @param #OPERATION.Branch (Optional) Branch The branch of which the name is requested. Default is the currently active or master branch.
|
||||||
-- @return #string Name Name or "None"
|
-- @return #string Name Name or "None"
|
||||||
function OPERATION:GetBranchName(Branch)
|
function OPERATION:GetBranchName(Branch)
|
||||||
Branch=Branch or self:GetBranchActive()
|
Branch=Branch or self:GetBranchActive()
|
||||||
@@ -1336,7 +1336,7 @@ end
|
|||||||
|
|
||||||
--- Create a new phase object.
|
--- Create a new phase object.
|
||||||
-- @param #OPERATION self
|
-- @param #OPERATION self
|
||||||
-- @param #string Name Name of the phase. Default "Phase-01" where the last number is a running number.
|
-- @param #string Name (Optional) Name of the phase. Default "Phase-01" where the last number is a running number.
|
||||||
-- @return #OPERATION.Phase Phase table object.
|
-- @return #OPERATION.Phase Phase table object.
|
||||||
function OPERATION:_CreatePhase(Name)
|
function OPERATION:_CreatePhase(Name)
|
||||||
|
|
||||||
@@ -1356,7 +1356,7 @@ end
|
|||||||
|
|
||||||
--- Create a new branch object.
|
--- Create a new branch object.
|
||||||
-- @param #OPERATION self
|
-- @param #OPERATION self
|
||||||
-- @param #string Name Name of the phase. Default "Phase-01" where the last number is a running number.
|
-- @param #string Name (Optional) Name of the phase. Default "Phase-01" where the last number is a running number.
|
||||||
-- @return #OPERATION.Branch Branch table object.
|
-- @return #OPERATION.Branch Branch table object.
|
||||||
function OPERATION:_CreateBranch(Name)
|
function OPERATION:_CreateBranch(Name)
|
||||||
|
|
||||||
|
|||||||
@@ -1016,7 +1016,7 @@ end
|
|||||||
|
|
||||||
--- Set verbosity level.
|
--- Set verbosity level.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number VerbosityLevel Level of output (higher=more). Default 0.
|
-- @param #number VerbosityLevel (Optional) Level of output (higher=more). Default 0.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetVerbosity(VerbosityLevel)
|
function OPSGROUP:SetVerbosity(VerbosityLevel)
|
||||||
self.verbose=VerbosityLevel or 0
|
self.verbose=VerbosityLevel or 0
|
||||||
@@ -1068,7 +1068,7 @@ end
|
|||||||
|
|
||||||
--- Set default cruise altitude.
|
--- Set default cruise altitude.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Altitude Altitude in feet. Default is 10,000 ft for airplanes and 1,500 feet for helicopters.
|
-- @param #number Altitude (Optional) Altitude in feet. Default is 10,000 ft for airplanes and 1,500 feet for helicopters.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetDefaultAltitude(Altitude)
|
function OPSGROUP:SetDefaultAltitude(Altitude)
|
||||||
if Altitude then
|
if Altitude then
|
||||||
@@ -1097,7 +1097,7 @@ end
|
|||||||
|
|
||||||
--- Set current altitude.
|
--- Set current altitude.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Altitude Altitude in feet. Default is 10,000 ft for airplanes and 1,500 feet for helicopters.
|
-- @param #number Altitude (Optional) Altitude in feet. Default is 10,000 ft for airplanes and 1,500 feet for helicopters.
|
||||||
-- @param #boolean Keep If `true` the group will maintain that speed on passing waypoints. If `nil` or `false` the group will return to the speed as defined by their route.
|
-- @param #boolean Keep If `true` the group will maintain that speed on passing waypoints. If `nil` or `false` the group will return to the speed as defined by their route.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetAltitude(Altitude, Keep, RadarAlt)
|
function OPSGROUP:SetAltitude(Altitude, Keep, RadarAlt)
|
||||||
@@ -1147,7 +1147,7 @@ end
|
|||||||
|
|
||||||
--- Set current speed.
|
--- Set current speed.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Speed Speed in knots. Default is 70% of max speed.
|
-- @param #number Speed (Optional) Speed in knots. Default is 70% of max speed.
|
||||||
-- @param #boolean Keep If `true` the group will maintain that speed on passing waypoints. If `nil` or `false` the group will return to the speed as defined by their route.
|
-- @param #boolean Keep If `true` the group will maintain that speed on passing waypoints. If `nil` or `false` the group will return to the speed as defined by their route.
|
||||||
-- @param #boolean AltCorrected If `true`, use altitude corrected indicated air speed.
|
-- @param #boolean AltCorrected If `true`, use altitude corrected indicated air speed.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
@@ -1176,7 +1176,7 @@ end
|
|||||||
--- Set detection on or off.
|
--- Set detection on or off.
|
||||||
-- If detection is on, detected targets of the group will be evaluated and FSM events triggered.
|
-- If detection is on, detected targets of the group will be evaluated and FSM events triggered.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #boolean Switch If `true`, detection is on. If `false` or `nil`, detection is off. Default is off.
|
-- @param #boolean Switch (Optional) If `true`, detection is on. If `false` or `nil`, detection is off. Default is off.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetDetection(Switch)
|
function OPSGROUP:SetDetection(Switch)
|
||||||
self:T(self.lid..string.format("Detection is %s", tostring(Switch)))
|
self:T(self.lid..string.format("Detection is %s", tostring(Switch)))
|
||||||
@@ -1335,7 +1335,7 @@ end
|
|||||||
-- @param Core.Point#COORDINATE TargetCoord Coordinate of the target.
|
-- @param Core.Point#COORDINATE TargetCoord Coordinate of the target.
|
||||||
-- @param #number WeaponBitType Weapon type.
|
-- @param #number WeaponBitType Weapon type.
|
||||||
-- @param Core.Point#COORDINATE RefCoord Reference coordinate.
|
-- @param Core.Point#COORDINATE RefCoord Reference coordinate.
|
||||||
-- @param #table SurfaceTypes Valid surfaces types of the coordinate. Default any (nil).
|
-- @param #table SurfaceTypes (Optional) Valid surfaces types of the coordinate. Default any (nil).
|
||||||
-- @return Core.Point#COORDINATE Coordinate in weapon range
|
-- @return Core.Point#COORDINATE Coordinate in weapon range
|
||||||
function OPSGROUP:GetCoordinateInRange(TargetCoord, WeaponBitType, RefCoord, SurfaceTypes)
|
function OPSGROUP:GetCoordinateInRange(TargetCoord, WeaponBitType, RefCoord, SurfaceTypes)
|
||||||
|
|
||||||
@@ -1411,10 +1411,10 @@ end
|
|||||||
|
|
||||||
--- Set LASER parameters.
|
--- Set LASER parameters.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Code Laser code. Default 1688.
|
-- @param #number Code (Optional) Laser code. Default 1688.
|
||||||
-- @param #boolean CheckLOS Check if lasing unit has line of sight to target coordinate. Default is `true`.
|
-- @param #boolean CheckLOS (Optional) Check if lasing unit has line of sight to target coordinate. Default is `true`.
|
||||||
-- @param #boolean IROff If true, then dont switch on the additional IR pointer.
|
-- @param #boolean IROff If true, then dont switch on the additional IR pointer.
|
||||||
-- @param #number UpdateTime Time interval in seconds the beam gets up for moving targets. Default every 0.5 sec.
|
-- @param #number UpdateTime (Optional) Time interval in seconds the beam gets up for moving targets. Default every 0.5 sec.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetLaser(Code, CheckLOS, IROff, UpdateTime)
|
function OPSGROUP:SetLaser(Code, CheckLOS, IROff, UpdateTime)
|
||||||
self.spot.Code=Code or 1688
|
self.spot.Code=Code or 1688
|
||||||
@@ -1473,10 +1473,10 @@ end
|
|||||||
|
|
||||||
--- Add a weapon range for ARTY auftrag.
|
--- Add a weapon range for ARTY auftrag.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number RangeMin Minimum range in nautical miles. Default 0 NM.
|
-- @param #number RangeMin (Optional) Minimum range in nautical miles. Default 0 NM.
|
||||||
-- @param #number RangeMax Maximum range in nautical miles. Default 10 NM.
|
-- @param #number RangeMax (Optional) Maximum range in nautical miles. Default 10 NM.
|
||||||
-- @param #number BitType Bit mask of weapon type for which the given min/max ranges apply. Default is `ENUMS.WeaponFlag.Auto`, i.e. for all weapon types.
|
-- @param #number BitType (Optional) Bit mask of weapon type for which the given min/max ranges apply. Default is `ENUMS.WeaponFlag.Auto`, i.e. for all weapon types.
|
||||||
-- @param #function ConversionToMeters Function that converts input units of ranges to meters. Defaul `UTILS.NMToMeters`.
|
-- @param #function ConversionToMeters (Optional) Function that converts input units of ranges to meters. Defaul `UTILS.NMToMeters`.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:AddWeaponRange(RangeMin, RangeMax, BitType, ConversionToMeters)
|
function OPSGROUP:AddWeaponRange(RangeMin, RangeMax, BitType, ConversionToMeters)
|
||||||
|
|
||||||
@@ -1536,8 +1536,8 @@ end
|
|||||||
|
|
||||||
--- Get highest detected threat. Detection must be turned on. The threat level is a number between 0 and 10, where 0 is the lowest, e.g. unarmed units.
|
--- Get highest detected threat. Detection must be turned on. The threat level is a number between 0 and 10, where 0 is the lowest, e.g. unarmed units.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number ThreatLevelMin Only consider threats with level greater or equal to this number. Default 1 (so unarmed units wont be considered).
|
-- @param #number ThreatLevelMin (Optional) Only consider threats with level greater or equal to this number. Default 1 (so unarmed units wont be considered).
|
||||||
-- @param #number ThreatLevelMax Only consider threats with level smaller or queal to this number. Default 10.
|
-- @param #number ThreatLevelMax (Optional) Only consider threats with level smaller or queal to this number. Default 10.
|
||||||
-- @return Wrapper.Unit#UNIT Highest threat unit detected by the group or `nil` if no threat is currently detected.
|
-- @return Wrapper.Unit#UNIT Highest threat unit detected by the group or `nil` if no threat is currently detected.
|
||||||
-- @return #number Threat level.
|
-- @return #number Threat level.
|
||||||
function OPSGROUP:GetThreat(ThreatLevelMin, ThreatLevelMax)
|
function OPSGROUP:GetThreat(ThreatLevelMin, ThreatLevelMax)
|
||||||
@@ -1593,10 +1593,10 @@ end
|
|||||||
|
|
||||||
--- Enable to automatically engage detected targets.
|
--- Enable to automatically engage detected targets.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number RangeMax Max range in NM. Only detected targets within this radius from the group will be engaged. Default is 25 NM.
|
-- @param #number RangeMax (Optional) Max range in NM. Only detected targets within this radius from the group will be engaged. Default is 25 NM.
|
||||||
-- @param #table TargetTypes Types of target attributes that will be engaged. See [DCS enum attributes](https://wiki.hoggitworld.com/view/DCS_enum_attributes). Default "All".
|
-- @param #table TargetTypes (Optional) Types of target attributes that will be engaged. See [DCS enum attributes](https://wiki.hoggitworld.com/view/DCS_enum_attributes). Default "All".
|
||||||
-- @param Core.Set#SET_ZONE EngageZoneSet Set of zones in which targets are engaged. Default is anywhere.
|
-- @param Core.Set#SET_ZONE EngageZoneSet (Optional) Set of zones in which targets are engaged. Default is anywhere.
|
||||||
-- @param Core.Set#SET_ZONE NoEngageZoneSet Set of zones in which targets are *not* engaged. Default is nowhere.
|
-- @param Core.Set#SET_ZONE NoEngageZoneSet (Optional) Set of zones in which targets are *not* engaged. Default is nowhere.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetEngageDetectedOn(RangeMax, TargetTypes, EngageZoneSet, NoEngageZoneSet)
|
function OPSGROUP:SetEngageDetectedOn(RangeMax, TargetTypes, EngageZoneSet, NoEngageZoneSet)
|
||||||
|
|
||||||
@@ -1783,7 +1783,7 @@ end
|
|||||||
|
|
||||||
--- Get MOOSE UNIT object.
|
--- Get MOOSE UNIT object.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number UnitNumber Number of the unit in the group. Default first unit.
|
-- @param #number UnitNumber (Optional) Number of the unit in the group. Default first unit.
|
||||||
-- @return Wrapper.Unit#UNIT The MOOSE UNIT object.
|
-- @return Wrapper.Unit#UNIT The MOOSE UNIT object.
|
||||||
function OPSGROUP:GetUnit(UnitNumber)
|
function OPSGROUP:GetUnit(UnitNumber)
|
||||||
|
|
||||||
@@ -1799,7 +1799,7 @@ end
|
|||||||
|
|
||||||
--- Get DCS GROUP object.
|
--- Get DCS GROUP object.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number UnitNumber Number of the unit in the group. Default first unit.
|
-- @param #number UnitNumber (Optional) Number of the unit in the group. Default first unit.
|
||||||
-- @return DCS#Unit DCS group object.
|
-- @return DCS#Unit DCS group object.
|
||||||
function OPSGROUP:GetDCSUnit(UnitNumber)
|
function OPSGROUP:GetDCSUnit(UnitNumber)
|
||||||
|
|
||||||
@@ -2059,8 +2059,8 @@ end
|
|||||||
--- Despawn a unit of the group. A "Remove Unit" event is generated by default.
|
--- Despawn a unit of the group. A "Remove Unit" event is generated by default.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #string UnitName Name of the unit
|
-- @param #string UnitName Name of the unit
|
||||||
-- @param #number Delay Delay in seconds before the group will be despawned. Default immediately.
|
-- @param #number Delay (Optional) Delay in seconds before the group will be despawned. Default immediately.
|
||||||
-- @param #boolean NoEventRemoveUnit If true, no event "Remove Unit" is generated.
|
-- @param #boolean NoEventRemoveUnit (Optional) If true, no event "Remove Unit" is generated.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:DespawnUnit(UnitName, Delay, NoEventRemoveUnit)
|
function OPSGROUP:DespawnUnit(UnitName, Delay, NoEventRemoveUnit)
|
||||||
|
|
||||||
@@ -2096,8 +2096,8 @@ end
|
|||||||
--- Despawn an element/unit of the group.
|
--- Despawn an element/unit of the group.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #OPSGROUP.Element Element The element that will be despawned.
|
-- @param #OPSGROUP.Element Element The element that will be despawned.
|
||||||
-- @param #number Delay Delay in seconds before the element will be despawned. Default immediately.
|
-- @param #number Delay (Optional) Delay in seconds before the element will be despawned. Default immediately.
|
||||||
-- @param #boolean NoEventRemoveUnit If true, no event "Remove Unit" is generated.
|
-- @param #boolean NoEventRemoveUnit (Optional) If true, no event "Remove Unit" is generated.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:DespawnElement(Element, Delay, NoEventRemoveUnit)
|
function OPSGROUP:DespawnElement(Element, Delay, NoEventRemoveUnit)
|
||||||
|
|
||||||
@@ -2133,7 +2133,7 @@ end
|
|||||||
-- If no `Remove Unit` event should be generated, the second optional parameter needs to be set to `true`.
|
-- If no `Remove Unit` event should be generated, the second optional parameter needs to be set to `true`.
|
||||||
-- If this group belongs to an AIRWING, BRIGADE or FLEET, it will be added to the warehouse stock if the `NoEventRemoveUnit` parameter is `false` or `nil`.
|
-- If this group belongs to an AIRWING, BRIGADE or FLEET, it will be added to the warehouse stock if the `NoEventRemoveUnit` parameter is `false` or `nil`.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Delay Delay in seconds before the group will be despawned. Default immediately.
|
-- @param #number Delay (Optional) Delay in seconds before the group will be despawned. Default immediately.
|
||||||
-- @param #boolean NoEventRemoveUnit If `true`, **no** event "Remove Unit" is generated.
|
-- @param #boolean NoEventRemoveUnit If `true`, **no** event "Remove Unit" is generated.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:Despawn(Delay, NoEventRemoveUnit)
|
function OPSGROUP:Despawn(Delay, NoEventRemoveUnit)
|
||||||
@@ -2176,7 +2176,7 @@ end
|
|||||||
--- Return group back to the legion it belongs to.
|
--- Return group back to the legion it belongs to.
|
||||||
-- Group is despawned and added back to the stock.
|
-- Group is despawned and added back to the stock.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Delay Delay in seconds before the group will be despawned. Default immediately
|
-- @param #number Delay (Optional) Delay in seconds before the group will be despawned. Default immediately
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:ReturnToLegion(Delay)
|
function OPSGROUP:ReturnToLegion(Delay)
|
||||||
|
|
||||||
@@ -2200,7 +2200,7 @@ end
|
|||||||
--- Destroy a unit of the group. A *Unit Lost* for aircraft or *Dead* event for ground/naval units is generated.
|
--- Destroy a unit of the group. A *Unit Lost* for aircraft or *Dead* event for ground/naval units is generated.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #string UnitName Name of the unit which should be destroyed.
|
-- @param #string UnitName Name of the unit which should be destroyed.
|
||||||
-- @param #number Delay Delay in seconds before the group will be destroyed. Default immediately.
|
-- @param #number Delay (Optional) Delay in seconds before the group will be destroyed. Default immediately.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:DestroyUnit(UnitName, Delay)
|
function OPSGROUP:DestroyUnit(UnitName, Delay)
|
||||||
|
|
||||||
@@ -2232,7 +2232,7 @@ end
|
|||||||
|
|
||||||
--- Destroy group. The whole group is despawned and a *Unit Lost* for aircraft or *Dead* event for ground/naval units is generated for all current units.
|
--- Destroy group. The whole group is despawned and a *Unit Lost* for aircraft or *Dead* event for ground/naval units is generated for all current units.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Delay Delay in seconds before the group will be destroyed. Default immediately.
|
-- @param #number Delay (Optional) Delay in seconds before the group will be destroyed. Default immediately.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:Destroy(Delay)
|
function OPSGROUP:Destroy(Delay)
|
||||||
|
|
||||||
@@ -2316,9 +2316,9 @@ end
|
|||||||
|
|
||||||
--- Self destruction of group. An explosion is created at the position of each element.
|
--- Self destruction of group. An explosion is created at the position of each element.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Delay Delay in seconds. Default now.
|
-- @param #number Delay (Optional) Delay in seconds. Default now.
|
||||||
-- @param #number ExplosionPower (Optional) Explosion power in kg TNT. Default 100 kg.
|
-- @param #number ExplosionPower (Optional) Explosion power in kg TNT. Default 100 kg.
|
||||||
-- @param #string ElementName Name of the element that should be destroyed. Default is all elements.
|
-- @param #string ElementName (Optional) Name of the element that should be destroyed. Default is all elements.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SelfDestruction(Delay, ExplosionPower, ElementName)
|
function OPSGROUP:SelfDestruction(Delay, ExplosionPower, ElementName)
|
||||||
|
|
||||||
@@ -2348,13 +2348,13 @@ end
|
|||||||
--- Use SRS Simple-Text-To-Speech for transmissions.
|
--- Use SRS Simple-Text-To-Speech for transmissions.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #string PathToSRS Path to SRS directory.
|
-- @param #string PathToSRS Path to SRS directory.
|
||||||
-- @param #string Gender Gender: "male" or "female" (default).
|
-- @param #string Gender (Optional) Gender: "male" or "female" (default).
|
||||||
-- @param #string Culture Culture, e.g. "en-GB" (default).
|
-- @param #string Culture (Optional) Culture, e.g. "en-GB" (default).
|
||||||
-- @param #string Voice Specific voice. Overrides `Gender` and `Culture`.
|
-- @param #string Voice (Optional) Specific voice. Overrides `Gender` and `Culture`.
|
||||||
-- @param #number Port SRS port. Default 5002.
|
-- @param #number Port (Optional) SRS port. Default 5002.
|
||||||
-- @param #string PathToGoogleKey Full path to the google credentials JSON file, e.g. `"C:\Users\myUsername\Downloads\key.json"`.
|
-- @param #string PathToGoogleKey (Optional) Full path to the google credentials JSON file, e.g. `"C:\Users\myUsername\Downloads\key.json"`.
|
||||||
-- @param #string Label Label of the SRS comms for the SRS Radio overlay. Defaults to "ROBOT". No spaces allowed!
|
-- @param #string Label (Optional) Label of the SRS comms for the SRS Radio overlay. Defaults to "ROBOT". No spaces allowed!
|
||||||
-- @param #number Volume Volume to be set, 0.0 = silent, 1.0 = loudest. Defaults to 1.0
|
-- @param #number Volume (Optional) Volume to be set, 0.0 = silent, 1.0 = loudest. Defaults to 1.0
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetSRS(PathToSRS, Gender, Culture, Voice, Port, PathToGoogleKey, Label, Volume)
|
function OPSGROUP:SetSRS(PathToSRS, Gender, Culture, Voice, Port, PathToGoogleKey, Label, Volume)
|
||||||
self.useSRS=true
|
self.useSRS=true
|
||||||
@@ -2379,8 +2379,8 @@ end
|
|||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #string Text Text of transmission.
|
-- @param #string Text Text of transmission.
|
||||||
-- @param #number Delay Delay in seconds before the transmission is started.
|
-- @param #number Delay Delay in seconds before the transmission is started.
|
||||||
-- @param #boolean SayCallsign If `true`, the callsign is prepended to the given text. Default `false`.
|
-- @param #boolean SayCallsign (Optional) If `true`, the callsign is prepended to the given text. Default `false`.
|
||||||
-- @param #number Frequency Override sender frequency, helpful when you need multiple radios from the same sender. Default is the frequency set for the OpsGroup.
|
-- @param #number Frequency (Optional) Override sender frequency, helpful when you need multiple radios from the same sender. Default is the frequency set for the OpsGroup.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:RadioTransmission(Text, Delay, SayCallsign, Frequency)
|
function OPSGROUP:RadioTransmission(Text, Delay, SayCallsign, Frequency)
|
||||||
|
|
||||||
@@ -2421,8 +2421,8 @@ end
|
|||||||
|
|
||||||
--- Set that this carrier is an all aspect loader.
|
--- Set that this carrier is an all aspect loader.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Length Length of loading zone in meters. Default 50 m.
|
-- @param #number Length (Optional) Length of loading zone in meters. Default 50 m.
|
||||||
-- @param #number Width Width of loading zone in meters. Default 20 m.
|
-- @param #number Width (Optional) Width of loading zone in meters. Default 20 m.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetCarrierLoaderAllAspect(Length, Width)
|
function OPSGROUP:SetCarrierLoaderAllAspect(Length, Width)
|
||||||
self.carrierLoader.type="front"
|
self.carrierLoader.type="front"
|
||||||
@@ -2433,8 +2433,8 @@ end
|
|||||||
|
|
||||||
--- Set that this carrier is a front loader.
|
--- Set that this carrier is a front loader.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Length Length of loading zone in meters. Default 50 m.
|
-- @param #number Length (Optional) Length of loading zone in meters. Default 50 m.
|
||||||
-- @param #number Width Width of loading zone in meters. Default 20 m.
|
-- @param #number Width (Optional) Width of loading zone in meters. Default 20 m.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetCarrierLoaderFront(Length, Width)
|
function OPSGROUP:SetCarrierLoaderFront(Length, Width)
|
||||||
self.carrierLoader.type="front"
|
self.carrierLoader.type="front"
|
||||||
@@ -2445,8 +2445,8 @@ end
|
|||||||
|
|
||||||
--- Set that this carrier is a back loader.
|
--- Set that this carrier is a back loader.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Length Length of loading zone in meters. Default 50 m.
|
-- @param #number Length (Optional) Length of loading zone in meters. Default 50 m.
|
||||||
-- @param #number Width Width of loading zone in meters. Default 20 m.
|
-- @param #number Width (Optional) Width of loading zone in meters. Default 20 m.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetCarrierLoaderBack(Length, Width)
|
function OPSGROUP:SetCarrierLoaderBack(Length, Width)
|
||||||
self.carrierLoader.type="back"
|
self.carrierLoader.type="back"
|
||||||
@@ -2457,8 +2457,8 @@ end
|
|||||||
|
|
||||||
--- Set that this carrier is a starboard (right side) loader.
|
--- Set that this carrier is a starboard (right side) loader.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Length Length of loading zone in meters. Default 50 m.
|
-- @param #number Length (Optional) Length of loading zone in meters. Default 50 m.
|
||||||
-- @param #number Width Width of loading zone in meters. Default 20 m.
|
-- @param #number Width (Optional) Width of loading zone in meters. Default 20 m.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetCarrierLoaderStarboard(Length, Width)
|
function OPSGROUP:SetCarrierLoaderStarboard(Length, Width)
|
||||||
self.carrierLoader.type="right"
|
self.carrierLoader.type="right"
|
||||||
@@ -2469,8 +2469,8 @@ end
|
|||||||
|
|
||||||
--- Set that this carrier is a port (left side) loader.
|
--- Set that this carrier is a port (left side) loader.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Length Length of loading zone in meters. Default 50 m.
|
-- @param #number Length (Optional) Length of loading zone in meters. Default 50 m.
|
||||||
-- @param #number Width Width of loading zone in meters. Default 20 m.
|
-- @param #number Width (Optional) Width of loading zone in meters. Default 20 m.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetCarrierLoaderPort(Length, Width)
|
function OPSGROUP:SetCarrierLoaderPort(Length, Width)
|
||||||
self.carrierLoader.type="left"
|
self.carrierLoader.type="left"
|
||||||
@@ -2482,8 +2482,8 @@ end
|
|||||||
|
|
||||||
--- Set that this carrier is an all aspect unloader.
|
--- Set that this carrier is an all aspect unloader.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Length Length of loading zone in meters. Default 50 m.
|
-- @param #number Length (Optional) Length of loading zone in meters. Default 50 m.
|
||||||
-- @param #number Width Width of loading zone in meters. Default 20 m.
|
-- @param #number Width (Optional) Width of loading zone in meters. Default 20 m.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetCarrierUnloaderAllAspect(Length, Width)
|
function OPSGROUP:SetCarrierUnloaderAllAspect(Length, Width)
|
||||||
self.carrierUnloader.type="front"
|
self.carrierUnloader.type="front"
|
||||||
@@ -2494,8 +2494,8 @@ end
|
|||||||
|
|
||||||
--- Set that this carrier is a front unloader.
|
--- Set that this carrier is a front unloader.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Length Length of loading zone in meters. Default 50 m.
|
-- @param #number Length (Optional) Length of loading zone in meters. Default 50 m.
|
||||||
-- @param #number Width Width of loading zone in meters. Default 20 m.
|
-- @param #number Width (Optional) Width of loading zone in meters. Default 20 m.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetCarrierUnloaderFront(Length, Width)
|
function OPSGROUP:SetCarrierUnloaderFront(Length, Width)
|
||||||
self.carrierUnloader.type="front"
|
self.carrierUnloader.type="front"
|
||||||
@@ -2506,8 +2506,8 @@ end
|
|||||||
|
|
||||||
--- Set that this carrier is a back unloader.
|
--- Set that this carrier is a back unloader.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Length Length of loading zone in meters. Default 50 m.
|
-- @param #number Length (Optional) Length of loading zone in meters. Default 50 m.
|
||||||
-- @param #number Width Width of loading zone in meters. Default 20 m.
|
-- @param #number Width (Optional) Width of loading zone in meters. Default 20 m.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetCarrierUnloaderBack(Length, Width)
|
function OPSGROUP:SetCarrierUnloaderBack(Length, Width)
|
||||||
self.carrierUnloader.type="back"
|
self.carrierUnloader.type="back"
|
||||||
@@ -2518,8 +2518,8 @@ end
|
|||||||
|
|
||||||
--- Set that this carrier is a starboard (right side) unloader.
|
--- Set that this carrier is a starboard (right side) unloader.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Length Length of loading zone in meters. Default 50 m.
|
-- @param #number Length (Optional) Length of loading zone in meters. Default 50 m.
|
||||||
-- @param #number Width Width of loading zone in meters. Default 20 m.
|
-- @param #number Width (Optional) Width of loading zone in meters. Default 20 m.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetCarrierUnloaderStarboard(Length, Width)
|
function OPSGROUP:SetCarrierUnloaderStarboard(Length, Width)
|
||||||
self.carrierUnloader.type="right"
|
self.carrierUnloader.type="right"
|
||||||
@@ -2530,8 +2530,8 @@ end
|
|||||||
|
|
||||||
--- Set that this carrier is a port (left side) unloader.
|
--- Set that this carrier is a port (left side) unloader.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Length Length of loading zone in meters. Default 50 m.
|
-- @param #number Length (Optional) Length of loading zone in meters. Default 50 m.
|
||||||
-- @param #number Width Width of loading zone in meters. Default 20 m.
|
-- @param #number Width (Optional) Width of loading zone in meters. Default 20 m.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetCarrierUnloaderPort(Length, Width)
|
function OPSGROUP:SetCarrierUnloaderPort(Length, Width)
|
||||||
self.carrierUnloader.type="left"
|
self.carrierUnloader.type="left"
|
||||||
@@ -3076,7 +3076,7 @@ end
|
|||||||
|
|
||||||
--- Mark waypoints on F10 map.
|
--- Mark waypoints on F10 map.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Duration Duration in seconds how long the waypoints are displayed before they are automatically removed. Default is that they are never removed.
|
-- @param #number Duration (Optional) Duration in seconds how long the waypoints are displayed before they are automatically removed. Default is that they are never removed.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:MarkWaypoints(Duration)
|
function OPSGROUP:MarkWaypoints(Duration)
|
||||||
|
|
||||||
@@ -3106,7 +3106,7 @@ end
|
|||||||
|
|
||||||
--- Remove waypoints markers on the F10 map.
|
--- Remove waypoints markers on the F10 map.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Delay Delay in seconds before the markers are removed. Default is immediately.
|
-- @param #number Delay (Optional) Delay in seconds before the markers are removed. Default is immediately.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:RemoveWaypointMarkers(Delay)
|
function OPSGROUP:RemoveWaypointMarkers(Delay)
|
||||||
|
|
||||||
@@ -3196,8 +3196,8 @@ end
|
|||||||
|
|
||||||
--- Get next waypoint index.
|
--- Get next waypoint index.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #boolean cyclic If `true`, return first waypoint if last waypoint was reached. Default is patrol ad infinitum value set.
|
-- @param #boolean cyclic (Optional) If `true`, return first waypoint if last waypoint was reached. Default is patrol ad infinitum value set.
|
||||||
-- @param #number i Waypoint index from which the next index is returned. Default is the last waypoint passed.
|
-- @param #number i (Optional) Waypoint index from which the next index is returned. Default is the last waypoint passed.
|
||||||
-- @return #number Next waypoint index.
|
-- @return #number Next waypoint index.
|
||||||
function OPSGROUP:GetWaypointIndexNext(cyclic, i)
|
function OPSGROUP:GetWaypointIndexNext(cyclic, i)
|
||||||
|
|
||||||
@@ -3232,7 +3232,7 @@ end
|
|||||||
|
|
||||||
--- Get waypoint index after waypoint with given ID. So if the waypoint has index 3 it will return 4.
|
--- Get waypoint index after waypoint with given ID. So if the waypoint has index 3 it will return 4.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number uid Unique ID of the waypoint. Default is new waypoint index after the last current one.
|
-- @param #number uid (Optional) Unique ID of the waypoint. Default is new waypoint index after the last current one.
|
||||||
-- @return #number Index after waypoint with given ID.
|
-- @return #number Index after waypoint with given ID.
|
||||||
function OPSGROUP:GetWaypointIndexAfterID(uid)
|
function OPSGROUP:GetWaypointIndexAfterID(uid)
|
||||||
|
|
||||||
@@ -3369,7 +3369,7 @@ end
|
|||||||
|
|
||||||
--- Get distance to waypoint.
|
--- Get distance to waypoint.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number indx Waypoint index. Default is the next waypoint.
|
-- @param #number indx (Optional) Waypoint index. Default is the next waypoint.
|
||||||
-- @return #number Distance in meters.
|
-- @return #number Distance in meters.
|
||||||
function OPSGROUP:GetDistanceToWaypoint(indx)
|
function OPSGROUP:GetDistanceToWaypoint(indx)
|
||||||
local dist=0
|
local dist=0
|
||||||
@@ -3394,7 +3394,7 @@ end
|
|||||||
|
|
||||||
--- Get time to waypoint based on current velocity.
|
--- Get time to waypoint based on current velocity.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number indx Waypoint index. Default is the next waypoint.
|
-- @param #number indx (Optional) Waypoint index. Default is the next waypoint.
|
||||||
-- @return #number Time in seconds. If velocity is 0
|
-- @return #number Time in seconds. If velocity is 0
|
||||||
function OPSGROUP:GetTimeToWaypoint(indx)
|
function OPSGROUP:GetTimeToWaypoint(indx)
|
||||||
|
|
||||||
@@ -3847,10 +3847,10 @@ end
|
|||||||
--- Add a *scheduled* task.
|
--- Add a *scheduled* task.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #table task DCS task table structure.
|
-- @param #table task DCS task table structure.
|
||||||
-- @param #string clock Mission time when task is executed. Default in 5 seconds. If argument passed as #number, it defines a relative delay in seconds.
|
-- @param #string clock (Optional) Mission time when task is executed. Default in 5 seconds. If argument passed as #number, it defines a relative delay in seconds.
|
||||||
-- @param #string description Brief text describing the task, e.g. "Attack SAM".
|
-- @param #string description Brief text describing the task, e.g. "Attack SAM".
|
||||||
-- @param #number prio Priority of the task.
|
-- @param #number prio (Optional) Priority of the task. Default is 50.
|
||||||
-- @param #number duration Duration before task is cancelled in seconds counted after task started. Default never.
|
-- @param #number duration (Optional) Duration before task is cancelled in seconds counted after task started. Default never.
|
||||||
-- @return #OPSGROUP.Task The task structure.
|
-- @return #OPSGROUP.Task The task structure.
|
||||||
function OPSGROUP:AddTask(task, clock, description, prio, duration)
|
function OPSGROUP:AddTask(task, clock, description, prio, duration)
|
||||||
|
|
||||||
@@ -3869,10 +3869,10 @@ end
|
|||||||
--- Create a *scheduled* task.
|
--- Create a *scheduled* task.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #table task DCS task table structure.
|
-- @param #table task DCS task table structure.
|
||||||
-- @param #string clock Mission time when task is executed. Default in 5 seconds. If argument passed as #number, it defines a relative delay in seconds.
|
-- @param #string clock (Optional) Mission time when task is executed. Default in 5 seconds. If argument passed as #number, it defines a relative delay in seconds.
|
||||||
-- @param #string description Brief text describing the task, e.g. "Attack SAM".
|
-- @param #string description Brief text describing the task, e.g. "Attack SAM".
|
||||||
-- @param #number prio Priority of the task.
|
-- @param #number prio (Optional) Priority of the task. Default is 50.
|
||||||
-- @param #number duration Duration before task is cancelled in seconds counted after task started. Default never.
|
-- @param #number duration (Optional) Duration before task is cancelled in seconds counted after task started. Default never.
|
||||||
-- @return #OPSGROUP.Task The task structure.
|
-- @return #OPSGROUP.Task The task structure.
|
||||||
function OPSGROUP:NewTaskScheduled(task, clock, description, prio, duration)
|
function OPSGROUP:NewTaskScheduled(task, clock, description, prio, duration)
|
||||||
|
|
||||||
@@ -3909,10 +3909,10 @@ end
|
|||||||
--- Add a *waypoint* task.
|
--- Add a *waypoint* task.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #table task DCS task table structure.
|
-- @param #table task DCS task table structure.
|
||||||
-- @param #OPSGROUP.Waypoint Waypoint where the task is executed. Default is the at *next* waypoint.
|
-- @param #OPSGROUP.Waypoint Waypoint (Optional) where the task is executed. Default is the at *next* waypoint.
|
||||||
-- @param #string description Brief text describing the task, e.g. "Attack SAM".
|
-- @param #string description Brief text describing the task, e.g. "Attack SAM".
|
||||||
-- @param #number prio Priority of the task. Number between 1 and 100. Default is 50.
|
-- @param #number prio (Optional) Priority of the task. Number between 1 and 100. Default is 50.
|
||||||
-- @param #number duration Duration before task is cancelled in seconds counted after task started. Default never.
|
-- @param #number duration(Optional) Duration before task is cancelled in seconds counted after task started. Default never.
|
||||||
-- @return #OPSGROUP.Task The task structure.
|
-- @return #OPSGROUP.Task The task structure.
|
||||||
function OPSGROUP:AddTaskWaypoint(task, Waypoint, description, prio, duration)
|
function OPSGROUP:AddTaskWaypoint(task, Waypoint, description, prio, duration)
|
||||||
|
|
||||||
@@ -4842,8 +4842,8 @@ end
|
|||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param DCS#Task DCSTask The DCS task.
|
-- @param DCS#Task DCSTask The DCS task.
|
||||||
-- @param Ops.OpsGroup#OPSGROUP.Task Task
|
-- @param Ops.OpsGroup#OPSGROUP.Task Task
|
||||||
-- @param #boolean SetTask Set task instead of pushing it.
|
-- @param #boolean SetTask (Optional) Set task instead of pushing it. Default is to push it.
|
||||||
-- @param #number Delay Delay in seconds. Default nil.
|
-- @param #number Delay (Optional) Delay in seconds. Default nil.
|
||||||
function OPSGROUP:_SandwitchDCSTask(DCSTask, Task, SetTask, Delay)
|
function OPSGROUP:_SandwitchDCSTask(DCSTask, Task, SetTask, Delay)
|
||||||
|
|
||||||
if Delay and Delay>0 then
|
if Delay and Delay>0 then
|
||||||
@@ -4896,7 +4896,7 @@ end
|
|||||||
-- @param #string From From state.
|
-- @param #string From From state.
|
||||||
-- @param #string Event Event.
|
-- @param #string Event Event.
|
||||||
-- @param #string To To state.
|
-- @param #string To To state.
|
||||||
-- @param #OPSGROUP.Task Task The task to cancel. Default is the current task (if any).
|
-- @param #OPSGROUP.Task Task (Optional) The task to cancel. Default is the current task (if any).
|
||||||
function OPSGROUP:onafterTaskCancel(From, Event, To, Task)
|
function OPSGROUP:onafterTaskCancel(From, Event, To, Task)
|
||||||
|
|
||||||
-- Get current task.
|
-- Get current task.
|
||||||
@@ -7772,8 +7772,8 @@ end
|
|||||||
--- Teleport the group to a different location.
|
--- Teleport the group to a different location.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param Core.Point#COORDINATE Coordinate Coordinate where the group is teleported to.
|
-- @param Core.Point#COORDINATE Coordinate Coordinate where the group is teleported to.
|
||||||
-- @param #number Delay Delay in seconds before respawn happens. Default 0.
|
-- @param #number Delay (Optional) Delay in seconds before respawn happens. Default 0.
|
||||||
-- @param #boolean NoPauseMission If `true`, dont pause a running mission.
|
-- @param #boolean NoPauseMission (Optional) If `true`, dont pause a running mission.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:Teleport(Coordinate, Delay, NoPauseMission)
|
function OPSGROUP:Teleport(Coordinate, Delay, NoPauseMission)
|
||||||
|
|
||||||
@@ -7861,9 +7861,9 @@ end
|
|||||||
|
|
||||||
--- Respawn the group.
|
--- Respawn the group.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Delay Delay in seconds before respawn happens. Default 0.
|
-- @param #number Delay (Optional) Delay in seconds before respawn happens. Default 0.
|
||||||
-- @param DCS#Template Template (optional) The template of the Group retrieved with GROUP:GetTemplate(). If the template is not provided, the template will be retrieved of the group itself.
|
-- @param DCS#Template Template (Optional) The template of the Group retrieved with GROUP:GetTemplate(). If the template is not provided, the template will be retrieved of the group itself.
|
||||||
-- @param #boolean Reset Reset waypoints and reinit group if `true`.
|
-- @param #boolean Reset (Optional) Reset waypoints and reinit group if `true`.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:_Respawn(Delay, Template, Reset)
|
function OPSGROUP:_Respawn(Delay, Template, Reset)
|
||||||
|
|
||||||
@@ -7956,8 +7956,8 @@ end
|
|||||||
|
|
||||||
--- Spawn group from a given template.
|
--- Spawn group from a given template.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Delay Delay in seconds before respawn happens. Default 0.
|
-- @param #number Delay (Optional) Delay in seconds before respawn happens. Default 0.
|
||||||
-- @param DCS#Template Template (optional) The template of the Group retrieved with GROUP:GetTemplate(). If the template is not provided, the template will be retrieved of the group itself.
|
-- @param DCS#Template Template (Optional) The template of the Group retrieved with GROUP:GetTemplate(). If the template is not provided, the template will be retrieved of the group itself.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:_Spawn(Delay, Template)
|
function OPSGROUP:_Spawn(Delay, Template)
|
||||||
if Delay and Delay>0 then
|
if Delay and Delay>0 then
|
||||||
@@ -8960,8 +8960,8 @@ end
|
|||||||
|
|
||||||
--- Get total weight of the group including cargo. Optionally, the total weight of a specific unit can be requested.
|
--- Get total weight of the group including cargo. Optionally, the total weight of a specific unit can be requested.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #string UnitName Name of the unit. Default is of the whole group.
|
-- @param #string UnitName (Optional) Name of the unit. Default is of the whole group.
|
||||||
-- @param #boolean IncludeReserved If `false`, cargo weight that is only *reserved* is **not** counted. By default (`true` or `nil`), the reserved cargo is included.
|
-- @param #boolean IncludeReserved (Optional) If `false`, cargo weight that is only *reserved* is **not** counted. By default (`true` or `nil`), the reserved cargo is included.
|
||||||
-- @return #number Total weight in kg.
|
-- @return #number Total weight in kg.
|
||||||
function OPSGROUP:GetWeightTotal(UnitName, IncludeReserved)
|
function OPSGROUP:GetWeightTotal(UnitName, IncludeReserved)
|
||||||
|
|
||||||
@@ -8996,8 +8996,8 @@ end
|
|||||||
|
|
||||||
--- Get free cargo bay weight.
|
--- Get free cargo bay weight.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #string UnitName Name of the unit. Default is of the whole group.
|
-- @param #string UnitName (Optional) Name of the unit. Default is of the whole group.
|
||||||
-- @param #boolean IncludeReserved If `false`, cargo weight that is only *reserved* is **not** counted. By default (`true` or `nil`), the reserved cargo is included.
|
-- @param #boolean IncludeReserved (Optional) If `false`, cargo weight that is only *reserved* is **not** counted. By default (`true` or `nil`), the reserved cargo is included.
|
||||||
-- @return #number Free cargo bay in kg.
|
-- @return #number Free cargo bay in kg.
|
||||||
function OPSGROUP:GetFreeCargobay(UnitName, IncludeReserved)
|
function OPSGROUP:GetFreeCargobay(UnitName, IncludeReserved)
|
||||||
|
|
||||||
@@ -9018,8 +9018,8 @@ end
|
|||||||
|
|
||||||
--- Get relative free cargo bay in percent.
|
--- Get relative free cargo bay in percent.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #string UnitName Name of the unit. Default is of the whole group.
|
-- @param #string UnitName (Optional) Name of the unit. Default is of the whole group.
|
||||||
-- @param #boolean IncludeReserved If `false`, cargo weight that is only *reserved* is **not** counted. By default (`true` or `nil`), the reserved cargo is included.
|
-- @param #boolean IncludeReserved (Optional) If `false`, cargo weight that is only *reserved* is **not** counted. By default (`true` or `nil`), the reserved cargo is included.
|
||||||
-- @return #number Free cargo bay in percent.
|
-- @return #number Free cargo bay in percent.
|
||||||
function OPSGROUP:GetFreeCargobayRelative(UnitName, IncludeReserved)
|
function OPSGROUP:GetFreeCargobayRelative(UnitName, IncludeReserved)
|
||||||
|
|
||||||
@@ -9034,8 +9034,8 @@ end
|
|||||||
|
|
||||||
--- Get relative used (loaded) cargo bay in percent.
|
--- Get relative used (loaded) cargo bay in percent.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #string UnitName Name of the unit. Default is of the whole group.
|
-- @param #string UnitName (Optional) Name of the unit. Default is of the whole group.
|
||||||
-- @param #boolean IncludeReserved If `false`, cargo weight that is only *reserved* is **not** counted. By default (`true` or `nil`), the reserved cargo is included.
|
-- @param #boolean IncludeReserved (Optional) If `false`, cargo weight that is only *reserved* is **not** counted. By default (`true` or `nil`), the reserved cargo is included.
|
||||||
-- @return #number Used cargo bay in percent.
|
-- @return #number Used cargo bay in percent.
|
||||||
function OPSGROUP:GetUsedCargobayRelative(UnitName, IncludeReserved)
|
function OPSGROUP:GetUsedCargobayRelative(UnitName, IncludeReserved)
|
||||||
local free=self:GetFreeCargobayRelative(UnitName, IncludeReserved)
|
local free=self:GetFreeCargobayRelative(UnitName, IncludeReserved)
|
||||||
@@ -9075,8 +9075,8 @@ end
|
|||||||
|
|
||||||
--- Get weight of the internal cargo the group is carriing right now.
|
--- Get weight of the internal cargo the group is carriing right now.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #string UnitName Name of the unit. Default is of the whole group.
|
-- @param #string UnitName (Optional) Name of the unit. Default is of the whole group.
|
||||||
-- @param #boolean IncludeReserved If `false`, cargo weight that is only *reserved* is **not** counted. By default (`true` or `nil`), the reserved cargo is included.
|
-- @param #boolean IncludeReserved (Optional) If `false`, cargo weight that is only *reserved* is **not** counted. By default (`true` or `nil`), the reserved cargo is included.
|
||||||
-- @return #number Cargo weight in kg.
|
-- @return #number Cargo weight in kg.
|
||||||
function OPSGROUP:GetWeightCargo(UnitName, IncludeReserved)
|
function OPSGROUP:GetWeightCargo(UnitName, IncludeReserved)
|
||||||
|
|
||||||
@@ -9125,7 +9125,7 @@ end
|
|||||||
|
|
||||||
--- Get max weight of the internal cargo the group can carry. Optionally, the max cargo weight of a specific unit can be requested.
|
--- Get max weight of the internal cargo the group can carry. Optionally, the max cargo weight of a specific unit can be requested.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #string UnitName Name of the unit. Default is of the whole group.
|
-- @param #string UnitName (Optional) Name of the unit. Default is of the whole group.
|
||||||
-- @return #number Max cargo weight in kg. This does **not** include any cargo loaded or reserved currently.
|
-- @return #number Max cargo weight in kg. This does **not** include any cargo loaded or reserved currently.
|
||||||
function OPSGROUP:GetWeightCargoMax(UnitName)
|
function OPSGROUP:GetWeightCargoMax(UnitName)
|
||||||
|
|
||||||
@@ -9163,7 +9163,7 @@ end
|
|||||||
|
|
||||||
--- Add weight to the internal cargo of an element of the group.
|
--- Add weight to the internal cargo of an element of the group.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #string UnitName Name of the unit. Default is of the whole group.
|
-- @param #string UnitName (Optional) Name of the unit. Default is of the whole group.
|
||||||
-- @param #number Weight Cargo weight to be added in kg.
|
-- @param #number Weight Cargo weight to be added in kg.
|
||||||
function OPSGROUP:AddWeightCargo(UnitName, Weight)
|
function OPSGROUP:AddWeightCargo(UnitName, Weight)
|
||||||
|
|
||||||
@@ -11529,7 +11529,7 @@ end
|
|||||||
--- Initialize Mission Editor waypoints.
|
--- Initialize Mission Editor waypoints.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #OPSGROUP.Waypoint waypoint Waypoint data.
|
-- @param #OPSGROUP.Waypoint waypoint Waypoint data.
|
||||||
-- @param #number wpnumber Waypoint index/number. Default is as last waypoint.
|
-- @param #number wpnumber (Optional) Waypoint index/number. Default is as last waypoint.
|
||||||
function OPSGROUP:_AddWaypoint(waypoint, wpnumber)
|
function OPSGROUP:_AddWaypoint(waypoint, wpnumber)
|
||||||
|
|
||||||
-- Index.
|
-- Index.
|
||||||
@@ -11999,7 +11999,7 @@ end
|
|||||||
|
|
||||||
--- Set the default ROE for the group. This is the ROE state gets when the group is spawned or to which it defaults back after a mission.
|
--- Set the default ROE for the group. This is the ROE state gets when the group is spawned or to which it defaults back after a mission.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number roe ROE of group. Default is `ENUMS.ROE.ReturnFire`.
|
-- @param #number roe (Optional) ROE of group. Default is `ENUMS.ROE.ReturnFire`.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetDefaultROE(roe)
|
function OPSGROUP:SetDefaultROE(roe)
|
||||||
self.optionDefault.ROE=roe or ENUMS.ROE.ReturnFire
|
self.optionDefault.ROE=roe or ENUMS.ROE.ReturnFire
|
||||||
@@ -12008,7 +12008,7 @@ end
|
|||||||
|
|
||||||
--- Set current ROE for the group.
|
--- Set current ROE for the group.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #string roe ROE of group. Default is value set in `SetDefaultROE` (usually `ENUMS.ROE.ReturnFire`).
|
-- @param #string roe (Optional) ROE of group. Default is value set in `SetDefaultROE` (usually `ENUMS.ROE.ReturnFire`).
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SwitchROE(roe)
|
function OPSGROUP:SwitchROE(roe)
|
||||||
|
|
||||||
@@ -12061,7 +12061,7 @@ end
|
|||||||
|
|
||||||
--- Set the default ROT for the group. This is the ROT state gets when the group is spawned or to which it defaults back after a mission.
|
--- Set the default ROT for the group. This is the ROT state gets when the group is spawned or to which it defaults back after a mission.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number rot ROT of group. Default is `ENUMS.ROT.PassiveDefense`.
|
-- @param #number rot (Optional) ROT of group. Default is `ENUMS.ROT.PassiveDefense`.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetDefaultROT(rot)
|
function OPSGROUP:SetDefaultROT(rot)
|
||||||
self.optionDefault.ROT=rot or ENUMS.ROT.PassiveDefense
|
self.optionDefault.ROT=rot or ENUMS.ROT.PassiveDefense
|
||||||
@@ -12070,7 +12070,7 @@ end
|
|||||||
|
|
||||||
--- Set ROT for the group.
|
--- Set ROT for the group.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #string rot ROT of group. Default is value set in `:SetDefaultROT` (usually `ENUMS.ROT.PassiveDefense`).
|
-- @param #string rot (Optional) ROT of group. Default is value set in `:SetDefaultROT` (usually `ENUMS.ROT.PassiveDefense`).
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SwitchROT(rot)
|
function OPSGROUP:SwitchROT(rot)
|
||||||
|
|
||||||
@@ -12110,7 +12110,7 @@ end
|
|||||||
|
|
||||||
--- Set the default Alarm State for the group. This is the state gets when the group is spawned or to which it defaults back after a mission.
|
--- Set the default Alarm State for the group. This is the state gets when the group is spawned or to which it defaults back after a mission.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number alarmstate Alarm state of group. Default is `AI.Option.Ground.val.ALARM_STATE.AUTO` (0).
|
-- @param #number alarmstate (Optional) Alarm state of group. Default is `AI.Option.Ground.val.ALARM_STATE.AUTO` (0).
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetDefaultAlarmstate(alarmstate)
|
function OPSGROUP:SetDefaultAlarmstate(alarmstate)
|
||||||
self.optionDefault.Alarm=alarmstate or 0
|
self.optionDefault.Alarm=alarmstate or 0
|
||||||
@@ -12124,7 +12124,7 @@ end
|
|||||||
-- * 2 = "Red"
|
-- * 2 = "Red"
|
||||||
--
|
--
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number alarmstate Alarm state of group. Default is 0="Auto".
|
-- @param #number alarmstate (Optional) Alarm state of group. Default is 0="Auto".
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SwitchAlarmstate(alarmstate)
|
function OPSGROUP:SwitchAlarmstate(alarmstate)
|
||||||
|
|
||||||
@@ -12171,7 +12171,7 @@ end
|
|||||||
|
|
||||||
--- Set the default EPLRS for the group.
|
--- Set the default EPLRS for the group.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #boolean OnOffSwitch If `true`, EPLRS is on by default. If `false` default EPLRS setting is off. If `nil`, default is on if group has EPLRS and off if it does not have a datalink.
|
-- @param #boolean OnOffSwitch (Optional) If `true`, EPLRS is on by default. If `false` default EPLRS setting is off. If `nil`, default is on if group has EPLRS and off if it does not have a datalink.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetDefaultEPLRS(OnOffSwitch)
|
function OPSGROUP:SetDefaultEPLRS(OnOffSwitch)
|
||||||
|
|
||||||
@@ -12226,7 +12226,7 @@ end
|
|||||||
|
|
||||||
--- Set the default emission state for the group.
|
--- Set the default emission state for the group.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #boolean OnOffSwitch If `true`, EPLRS is on by default. If `false` default EPLRS setting is off. If `nil`, default is on if group has EPLRS and off if it does not have a datalink.
|
-- @param #boolean OnOffSwitch (Optional) If `true`, EPLRS is on by default. If `false` default EPLRS setting is off. If `nil`, default is on if group has EPLRS and off if it does not have a datalink.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetDefaultEmission(OnOffSwitch)
|
function OPSGROUP:SetDefaultEmission(OnOffSwitch)
|
||||||
|
|
||||||
@@ -12281,7 +12281,7 @@ end
|
|||||||
|
|
||||||
--- Set the default invisible for the group.
|
--- Set the default invisible for the group.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #boolean OnOffSwitch If `true`, group is ivisible by default.
|
-- @param #boolean OnOffSwitch (Optional) If `true`, group is ivisible by default.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetDefaultInvisible(OnOffSwitch)
|
function OPSGROUP:SetDefaultInvisible(OnOffSwitch)
|
||||||
|
|
||||||
@@ -12330,7 +12330,7 @@ end
|
|||||||
|
|
||||||
--- Set the default immortal for the group.
|
--- Set the default immortal for the group.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #boolean OnOffSwitch If `true`, group is immortal by default.
|
-- @param #boolean OnOffSwitch (Optional) If `true`, group is immortal by default.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetDefaultImmortal(OnOffSwitch)
|
function OPSGROUP:SetDefaultImmortal(OnOffSwitch)
|
||||||
|
|
||||||
@@ -12382,11 +12382,11 @@ end
|
|||||||
|
|
||||||
--- Set default TACAN parameters.
|
--- Set default TACAN parameters.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Channel TACAN channel. Default is 74.
|
-- @param #number Channel (Optional) TACAN channel. Default is 74.
|
||||||
-- @param #string Morse Morse code. Default "XXX".
|
-- @param #string Morse(Optional) Morse code. Default "XXX".
|
||||||
-- @param #string UnitName Name of the unit acting as beacon.
|
-- @param #string UnitName Name of the unit acting as beacon.
|
||||||
-- @param #string Band TACAN mode. Default is "X" for ground and "Y" for airborne units.
|
-- @param #string Band (Optional) TACAN mode. Default is "X" for ground and "Y" for airborne units.
|
||||||
-- @param #boolean OffSwitch If true, TACAN is off by default.
|
-- @param #boolean OffSwitch (Optional) If true, TACAN is off by default.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetDefaultTACAN(Channel, Morse, UnitName, Band, OffSwitch)
|
function OPSGROUP:SetDefaultTACAN(Channel, Morse, UnitName, Band, OffSwitch)
|
||||||
|
|
||||||
@@ -12415,7 +12415,7 @@ end
|
|||||||
|
|
||||||
--- Activate/switch TACAN beacon settings.
|
--- Activate/switch TACAN beacon settings.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #OPSGROUP.Beacon Tacan TACAN data table. Default is the default TACAN settings.
|
-- @param #OPSGROUP.Beacon Tacan (Optional) TACAN data table. Default is the default TACAN settings.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:_SwitchTACAN(Tacan)
|
function OPSGROUP:_SwitchTACAN(Tacan)
|
||||||
|
|
||||||
@@ -12438,9 +12438,9 @@ end
|
|||||||
--- Activate/switch TACAN beacon settings.
|
--- Activate/switch TACAN beacon settings.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Channel TACAN Channel.
|
-- @param #number Channel TACAN Channel.
|
||||||
-- @param #string Morse TACAN morse code. Default is the value set in @{#OPSGROUP.SetDefaultTACAN} or if not set "XXX".
|
-- @param #string Morse (Optional) TACAN morse code. Default is the value set in @{#OPSGROUP.SetDefaultTACAN} or if not set "XXX".
|
||||||
-- @param #string UnitName Name of the unit in the group which should activate the TACAN beacon. Can also be given as #number to specify the unit number. Default is the first unit of the group.
|
-- @param #string UnitName (Optional) Name of the unit in the group which should activate the TACAN beacon. Can also be given as #number to specify the unit number. Default is the first unit of the group.
|
||||||
-- @param #string Band TACAN channel mode "X" or "Y". Default is "Y" for aircraft and "X" for ground and naval groups.
|
-- @param #string Band (Optional) TACAN channel mode "X" or "Y". Default is "Y" for aircraft and "X" for ground and naval groups.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SwitchTACAN(Channel, Morse, UnitName, Band)
|
function OPSGROUP:SwitchTACAN(Channel, Morse, UnitName, Band)
|
||||||
|
|
||||||
@@ -12547,10 +12547,10 @@ end
|
|||||||
|
|
||||||
--- Set default ICLS parameters.
|
--- Set default ICLS parameters.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Channel ICLS channel. Default is 1.
|
-- @param #number Channel (Optional) ICLS channel. Default is 1.
|
||||||
-- @param #string Morse Morse code. Default "XXX".
|
-- @param #string Morse (Optional) Morse code. Default "XXX".
|
||||||
-- @param #string UnitName Name of the unit acting as beacon.
|
-- @param #string UnitName Name of the unit acting as beacon.
|
||||||
-- @param #boolean OffSwitch If true, TACAN is off by default.
|
-- @param #boolean OffSwitch (Optional) If true, TACAN is off by default.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetDefaultICLS(Channel, Morse, UnitName, OffSwitch)
|
function OPSGROUP:SetDefaultICLS(Channel, Morse, UnitName, OffSwitch)
|
||||||
|
|
||||||
@@ -12593,9 +12593,9 @@ end
|
|||||||
|
|
||||||
--- Activate/switch ICLS beacon settings.
|
--- Activate/switch ICLS beacon settings.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Channel ICLS Channel. Default is what is set in `SetDefaultICLS()` so usually channel 1.
|
-- @param #number Channel (Optional) ICLS Channel. Default is what is set in `SetDefaultICLS()` so usually channel 1.
|
||||||
-- @param #string Morse ICLS morse code. Default is what is set in `SetDefaultICLS()` so usually "XXX".
|
-- @param #string Morse (Optional) ICLS morse code. Default is what is set in `SetDefaultICLS()` so usually "XXX".
|
||||||
-- @param #string UnitName Name of the unit in the group which should activate the ICLS beacon. Can also be given as #number to specify the unit number. Default is the first unit of the group.
|
-- @param #string UnitName (Optional) Name of the unit in the group which should activate the ICLS beacon. Can also be given as #number to specify the unit number. Default is the first unit of the group.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SwitchICLS(Channel, Morse, UnitName)
|
function OPSGROUP:SwitchICLS(Channel, Morse, UnitName)
|
||||||
|
|
||||||
@@ -12669,9 +12669,9 @@ end
|
|||||||
|
|
||||||
--- Set default Radio frequency and modulation.
|
--- Set default Radio frequency and modulation.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Frequency Radio frequency in MHz. Default 251 MHz.
|
-- @param #number Frequency (Optional) Radio frequency in MHz. Default 251 MHz.
|
||||||
-- @param #number Modulation Radio modulation. Default `radio.modulation.AM`.
|
-- @param #number Modulation (Optional) Radio modulation. Default `radio.modulation.AM`.
|
||||||
-- @param #boolean OffSwitch If true, radio is OFF by default.
|
-- @param #boolean OffSwitch (Optional) If true, radio is OFF by default.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetDefaultRadio(Frequency, Modulation, OffSwitch)
|
function OPSGROUP:SetDefaultRadio(Frequency, Modulation, OffSwitch)
|
||||||
|
|
||||||
@@ -12698,8 +12698,8 @@ end
|
|||||||
|
|
||||||
--- Turn radio on or switch frequency/modulation.
|
--- Turn radio on or switch frequency/modulation.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Frequency Radio frequency in MHz. Default is value set in `SetDefaultRadio` (usually 251 MHz).
|
-- @param #number Frequency (Optional) Radio frequency in MHz. Default is value set in `SetDefaultRadio` (usually 251 MHz).
|
||||||
-- @param #number Modulation Radio modulation. Default is value set in `SetDefaultRadio` (usually `radio.modulation.AM`).
|
-- @param #number Modulation (Optional) Radio modulation. Default is value set in `SetDefaultRadio` (usually `radio.modulation.AM`).
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SwitchRadio(Frequency, Modulation)
|
function OPSGROUP:SwitchRadio(Frequency, Modulation)
|
||||||
|
|
||||||
@@ -12778,7 +12778,7 @@ end
|
|||||||
|
|
||||||
--- Switch to a specific formation.
|
--- Switch to a specific formation.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number Formation New formation the group will fly in. Default is the setting of `SetDefaultFormation()`.
|
-- @param #number Formation (Optional) New formation the group will fly in. Default is the setting of `SetDefaultFormation()`.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SwitchFormation(Formation)
|
function OPSGROUP:SwitchFormation(Formation)
|
||||||
|
|
||||||
@@ -12815,7 +12815,7 @@ end
|
|||||||
--- Set default callsign.
|
--- Set default callsign.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number CallsignName Callsign name.
|
-- @param #number CallsignName Callsign name.
|
||||||
-- @param #number CallsignNumber Callsign number. Default 1.
|
-- @param #number CallsignNumber (Optional) Callsign number. Default 1.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:SetDefaultCallsign(CallsignName, CallsignNumber)
|
function OPSGROUP:SetDefaultCallsign(CallsignName, CallsignNumber)
|
||||||
|
|
||||||
@@ -13540,7 +13540,7 @@ end
|
|||||||
--- Get the number of shells a unit or group currently has. For a group the ammo count of all units is summed up.
|
--- Get the number of shells a unit or group currently has. For a group the ammo count of all units is summed up.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param Wrapper.Unit#UNIT unit The unit object.
|
-- @param Wrapper.Unit#UNIT unit The unit object.
|
||||||
-- @param #boolean display Display ammo table as message to all. Default false.
|
-- @param #boolean display (Optional) Display ammo table as message to all. Default false.
|
||||||
-- @return #OPSGROUP.Ammo Ammo data.
|
-- @return #OPSGROUP.Ammo Ammo data.
|
||||||
function OPSGROUP:GetAmmoUnit(unit, display)
|
function OPSGROUP:GetAmmoUnit(unit, display)
|
||||||
|
|
||||||
@@ -13975,7 +13975,7 @@ end
|
|||||||
|
|
||||||
--- Set the template of the group.
|
--- Set the template of the group.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #table Template Template to set. Default is from the GROUP.
|
-- @param #table Template (Optional) Template to set. Default is from the GROUP.
|
||||||
-- @return #OPSGROUP self
|
-- @return #OPSGROUP self
|
||||||
function OPSGROUP:_SetTemplate(Template)
|
function OPSGROUP:_SetTemplate(Template)
|
||||||
|
|
||||||
@@ -14012,8 +14012,8 @@ end
|
|||||||
|
|
||||||
--- Clear waypoints.
|
--- Clear waypoints.
|
||||||
-- @param #OPSGROUP self
|
-- @param #OPSGROUP self
|
||||||
-- @param #number IndexMin Clear waypoints up to this min WP index. Default 1.
|
-- @param #number IndexMin (Optional) Clear waypoints up to this min WP index. Default 1.
|
||||||
-- @param #number IndexMax Clear waypoints up to this max WP index. Default `#self.waypoints`.
|
-- @param #number IndexMax (Optional) Clear waypoints up to this max WP index. Default `#self.waypoints`.
|
||||||
function OPSGROUP:ClearWaypoints(IndexMin, IndexMax)
|
function OPSGROUP:ClearWaypoints(IndexMin, IndexMax)
|
||||||
|
|
||||||
IndexMin=IndexMin or 1
|
IndexMin=IndexMin or 1
|
||||||
|
|||||||
@@ -566,7 +566,7 @@ end
|
|||||||
-- @param #OPSTRANSPORT self
|
-- @param #OPSTRANSPORT self
|
||||||
-- @param Core.Set#SET_GROUP GroupSet Set of groups to be transported. Can also be passed as a single GROUP or OPSGROUP object.
|
-- @param Core.Set#SET_GROUP GroupSet Set of groups to be transported. Can also be passed as a single GROUP or OPSGROUP object.
|
||||||
-- @param #OPSTRANSPORT.TransportZoneCombo TransportZoneCombo Transport zone combo.
|
-- @param #OPSTRANSPORT.TransportZoneCombo TransportZoneCombo Transport zone combo.
|
||||||
-- @param #boolean DisembarkActivation If `true`, cargo group is activated when disembarked. If `false`, cargo groups are late activated when disembarked. Default `nil` (usually activated).
|
-- @param #boolean DisembarkActivation (Optional) If `true`, cargo group is activated when disembarked. If `false`, cargo groups are late activated when disembarked. Default `nil` (usually activated).
|
||||||
-- @param Core.Zone#ZONE DisembarkZone Zone where the groups disembark to.
|
-- @param Core.Zone#ZONE DisembarkZone Zone where the groups disembark to.
|
||||||
-- @param Core.Set#SET_OPSGROUP DisembarkCarriers Carrier groups where the cargo directly disembarks to.
|
-- @param Core.Set#SET_OPSGROUP DisembarkCarriers Carrier groups where the cargo directly disembarks to.
|
||||||
-- @return #OPSTRANSPORT self
|
-- @return #OPSTRANSPORT self
|
||||||
@@ -644,8 +644,8 @@ end
|
|||||||
-- @param Wrapper.Storage#STORAGE StorageTo Storage warehouse to which the cargo is delivered.
|
-- @param Wrapper.Storage#STORAGE StorageTo Storage warehouse to which the cargo is delivered.
|
||||||
-- @param #string CargoType Type of cargo, *e.g.* `"weapons.bombs.Mk_84"` or liquid type as #number.
|
-- @param #string CargoType Type of cargo, *e.g.* `"weapons.bombs.Mk_84"` or liquid type as #number.
|
||||||
-- @param #number CargoAmount Amount of cargo. Liquids in kg.
|
-- @param #number CargoAmount Amount of cargo. Liquids in kg.
|
||||||
-- @param #number CargoWeight Weight of a single cargo item in kg. Default 1 kg.
|
-- @param #number CargoWeight (Optional) Weight of a single cargo item in kg. Default 1 kg.
|
||||||
-- @param #OPSTRANSPORT.TransportZoneCombo TransportZoneCombo Transport zone combo if other than default.
|
-- @param #OPSTRANSPORT.TransportZoneCombo TransportZoneCombo (Optional) Transport zone combo if other than default.
|
||||||
-- @return #OPSTRANSPORT self
|
-- @return #OPSTRANSPORT self
|
||||||
function OPSTRANSPORT:AddCargoStorage(StorageFrom, StorageTo, CargoType, CargoAmount, CargoWeight, TransportZoneCombo)
|
function OPSTRANSPORT:AddCargoStorage(StorageFrom, StorageTo, CargoType, CargoAmount, CargoWeight, TransportZoneCombo)
|
||||||
|
|
||||||
@@ -1052,8 +1052,8 @@ end
|
|||||||
|
|
||||||
--- Set number of required carrier groups for an OPSTRANSPORT assignment. Only used if transport is assigned at **LEGION** or higher level.
|
--- Set number of required carrier groups for an OPSTRANSPORT assignment. Only used if transport is assigned at **LEGION** or higher level.
|
||||||
-- @param #OPSTRANSPORT self
|
-- @param #OPSTRANSPORT self
|
||||||
-- @param #number NcarriersMin Number of carriers *at least* required. Default 1.
|
-- @param #number NcarriersMin (Optional) Number of carriers *at least* required. Default 1.
|
||||||
-- @param #number NcarriersMax Number of carriers *at most* used for transportation. Default is same as `NcarriersMin`.
|
-- @param #number NcarriersMax (Optional) Number of carriers *at most* used for transportation. Default is same as `NcarriersMin`.
|
||||||
-- @return #OPSTRANSPORT self
|
-- @return #OPSTRANSPORT self
|
||||||
function OPSTRANSPORT:SetRequiredCarriers(NcarriersMin, NcarriersMax)
|
function OPSTRANSPORT:SetRequiredCarriers(NcarriersMin, NcarriersMax)
|
||||||
|
|
||||||
@@ -1258,7 +1258,7 @@ end
|
|||||||
|
|
||||||
--- Set transport start and stop time.
|
--- Set transport start and stop time.
|
||||||
-- @param #OPSTRANSPORT self
|
-- @param #OPSTRANSPORT self
|
||||||
-- @param #string ClockStart Time the transport is started, e.g. "05:00" for 5 am. If specified as a #number, it will be relative (in seconds) to the current mission time. Default is 5 seconds after mission was added.
|
-- @param #string ClockStart (Optional) Time the transport is started, e.g. "05:00" for 5 am. If specified as a #number, it will be relative (in seconds) to the current mission time. Default is 5 seconds after mission was added.
|
||||||
-- @param #string ClockStop (Optional) Time the transport is stopped, e.g. "13:00" for 1 pm. If mission could not be started at that time, it will be removed from the queue. If specified as a #number it will be relative (in seconds) to the current mission time.
|
-- @param #string ClockStop (Optional) Time the transport is stopped, e.g. "13:00" for 1 pm. If mission could not be started at that time, it will be removed from the queue. If specified as a #number it will be relative (in seconds) to the current mission time.
|
||||||
-- @return #OPSTRANSPORT self
|
-- @return #OPSTRANSPORT self
|
||||||
function OPSTRANSPORT:SetTime(ClockStart, ClockStop)
|
function OPSTRANSPORT:SetTime(ClockStart, ClockStop)
|
||||||
@@ -1294,9 +1294,9 @@ end
|
|||||||
|
|
||||||
--- Set mission priority and (optional) urgency. Urgent missions can cancel other running missions.
|
--- Set mission priority and (optional) urgency. Urgent missions can cancel other running missions.
|
||||||
-- @param #OPSTRANSPORT self
|
-- @param #OPSTRANSPORT self
|
||||||
-- @param #number Prio Priority 1=high, 100=low. Default 50.
|
-- @param #number Prio (Optional) Priority 1=high, 100=low. Default 50.
|
||||||
-- @param #number Importance Number 1-10. If missions with lower value are in the queue, these have to be finished first. Default is `nil`.
|
-- @param #number Importance (Optional) Number 1-10. If missions with lower value are in the queue, these have to be finished first. Default is `nil`.
|
||||||
-- @param #boolean Urgent If *true*, another running mission might be cancelled if it has a lower priority.
|
-- @param #boolean Urgent (Optional) If *true*, another running mission might be cancelled if it has a lower priority.
|
||||||
-- @return #OPSTRANSPORT self
|
-- @return #OPSTRANSPORT self
|
||||||
function OPSTRANSPORT:SetPriority(Prio, Importance, Urgent)
|
function OPSTRANSPORT:SetPriority(Prio, Importance, Urgent)
|
||||||
self.prio=Prio or 50
|
self.prio=Prio or 50
|
||||||
@@ -1307,7 +1307,7 @@ end
|
|||||||
|
|
||||||
--- Set verbosity.
|
--- Set verbosity.
|
||||||
-- @param #OPSTRANSPORT self
|
-- @param #OPSTRANSPORT self
|
||||||
-- @param #number Verbosity Be more verbose. Default 0
|
-- @param #number Verbosity (Optional) Be more verbose. Default 0
|
||||||
-- @return #OPSTRANSPORT self
|
-- @return #OPSTRANSPORT self
|
||||||
function OPSTRANSPORT:SetVerbosity(Verbosity)
|
function OPSTRANSPORT:SetVerbosity(Verbosity)
|
||||||
self.verbose=Verbosity or 0
|
self.verbose=Verbosity or 0
|
||||||
@@ -1345,8 +1345,8 @@ end
|
|||||||
-- path.
|
-- path.
|
||||||
-- @param #OPSTRANSPORT self
|
-- @param #OPSTRANSPORT self
|
||||||
-- @param Wrapper.Group#GROUP PathGroup A (late activated) GROUP defining a transport path by their waypoints.
|
-- @param Wrapper.Group#GROUP PathGroup A (late activated) GROUP defining a transport path by their waypoints.
|
||||||
-- @param #number Radius Randomization radius in meters. Default 0 m.
|
-- @param #number Radius (Optional) Randomization radius in meters. Default 0 m.
|
||||||
-- @param #OPSTRANSPORT.TransportZoneCombo TransportZoneCombo Transport Zone combo.
|
-- @param #OPSTRANSPORT.TransportZoneCombo TransportZoneCombo (Optional) Transport Zone combo.
|
||||||
-- @return #OPSTRANSPORT self
|
-- @return #OPSTRANSPORT self
|
||||||
function OPSTRANSPORT:AddPathTransport(PathGroup, Reversed, Radius, TransportZoneCombo)
|
function OPSTRANSPORT:AddPathTransport(PathGroup, Reversed, Radius, TransportZoneCombo)
|
||||||
|
|
||||||
@@ -1731,7 +1731,7 @@ end
|
|||||||
|
|
||||||
--- Check if all cargo was delivered (or is dead).
|
--- Check if all cargo was delivered (or is dead).
|
||||||
-- @param #OPSTRANSPORT self
|
-- @param #OPSTRANSPORT self
|
||||||
-- @param #number Nmin Number of groups that must be actually delivered (and are not dead). Default 0.
|
-- @param #number Nmin (Optional) Number of groups that must be actually delivered (and are not dead). Default 0.
|
||||||
-- @return #boolean If true, all possible cargo was delivered.
|
-- @return #boolean If true, all possible cargo was delivered.
|
||||||
function OPSTRANSPORT:IsDelivered(Nmin)
|
function OPSTRANSPORT:IsDelivered(Nmin)
|
||||||
local is=self:is(OPSTRANSPORT.Status.DELIVERED)
|
local is=self:is(OPSTRANSPORT.Status.DELIVERED)
|
||||||
@@ -2298,7 +2298,7 @@ end
|
|||||||
-- @param Wrapper.Storage#STORAGE StorageTo Storage to.
|
-- @param Wrapper.Storage#STORAGE StorageTo Storage to.
|
||||||
-- @param #string CargoType Type of cargo.
|
-- @param #string CargoType Type of cargo.
|
||||||
-- @param #number CargoAmount Total amount of cargo that should be transported. Liquids in kg.
|
-- @param #number CargoAmount Total amount of cargo that should be transported. Liquids in kg.
|
||||||
-- @param #number CargoWeight Weight of a single cargo item in kg. Default 1 kg.
|
-- @param #number CargoWeight (Optional) Weight of a single cargo item in kg. Default 1 kg.
|
||||||
-- @param #OPSTRANSPORT.TransportZoneCombo TransportZoneCombo Transport zone combo.
|
-- @param #OPSTRANSPORT.TransportZoneCombo TransportZoneCombo Transport zone combo.
|
||||||
-- @return Ops.OpsGroup#OPSGROUP.CargoGroup Cargo group data.
|
-- @return Ops.OpsGroup#OPSGROUP.CargoGroup Cargo group data.
|
||||||
function OPSTRANSPORT:_CreateCargoStorage(StorageFrom, StorageTo, CargoType, CargoAmount, CargoWeight, TransportZoneCombo)
|
function OPSTRANSPORT:_CreateCargoStorage(StorageFrom, StorageTo, CargoType, CargoAmount, CargoWeight, TransportZoneCombo)
|
||||||
|
|||||||
@@ -121,7 +121,7 @@ OPSZONE.version="0.6.2"
|
|||||||
--- Create a new OPSZONE class object.
|
--- Create a new OPSZONE class object.
|
||||||
-- @param #OPSZONE self
|
-- @param #OPSZONE self
|
||||||
-- @param Core.Zone#ZONE Zone The zone. Can be passed as ZONE\_RADIUS, ZONE_POLYGON, ZONE\_AIRBASE or simply as the name of the airbase.
|
-- @param Core.Zone#ZONE Zone The zone. Can be passed as ZONE\_RADIUS, ZONE_POLYGON, ZONE\_AIRBASE or simply as the name of the airbase.
|
||||||
-- @param #number CoalitionOwner Initial owner of the coaliton. Default `coalition.side.NEUTRAL`.
|
-- @param #number CoalitionOwner (Optional) Initial owner of the coaliton. Default `coalition.side.NEUTRAL`.
|
||||||
-- @return #OPSZONE self
|
-- @return #OPSZONE self
|
||||||
-- @usage
|
-- @usage
|
||||||
-- myopszone = OPSZONE:New(ZONE:FindByName("OpsZoneOne"), coalition.side.RED) -- base zone from the mission editor
|
-- myopszone = OPSZONE:New(ZONE:FindByName("OpsZoneOne"), coalition.side.RED) -- base zone from the mission editor
|
||||||
@@ -385,7 +385,7 @@ end
|
|||||||
|
|
||||||
--- Set verbosity level.
|
--- Set verbosity level.
|
||||||
-- @param #OPSZONE self
|
-- @param #OPSZONE self
|
||||||
-- @param #number VerbosityLevel Level of output (higher=more). Default 0.
|
-- @param #number VerbosityLevel (Optional) Level of output (higher=more). Default 0.
|
||||||
-- @return #OPSZONE self
|
-- @return #OPSZONE self
|
||||||
function OPSZONE:SetVerbosity(VerbosityLevel)
|
function OPSZONE:SetVerbosity(VerbosityLevel)
|
||||||
self.verbose=VerbosityLevel or 0
|
self.verbose=VerbosityLevel or 0
|
||||||
@@ -400,7 +400,7 @@ end
|
|||||||
-- Which units can capture zones can be further refined by `:SetUnitCategories()`.
|
-- Which units can capture zones can be further refined by `:SetUnitCategories()`.
|
||||||
--
|
--
|
||||||
-- @param #OPSZONE self
|
-- @param #OPSZONE self
|
||||||
-- @param #table Categories Object categories. Default is `{Object.Category.UNIT, Object.Category.STATIC}`.
|
-- @param #table Categories (Optional) Object categories. Default is `{Object.Category.UNIT, Object.Category.STATIC}`.
|
||||||
-- @return #OPSZONE self
|
-- @return #OPSZONE self
|
||||||
function OPSZONE:SetObjectCategories(Categories)
|
function OPSZONE:SetObjectCategories(Categories)
|
||||||
|
|
||||||
@@ -417,7 +417,7 @@ end
|
|||||||
|
|
||||||
--- Set categories of units that can capture or hold the zone. See [DCS Class Unit](https://wiki.hoggitworld.com/view/DCS_Class_Unit).
|
--- Set categories of units that can capture or hold the zone. See [DCS Class Unit](https://wiki.hoggitworld.com/view/DCS_Class_Unit).
|
||||||
-- @param #OPSZONE self
|
-- @param #OPSZONE self
|
||||||
-- @param #table Categories Table of unit categories. Default `{Unit.Category.GROUND_UNIT}`.
|
-- @param #table Categories (Optional) Table of unit categories. Default `{Unit.Category.GROUND_UNIT}`.
|
||||||
-- @return #OPSZONE self
|
-- @return #OPSZONE self
|
||||||
function OPSZONE:SetUnitCategories(Categories)
|
function OPSZONE:SetUnitCategories(Categories)
|
||||||
|
|
||||||
@@ -435,7 +435,7 @@ end
|
|||||||
--- Set threat level threshold that the offending units must have to capture a zone.
|
--- Set threat level threshold that the offending units must have to capture a zone.
|
||||||
-- The reason why you might want to set this is that unarmed units (*e.g.* fuel trucks) should not be able to capture a zone as they do not pose a threat.
|
-- The reason why you might want to set this is that unarmed units (*e.g.* fuel trucks) should not be able to capture a zone as they do not pose a threat.
|
||||||
-- @param #OPSZONE self
|
-- @param #OPSZONE self
|
||||||
-- @param #number Threatlevel Threat level threshold. Default 0.
|
-- @param #number Threatlevel (Optional) Threat level threshold. Default 0.
|
||||||
-- @return #OPSZONE self
|
-- @return #OPSZONE self
|
||||||
function OPSZONE:SetCaptureThreatlevel(Threatlevel)
|
function OPSZONE:SetCaptureThreatlevel(Threatlevel)
|
||||||
|
|
||||||
@@ -446,7 +446,7 @@ end
|
|||||||
|
|
||||||
--- Set how many units must be present in a zone to capture it. By default, one unit is enough.
|
--- Set how many units must be present in a zone to capture it. By default, one unit is enough.
|
||||||
-- @param #OPSZONE self
|
-- @param #OPSZONE self
|
||||||
-- @param #number Nunits Number of units. Default 1.
|
-- @param #number Nunits (Optional) Number of units. Default 1.
|
||||||
-- @return #OPSZONE self
|
-- @return #OPSZONE self
|
||||||
function OPSZONE:SetCaptureNunits(Nunits)
|
function OPSZONE:SetCaptureNunits(Nunits)
|
||||||
|
|
||||||
@@ -460,7 +460,7 @@ end
|
|||||||
|
|
||||||
--- Set time how long an attacking coalition must have troops inside a zone before it captures the zone.
|
--- Set time how long an attacking coalition must have troops inside a zone before it captures the zone.
|
||||||
-- @param #OPSZONE self
|
-- @param #OPSZONE self
|
||||||
-- @param #number Tcapture Time in seconds. Default 0.
|
-- @param #number Tcapture (Optional) Time in seconds. Default 0.
|
||||||
-- @return #OPSZONE self
|
-- @return #OPSZONE self
|
||||||
function OPSZONE:SetCaptureTime(Tcapture)
|
function OPSZONE:SetCaptureTime(Tcapture)
|
||||||
|
|
||||||
|
|||||||
@@ -55,7 +55,7 @@ PLATOON.version="0.1.0"
|
|||||||
--- Create a new PLATOON object and start the FSM.
|
--- Create a new PLATOON object and start the FSM.
|
||||||
-- @param #PLATOON self
|
-- @param #PLATOON self
|
||||||
-- @param #string TemplateGroupName Name of the template group.
|
-- @param #string TemplateGroupName Name of the template group.
|
||||||
-- @param #number Ngroups Number of asset groups of this platoon. Default 3.
|
-- @param #number Ngroups (Optional) Number of asset groups of this platoon. Default 3.
|
||||||
-- @param #string PlatoonName Name of the platoon. Must be **unique**!
|
-- @param #string PlatoonName Name of the platoon. Must be **unique**!
|
||||||
-- @return #PLATOON self
|
-- @return #PLATOON self
|
||||||
function PLATOON:New(TemplateGroupName, Ngroups, PlatoonName)
|
function PLATOON:New(TemplateGroupName, Ngroups, PlatoonName)
|
||||||
|
|||||||
@@ -1542,9 +1542,9 @@ end
|
|||||||
|
|
||||||
--- [User] Set SRS TTS details - see @{Sound.SRS} for details
|
--- [User] Set SRS TTS details - see @{Sound.SRS} for details
|
||||||
-- @param #PLAYERRECCE self
|
-- @param #PLAYERRECCE self
|
||||||
-- @param #number Frequency Frequency to be used. Can also be given as a table of multiple frequencies, e.g. 271 or {127,251}. There needs to be exactly the same number of modulations!
|
-- @param #number Frequency (Optional) Frequency to be used. Can also be given as a table of multiple frequencies, e.g. 271 or {127,251}. There needs to be exactly the same number of modulations!
|
||||||
-- @param #number Modulation Modulation to be used. Can also be given as a table of multiple modulations, e.g. radio.modulation.AM or {radio.modulation.FM,radio.modulation.AM}. There needs to be exactly the same number of frequencies!
|
-- @param #number Modulation (Optional) Modulation to be used. Can also be given as a table of multiple modulations, e.g. radio.modulation.AM or {radio.modulation.FM,radio.modulation.AM}. There needs to be exactly the same number of frequencies!
|
||||||
-- @param #string PathToSRS Defaults to "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
|
-- @param #string PathToSRS (Optional) Defaults to "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
|
||||||
-- @param #string Gender (Optional) Defaults to "male"
|
-- @param #string Gender (Optional) Defaults to "male"
|
||||||
-- @param #string Culture (Optional) Defaults to "en-US"
|
-- @param #string Culture (Optional) Defaults to "en-US"
|
||||||
-- @param #number Port (Optional) Defaults to 5002
|
-- @param #number Port (Optional) Defaults to 5002
|
||||||
|
|||||||
@@ -115,9 +115,9 @@ PLAYERTASK.version="0.1.31"
|
|||||||
-- @param #PLAYERTASK self
|
-- @param #PLAYERTASK self
|
||||||
-- @param Ops.Auftrag#AUFTRAG.Type Type Type of this task
|
-- @param Ops.Auftrag#AUFTRAG.Type Type Type of this task
|
||||||
-- @param Ops.Target#TARGET Target Target for this task
|
-- @param Ops.Target#TARGET Target Target for this task
|
||||||
-- @param #boolean Repeat Repeat this task if true (default = false)
|
-- @param #boolean Repeat (Optional) Repeat this task if true (default = false)
|
||||||
-- @param #number Times Repeat on failure this many times if Repeat is true (default = 1)
|
-- @param #number Times (Optional) Repeat on failure this many times if Repeat is true (default = 1)
|
||||||
-- @param #string TTSType TTS friendly task type name
|
-- @param #string TTSType (Optional) TTS friendly task type name. Defaultsto "close air support".
|
||||||
-- @return #PLAYERTASK self
|
-- @return #PLAYERTASK self
|
||||||
function PLAYERTASK:New(Type, Target, Repeat, Times, TTSType)
|
function PLAYERTASK:New(Type, Target, Repeat, Times, TTSType)
|
||||||
|
|
||||||
@@ -272,8 +272,8 @@ end
|
|||||||
--- Constructor that automatically determines the task type based on the target.
|
--- Constructor that automatically determines the task type based on the target.
|
||||||
-- @param #PLAYERTASK self
|
-- @param #PLAYERTASK self
|
||||||
-- @param Ops.Target#TARGET Target Target for this task
|
-- @param Ops.Target#TARGET Target Target for this task
|
||||||
-- @param #boolean Repeat Repeat this task if true (default = false)
|
-- @param #boolean Repeat (Optional) Repeat this task if true (default = false)
|
||||||
-- @param #number Times Repeat on failure this many times if Repeat is true (default = 1)
|
-- @param #number Times (Optional) Repeat on failure this many times if Repeat is true (default = 1)
|
||||||
-- @param #string TTSType TTS friendly task type name
|
-- @param #string TTSType TTS friendly task type name
|
||||||
-- @return #PLAYERTASK self
|
-- @return #PLAYERTASK self
|
||||||
function PLAYERTASK:NewFromTarget(Target, Repeat, Times, TTSType)
|
function PLAYERTASK:NewFromTarget(Target, Repeat, Times, TTSType)
|
||||||
@@ -486,7 +486,7 @@ end
|
|||||||
|
|
||||||
--- [USER] Set if a task can have a smoke marker.
|
--- [USER] Set if a task can have a smoke marker.
|
||||||
-- @param #PLAYERTASK self
|
-- @param #PLAYERTASK self
|
||||||
-- @param #boolean OnOff If true (default) it can be smoke, false if not.
|
-- @param #boolean OnOff (Optional) If true (default) it can be smoke, false if not.
|
||||||
-- @return #PLAYERTASK self
|
-- @return #PLAYERTASK self
|
||||||
function PLAYERTASK:SetCanSmoke(OnOff)
|
function PLAYERTASK:SetCanSmoke(OnOff)
|
||||||
self:T(self.lid.."AddSSetCanSmokeubType")
|
self:T(self.lid.."AddSSetCanSmokeubType")
|
||||||
@@ -496,7 +496,7 @@ end
|
|||||||
|
|
||||||
--- [USER] Set if a task can show threat details.
|
--- [USER] Set if a task can show threat details.
|
||||||
-- @param #PLAYERTASK self
|
-- @param #PLAYERTASK self
|
||||||
-- @param #boolean OnOff If true (default) it can be shown, false if not.
|
-- @param #boolean OnOff (Optional) If true (default) it can be shown, false if not.
|
||||||
-- @return #PLAYERTASK self
|
-- @return #PLAYERTASK self
|
||||||
function PLAYERTASK:SetShowThreatDetails(OnOff)
|
function PLAYERTASK:SetShowThreatDetails(OnOff)
|
||||||
self:T(self.lid.."SetShowThreatDetails")
|
self:T(self.lid.."SetShowThreatDetails")
|
||||||
@@ -686,7 +686,7 @@ end
|
|||||||
|
|
||||||
--- [USER] Adds a time limit for the task to be completed.
|
--- [USER] Adds a time limit for the task to be completed.
|
||||||
-- @param #PLAYERTASK self
|
-- @param #PLAYERTASK self
|
||||||
-- @param #number TimeLimit Time limit in seconds for the task to be completed. (Default 0 = no time limit)
|
-- @param #number TimeLimit (Optional) Time limit in seconds for the task to be completed. (Default 0 = no time limit)
|
||||||
-- @return #PLAYERTASK self
|
-- @return #PLAYERTASK self
|
||||||
-- @usage
|
-- @usage
|
||||||
-- local mytask = PLAYERTASK:New(AUFTRAG.Type.RECON, ZONE:New("WF Zone"), true, 50, "Deep Earth")
|
-- local mytask = PLAYERTASK:New(AUFTRAG.Type.RECON, ZONE:New("WF Zone"), true, 50, "Deep Earth")
|
||||||
@@ -892,7 +892,7 @@ end
|
|||||||
|
|
||||||
--- [User] Smoke Target
|
--- [User] Smoke Target
|
||||||
-- @param #PLAYERTASK self
|
-- @param #PLAYERTASK self
|
||||||
-- @param #number Color, defaults to SMOKECOLOR.Red
|
-- @param #number Color (Optional) Color, defaults to SMOKECOLOR.Red
|
||||||
-- @return #PLAYERTASK self
|
-- @return #PLAYERTASK self
|
||||||
function PLAYERTASK:SmokeTarget(Color)
|
function PLAYERTASK:SmokeTarget(Color)
|
||||||
self:T(self.lid.."SmokeTarget")
|
self:T(self.lid.."SmokeTarget")
|
||||||
@@ -911,7 +911,7 @@ end
|
|||||||
|
|
||||||
--- [User] Flare Target
|
--- [User] Flare Target
|
||||||
-- @param #PLAYERTASK self
|
-- @param #PLAYERTASK self
|
||||||
-- @param #number Color, defaults to FLARECOLOR.Red
|
-- @param #number Color (Optional) Color, defaults to FLARECOLOR.Red
|
||||||
-- @return #PLAYERTASK self
|
-- @return #PLAYERTASK self
|
||||||
function PLAYERTASK:FlareTarget(Color)
|
function PLAYERTASK:FlareTarget(Color)
|
||||||
self:T(self.lid.."SmokeTarget")
|
self:T(self.lid.."SmokeTarget")
|
||||||
@@ -927,8 +927,8 @@ end
|
|||||||
|
|
||||||
--- [User] Illuminate Target Area
|
--- [User] Illuminate Target Area
|
||||||
-- @param #PLAYERTASK self
|
-- @param #PLAYERTASK self
|
||||||
-- @param #number Power Power of illumination bomb in Candela. Default 1000 cd.
|
-- @param #number Power (Optional) Power of illumination bomb in Candela. Default 1000 cd.
|
||||||
-- @param #number Height Height above target used to release the bomb, default 150m.
|
-- @param #number Height (Optional) Height above target used to release the bomb, default 150m.
|
||||||
-- @return #PLAYERTASK self
|
-- @return #PLAYERTASK self
|
||||||
function PLAYERTASK:IlluminateTarget(Power,Height)
|
function PLAYERTASK:IlluminateTarget(Power,Height)
|
||||||
self:T(self.lid.."IlluminateTarget")
|
self:T(self.lid.."IlluminateTarget")
|
||||||
@@ -2021,9 +2021,9 @@ PLAYERTASKCONTROLLER.version="0.1.73"
|
|||||||
--- Create and run a new TASKCONTROLLER instance.
|
--- Create and run a new TASKCONTROLLER instance.
|
||||||
-- @param #PLAYERTASKCONTROLLER self
|
-- @param #PLAYERTASKCONTROLLER self
|
||||||
-- @param #string Name Name of this controller
|
-- @param #string Name Name of this controller
|
||||||
-- @param #number Coalition of this controller, e.g. coalition.side.BLUE
|
-- @param #number Coalition (Optional) Coalition of this controller. Defaults to coalition.side.BLUE
|
||||||
-- @param #string Type Type of the tasks controlled, defaults to PLAYERTASKCONTROLLER.Type.A2G
|
-- @param #string Type (Optional) Type of the tasks controlled, defaults to PLAYERTASKCONTROLLER.Type.A2G
|
||||||
-- @param #string ClientFilter (optional) Additional prefix filter for the SET_CLIENT. Can be handed as @{Core.Set#SET_CLIENT} also.
|
-- @param #string ClientFilter (Optional) Additional prefix filter for the SET_CLIENT. Can be handed as @{Core.Set#SET_CLIENT} also.
|
||||||
-- @return #PLAYERTASKCONTROLLER self
|
-- @return #PLAYERTASKCONTROLLER self
|
||||||
function PLAYERTASKCONTROLLER:New(Name, Coalition, Type, ClientFilter)
|
function PLAYERTASKCONTROLLER:New(Name, Coalition, Type, ClientFilter)
|
||||||
|
|
||||||
@@ -2317,7 +2317,7 @@ end
|
|||||||
|
|
||||||
--- [User] Set flash directions option for player (player based info)
|
--- [User] Set flash directions option for player (player based info)
|
||||||
-- @param #PLAYERTASKCONTROLLER self
|
-- @param #PLAYERTASKCONTROLLER self
|
||||||
-- @param #boolean OnOff Set to `true` to switch on and `false` to switch off. Default is OFF.
|
-- @param #boolean OnOff (Optional) Set to `true` to switch on and `false` to switch off. Default is OFF.
|
||||||
-- @return #PLAYERTASKCONTROLLER self
|
-- @return #PLAYERTASKCONTROLLER self
|
||||||
function PLAYERTASKCONTROLLER:SetAllowFlashDirection(OnOff)
|
function PLAYERTASKCONTROLLER:SetAllowFlashDirection(OnOff)
|
||||||
self:T(self.lid.."SetAllowFlashDirection")
|
self:T(self.lid.."SetAllowFlashDirection")
|
||||||
@@ -2327,7 +2327,7 @@ end
|
|||||||
|
|
||||||
--- [User] Set to show a menu entry to retrieve the radio frequencies used.
|
--- [User] Set to show a menu entry to retrieve the radio frequencies used.
|
||||||
-- @param #PLAYERTASKCONTROLLER self
|
-- @param #PLAYERTASKCONTROLLER self
|
||||||
-- @param #boolean OnOff Set to `true` to switch on and `false` to switch off. Default is OFF.
|
-- @param #boolean OnOff (Optional) Set to `true` to switch on and `false` to switch off. Default is OFF.
|
||||||
-- @return #PLAYERTASKCONTROLLER self
|
-- @return #PLAYERTASKCONTROLLER self
|
||||||
function PLAYERTASKCONTROLLER:SetShowRadioInfoMenu(OnOff)
|
function PLAYERTASKCONTROLLER:SetShowRadioInfoMenu(OnOff)
|
||||||
self:T(self.lid.."SetAllowRadioInfoMenu")
|
self:T(self.lid.."SetAllowRadioInfoMenu")
|
||||||
@@ -2436,8 +2436,8 @@ end
|
|||||||
|
|
||||||
--- [User] Set repetition options for tasks.
|
--- [User] Set repetition options for tasks.
|
||||||
-- @param #PLAYERTASKCONTROLLER self
|
-- @param #PLAYERTASKCONTROLLER self
|
||||||
-- @param #boolean OnOff Set to `true` to switch on and `false` to switch off (defaults to true)
|
-- @param #boolean OnOff (Optional) Set to `true` to switch on and `false` to switch off (defaults to true)
|
||||||
-- @param #number Repeats Number of repeats (defaults to 5)
|
-- @param #number Repeats (Optional) Number of repeats (defaults to 5)
|
||||||
-- @return #PLAYERTASKCONTROLLER self
|
-- @return #PLAYERTASKCONTROLLER self
|
||||||
-- @usage `taskmanager:SetTaskRepetition(true, 5)`
|
-- @usage `taskmanager:SetTaskRepetition(true, 5)`
|
||||||
function PLAYERTASKCONTROLLER:SetTaskRepetition(OnOff, Repeats)
|
function PLAYERTASKCONTROLLER:SetTaskRepetition(OnOff, Repeats)
|
||||||
@@ -2454,7 +2454,7 @@ end
|
|||||||
|
|
||||||
--- [User] Set how long the briefing is shown on screen.
|
--- [User] Set how long the briefing is shown on screen.
|
||||||
-- @param #PLAYERTASKCONTROLLER self
|
-- @param #PLAYERTASKCONTROLLER self
|
||||||
-- @param #number Seconds Duration in seconds. Defaults to 30 seconds.
|
-- @param #number Seconds (Optional) Duration in seconds. Defaults to 30 seconds.
|
||||||
-- @return #PLAYERTASKCONTROLLER self
|
-- @return #PLAYERTASKCONTROLLER self
|
||||||
function PLAYERTASKCONTROLLER:SetBriefingDuration(Seconds)
|
function PLAYERTASKCONTROLLER:SetBriefingDuration(Seconds)
|
||||||
self:T(self.lid.."SetBriefingDuration")
|
self:T(self.lid.."SetBriefingDuration")
|
||||||
@@ -2484,7 +2484,7 @@ end
|
|||||||
-- @param #PLAYERTASKCONTROLLER self
|
-- @param #PLAYERTASKCONTROLLER self
|
||||||
-- @param Ops.FlightGroup#FLIGHTGROUP FlightGroup The FlightGroup (e.g. drone) to be used for lasing (one unit in one group only).
|
-- @param Ops.FlightGroup#FLIGHTGROUP FlightGroup The FlightGroup (e.g. drone) to be used for lasing (one unit in one group only).
|
||||||
-- Can optionally be handed as Ops.ArmyGroup#ARMYGROUP - **Note** might not find an LOS spot or get lost on the way. Cannot island-hop.
|
-- Can optionally be handed as Ops.ArmyGroup#ARMYGROUP - **Note** might not find an LOS spot or get lost on the way. Cannot island-hop.
|
||||||
-- @param #number LaserCode The lasercode to be used. Defaults to 1688.
|
-- @param #number LaserCode (Optional) The lasercode to be used. Defaults to 1688.
|
||||||
-- @param Core.Point#COORDINATE HoldingPoint (Optional) Point where the drone should initially circle. If not set, defaults to BullsEye of the coalition.
|
-- @param Core.Point#COORDINATE HoldingPoint (Optional) Point where the drone should initially circle. If not set, defaults to BullsEye of the coalition.
|
||||||
-- @param #number Alt (Optional) Altitude in feet. Only applies if using a FLIGHTGROUP object! Defaults to 10000.
|
-- @param #number Alt (Optional) Altitude in feet. Only applies if using a FLIGHTGROUP object! Defaults to 10000.
|
||||||
-- @param #number Speed (Optional) Speed in knots. Only applies if using a FLIGHTGROUP object! Defaults to 120.
|
-- @param #number Speed (Optional) Speed in knots. Only applies if using a FLIGHTGROUP object! Defaults to 120.
|
||||||
@@ -2567,7 +2567,7 @@ end
|
|||||||
-- @param #PLAYERTASKCONTROLLER self
|
-- @param #PLAYERTASKCONTROLLER self
|
||||||
-- @param Ops.FlightGroup#FLIGHTGROUP FlightGroup The FlightGroup (e.g. drone) to be used for lasing (one unit in one group only).
|
-- @param Ops.FlightGroup#FLIGHTGROUP FlightGroup The FlightGroup (e.g. drone) to be used for lasing (one unit in one group only).
|
||||||
-- Can optionally be handed as Ops.ArmyGroup#ARMYGROUP - **Note** might not find an LOS spot or get lost on the way. Cannot island-hop.
|
-- Can optionally be handed as Ops.ArmyGroup#ARMYGROUP - **Note** might not find an LOS spot or get lost on the way. Cannot island-hop.
|
||||||
-- @param #number LaserCode The lasercode to be used. Defaults to 1688.
|
-- @param #number LaserCode (Optional) The lasercode to be used. Defaults to 1688.
|
||||||
-- @param Core.Point#COORDINATE HoldingPoint (Optional) Point where the drone should initially circle. If not set, defaults to BullsEye of the coalition.
|
-- @param Core.Point#COORDINATE HoldingPoint (Optional) Point where the drone should initially circle. If not set, defaults to BullsEye of the coalition.
|
||||||
-- @param #number Alt (Optional) Altitude in feet. Only applies if using a FLIGHTGROUP object! Defaults to 10000.
|
-- @param #number Alt (Optional) Altitude in feet. Only applies if using a FLIGHTGROUP object! Defaults to 10000.
|
||||||
-- @param #number Speed (Optional) Speed in knots. Only applies if using a FLIGHTGROUP object! Defaults to 120.
|
-- @param #number Speed (Optional) Speed in knots. Only applies if using a FLIGHTGROUP object! Defaults to 120.
|
||||||
@@ -2704,8 +2704,8 @@ end
|
|||||||
-- @param #PLAYERTASKCONTROLLER self
|
-- @param #PLAYERTASKCONTROLLER self
|
||||||
-- @param #boolean InfoMenu If `true` this option will allow to show the Task Info-Menu also when a player has an active task.
|
-- @param #boolean InfoMenu If `true` this option will allow to show the Task Info-Menu also when a player has an active task.
|
||||||
-- Since the menu isn't refreshed if a player holds an active task, the info in there might be stale.
|
-- Since the menu isn't refreshed if a player holds an active task, the info in there might be stale.
|
||||||
-- @param #number ItemLimit Number of items per task type to show, default 5.
|
-- @param #number ItemLimit (Optional) Number of items per task type to show, default 5.
|
||||||
-- @param #number HoldTime Minimum number of seconds between menu refreshes (called every 30 secs) if a player has **no active task**.
|
-- @param #number HoldTime (Optional) Minimum number of seconds between menu refreshes (called every 30 secs) if a player has **no active task**.
|
||||||
-- @return #PLAYERTASKCONTROLLER self
|
-- @return #PLAYERTASKCONTROLLER self
|
||||||
function PLAYERTASKCONTROLLER:SetMenuOptions(InfoMenu,ItemLimit,HoldTime)
|
function PLAYERTASKCONTROLLER:SetMenuOptions(InfoMenu,ItemLimit,HoldTime)
|
||||||
self:T(self.lid.."SetMenuOptions")
|
self:T(self.lid.."SetMenuOptions")
|
||||||
@@ -2840,7 +2840,7 @@ end
|
|||||||
|
|
||||||
--- [User] Set target radius. Determines the zone radius to distinguish CAS from BAI tasks and to find enemies if the TARGET object is a COORDINATE.
|
--- [User] Set target radius. Determines the zone radius to distinguish CAS from BAI tasks and to find enemies if the TARGET object is a COORDINATE.
|
||||||
-- @param #PLAYERTASKCONTROLLER self
|
-- @param #PLAYERTASKCONTROLLER self
|
||||||
-- @param #number Radius Radius to use in meters. Defaults to 500 meters.
|
-- @param #number Radius (Optional) Radius to use in meters. Defaults to 500 meters.
|
||||||
-- @return #PLAYERTASKCONTROLLER self
|
-- @return #PLAYERTASKCONTROLLER self
|
||||||
function PLAYERTASKCONTROLLER:SetTargetRadius(Radius)
|
function PLAYERTASKCONTROLLER:SetTargetRadius(Radius)
|
||||||
self:T(self.lid.."SetTargetRadius")
|
self:T(self.lid.."SetTargetRadius")
|
||||||
@@ -2851,7 +2851,7 @@ end
|
|||||||
--- [User] Set the cluster radius if you want to use target clusters rather than single group detection.
|
--- [User] Set the cluster radius if you want to use target clusters rather than single group detection.
|
||||||
-- Note that for a controller type A2A target clustering is on by default. Also remember that the diameter of the resulting zone is double the radius.
|
-- Note that for a controller type A2A target clustering is on by default. Also remember that the diameter of the resulting zone is double the radius.
|
||||||
-- @param #PLAYERTASKCONTROLLER self
|
-- @param #PLAYERTASKCONTROLLER self
|
||||||
-- @param #number Radius Target cluster radius in kilometers. Default is 0.5km.
|
-- @param #number Radius (Optional) Target cluster radius in kilometers. Default is 0.5km.
|
||||||
-- @return #PLAYERTASKCONTROLLER self
|
-- @return #PLAYERTASKCONTROLLER self
|
||||||
function PLAYERTASKCONTROLLER:SetClusterRadius(Radius)
|
function PLAYERTASKCONTROLLER:SetClusterRadius(Radius)
|
||||||
self:T(self.lid.."SetClusterRadius")
|
self:T(self.lid.."SetClusterRadius")
|
||||||
@@ -2873,7 +2873,7 @@ end
|
|||||||
|
|
||||||
--- [User] Switch usage of target names for menu entries on or off
|
--- [User] Switch usage of target names for menu entries on or off
|
||||||
-- @param #PLAYERTASKCONTROLLER self
|
-- @param #PLAYERTASKCONTROLLER self
|
||||||
-- @param #boolean OnOff If true, set to on (default), if nil or false, set to off
|
-- @param #boolean OnOff (Optional) If true, set to on (default), if nil or false, set to off
|
||||||
-- @return #PLAYERTASKCONTROLLER self
|
-- @return #PLAYERTASKCONTROLLER self
|
||||||
function PLAYERTASKCONTROLLER:SwitchUseGroupNames(OnOff)
|
function PLAYERTASKCONTROLLER:SwitchUseGroupNames(OnOff)
|
||||||
self:T(self.lid.."SwitchUseGroupNames")
|
self:T(self.lid.."SwitchUseGroupNames")
|
||||||
@@ -2887,7 +2887,7 @@ end
|
|||||||
|
|
||||||
--- [User] Switch showing additional magnetic angles
|
--- [User] Switch showing additional magnetic angles
|
||||||
-- @param #PLAYERTASKCONTROLLER self
|
-- @param #PLAYERTASKCONTROLLER self
|
||||||
-- @param #boolean OnOff If true, set to on (default), if nil or false, set to off
|
-- @param #boolean OnOff (Optional) If true, set to on (default), if nil or false, set to off
|
||||||
-- @return #PLAYERTASKCONTROLLER self
|
-- @return #PLAYERTASKCONTROLLER self
|
||||||
function PLAYERTASKCONTROLLER:SwitchMagenticAngles(OnOff)
|
function PLAYERTASKCONTROLLER:SwitchMagenticAngles(OnOff)
|
||||||
self:T(self.lid.."SwitchMagenticAngles")
|
self:T(self.lid.."SwitchMagenticAngles")
|
||||||
@@ -3782,7 +3782,7 @@ end
|
|||||||
--- Calculate group future position after given seconds.
|
--- Calculate group future position after given seconds.
|
||||||
-- @param #PLAYERTASKCONTROLLER self
|
-- @param #PLAYERTASKCONTROLLER self
|
||||||
-- @param Wrapper.Group#GROUP group The group to calculate for.
|
-- @param Wrapper.Group#GROUP group The group to calculate for.
|
||||||
-- @param #number seconds Time interval in seconds. Default is `self.prediction`.
|
-- @param #number seconds (Optional) Time interval in seconds. Default is `self.prediction`.
|
||||||
-- @return Core.Point#COORDINATE Calculated future position of the cluster.
|
-- @return Core.Point#COORDINATE Calculated future position of the cluster.
|
||||||
function PLAYERTASKCONTROLLER:_CalcGroupFuturePosition(group, seconds)
|
function PLAYERTASKCONTROLLER:_CalcGroupFuturePosition(group, seconds)
|
||||||
|
|
||||||
@@ -4898,9 +4898,9 @@ end
|
|||||||
|
|
||||||
--- [User] Set SRS TTS details - see @{Sound.SRS} for details.`SetSRS()` will try to use as many attributes configured with @{Sound.SRS#MSRS.LoadConfigFile}() as possible.
|
--- [User] Set SRS TTS details - see @{Sound.SRS} for details.`SetSRS()` will try to use as many attributes configured with @{Sound.SRS#MSRS.LoadConfigFile}() as possible.
|
||||||
-- @param #PLAYERTASKCONTROLLER self
|
-- @param #PLAYERTASKCONTROLLER self
|
||||||
-- @param #number Frequency Frequency to be used. Can also be given as a table of multiple frequencies, e.g. 271 or {127,251}. There needs to be exactly the same number of modulations!
|
-- @param #number Frequency (Optional) Frequency to be used. Can also be given as a table of multiple frequencies, e.g. 271 or {127,251}. There needs to be exactly the same number of modulations!
|
||||||
-- @param #number Modulation Modulation to be used. Can also be given as a table of multiple modulations, e.g. radio.modulation.AM or {radio.modulation.FM,radio.modulation.AM}. There needs to be exactly the same number of frequencies!
|
-- @param #number Modulation (Optional) Modulation to be used. Can also be given as a table of multiple modulations, e.g. radio.modulation.AM or {radio.modulation.FM,radio.modulation.AM}. There needs to be exactly the same number of frequencies!
|
||||||
-- @param #string PathToSRS Defaults to "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
|
-- @param #string PathToSRS (Optional) Defaults to "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
|
||||||
-- @param #string Gender (Optional) Defaults to "male"
|
-- @param #string Gender (Optional) Defaults to "male"
|
||||||
-- @param #string Culture (Optional) Defaults to "en-US"
|
-- @param #string Culture (Optional) Defaults to "en-US"
|
||||||
-- @param #number Port (Optional) Defaults to 5002
|
-- @param #number Port (Optional) Defaults to 5002
|
||||||
@@ -4909,7 +4909,7 @@ end
|
|||||||
-- @param #number Volume (Optional) Volume - between 0.0 (silent) and 1.0 (loudest)
|
-- @param #number Volume (Optional) Volume - between 0.0 (silent) and 1.0 (loudest)
|
||||||
-- @param #string PathToGoogleKey (Optional) Path to your google key if you want to use google TTS; if you use a config file for MSRS, hand in nil here.
|
-- @param #string PathToGoogleKey (Optional) Path to your google key if you want to use google TTS; if you use a config file for MSRS, hand in nil here.
|
||||||
-- @param #string AccessKey (Optional) Your Google API access key. This is necessary if DCS-gRPC is used as backend; if you use a config file for MSRS, hand in nil here.
|
-- @param #string AccessKey (Optional) Your Google API access key. This is necessary if DCS-gRPC is used as backend; if you use a config file for MSRS, hand in nil here.
|
||||||
-- @param Core.Point#COORDINATE Coordinate Coordinate from which the controller radio is sending
|
-- @param Core.Point#COORDINATE Coordinate (Optional) Coordinate from which the controller radio is sending
|
||||||
-- @param #string Backend (Optional) MSRS Backend to be used, can be MSRS.Backend.SRSEXE or MSRS.Backend.GRPC; if you use a config file for MSRS, hand in nil here.
|
-- @param #string Backend (Optional) MSRS Backend to be used, can be MSRS.Backend.SRSEXE or MSRS.Backend.GRPC; if you use a config file for MSRS, hand in nil here.
|
||||||
-- @return #PLAYERTASKCONTROLLER self
|
-- @return #PLAYERTASKCONTROLLER self
|
||||||
function PLAYERTASKCONTROLLER:SetSRS(Frequency,Modulation,PathToSRS,Gender,Culture,Port,Voice,Volume,PathToGoogleKey,AccessKey,Coordinate,Backend)
|
function PLAYERTASKCONTROLLER:SetSRS(Frequency,Modulation,PathToSRS,Gender,Culture,Port,Voice,Volume,PathToGoogleKey,AccessKey,Coordinate,Backend)
|
||||||
|
|||||||
@@ -564,7 +564,7 @@ end
|
|||||||
|
|
||||||
--- Set the speed the tanker flys in its orbit pattern.
|
--- Set the speed the tanker flys in its orbit pattern.
|
||||||
-- @param #RECOVERYTANKER self
|
-- @param #RECOVERYTANKER self
|
||||||
-- @param #number speed True air speed (TAS) in knots. Default 274 knots, which results in ~250 KIAS.
|
-- @param #number speed (Optional) True air speed (TAS) in knots. Default 274 knots, which results in ~250 KIAS.
|
||||||
-- @return #RECOVERYTANKER self
|
-- @return #RECOVERYTANKER self
|
||||||
function RECOVERYTANKER:SetSpeed(speed)
|
function RECOVERYTANKER:SetSpeed(speed)
|
||||||
self.speed=UTILS.KnotsToMps(speed or 274)
|
self.speed=UTILS.KnotsToMps(speed or 274)
|
||||||
@@ -573,7 +573,7 @@ end
|
|||||||
|
|
||||||
--- Set orbit pattern altitude of the tanker.
|
--- Set orbit pattern altitude of the tanker.
|
||||||
-- @param #RECOVERYTANKER self
|
-- @param #RECOVERYTANKER self
|
||||||
-- @param #number altitude Tanker altitude in feet. Default 6000 ft.
|
-- @param #number altitude (Optional) Tanker altitude in feet. Default 6000 ft.
|
||||||
-- @return #RECOVERYTANKER self
|
-- @return #RECOVERYTANKER self
|
||||||
function RECOVERYTANKER:SetAltitude(altitude)
|
function RECOVERYTANKER:SetAltitude(altitude)
|
||||||
self.altitude=UTILS.FeetToMeters(altitude or 6000)
|
self.altitude=UTILS.FeetToMeters(altitude or 6000)
|
||||||
@@ -582,8 +582,8 @@ end
|
|||||||
|
|
||||||
--- Set race-track distances.
|
--- Set race-track distances.
|
||||||
-- @param #RECOVERYTANKER self
|
-- @param #RECOVERYTANKER self
|
||||||
-- @param #number distbow Distance [NM] in front of the carrier. Default 10 NM.
|
-- @param #number distbow (Optional) Distance [NM] in front of the carrier. Default 10 NM.
|
||||||
-- @param #number diststern Distance [NM] behind the carrier. Default 4 NM.
|
-- @param #number diststern (Optional) Distance [NM] behind the carrier. Default 4 NM.
|
||||||
-- @return #RECOVERYTANKER self
|
-- @return #RECOVERYTANKER self
|
||||||
function RECOVERYTANKER:SetRacetrackDistances(distbow, diststern)
|
function RECOVERYTANKER:SetRacetrackDistances(distbow, diststern)
|
||||||
self.distBow=UTILS.NMToMeters(distbow or 10)
|
self.distBow=UTILS.NMToMeters(distbow or 10)
|
||||||
@@ -593,7 +593,7 @@ end
|
|||||||
|
|
||||||
--- Set minimum pattern update interval. After a pattern update this time interval has to pass before the next update is allowed.
|
--- Set minimum pattern update interval. After a pattern update this time interval has to pass before the next update is allowed.
|
||||||
-- @param #RECOVERYTANKER self
|
-- @param #RECOVERYTANKER self
|
||||||
-- @param #number interval Min interval in minutes. Default is 10 minutes.
|
-- @param #number interval(Optional) Min interval in minutes. Default is 10 minutes.
|
||||||
-- @return #RECOVERYTANKER self
|
-- @return #RECOVERYTANKER self
|
||||||
function RECOVERYTANKER:SetPatternUpdateInterval(interval)
|
function RECOVERYTANKER:SetPatternUpdateInterval(interval)
|
||||||
self.dTupdate=(interval or 10)*60
|
self.dTupdate=(interval or 10)*60
|
||||||
@@ -602,7 +602,7 @@ end
|
|||||||
|
|
||||||
--- Set pattern update distance threshold. Tanker will update its pattern when the carrier changes its position by more than this distance.
|
--- Set pattern update distance threshold. Tanker will update its pattern when the carrier changes its position by more than this distance.
|
||||||
-- @param #RECOVERYTANKER self
|
-- @param #RECOVERYTANKER self
|
||||||
-- @param #number distancechange Distance threshold in NM. Default 5 NM (=9.62 km).
|
-- @param #number distancechange (Optional) Distance threshold in NM. Default 5 NM (=9.62 km).
|
||||||
-- @return #RECOVERYTANKER self
|
-- @return #RECOVERYTANKER self
|
||||||
function RECOVERYTANKER:SetPatternUpdateDistance(distancechange)
|
function RECOVERYTANKER:SetPatternUpdateDistance(distancechange)
|
||||||
self.Dupdate=UTILS.NMToMeters(distancechange or 5)
|
self.Dupdate=UTILS.NMToMeters(distancechange or 5)
|
||||||
@@ -611,7 +611,7 @@ end
|
|||||||
|
|
||||||
--- Set pattern update heading threshold. Tanker will update its pattern when the carrier changes its heading by more than this value.
|
--- Set pattern update heading threshold. Tanker will update its pattern when the carrier changes its heading by more than this value.
|
||||||
-- @param #RECOVERYTANKER self
|
-- @param #RECOVERYTANKER self
|
||||||
-- @param #number headingchange Heading threshold in degrees. Default 5 degrees.
|
-- @param #number headingchange (Optional) Heading threshold in degrees. Default 5 degrees.
|
||||||
-- @return #RECOVERYTANKER self
|
-- @return #RECOVERYTANKER self
|
||||||
function RECOVERYTANKER:SetPatternUpdateHeading(headingchange)
|
function RECOVERYTANKER:SetPatternUpdateHeading(headingchange)
|
||||||
self.Hupdate=headingchange or 5
|
self.Hupdate=headingchange or 5
|
||||||
@@ -620,7 +620,7 @@ end
|
|||||||
|
|
||||||
--- Set low fuel state of tanker. When fuel is below this threshold, the tanker will RTB or be respawned if takeoff type is in air.
|
--- Set low fuel state of tanker. When fuel is below this threshold, the tanker will RTB or be respawned if takeoff type is in air.
|
||||||
-- @param #RECOVERYTANKER self
|
-- @param #RECOVERYTANKER self
|
||||||
-- @param #number fuelthreshold Low fuel threshold in percent. Default 10 % of max fuel.
|
-- @param #number fuelthreshold (Optional) Low fuel threshold in percent. Default 10 % of max fuel.
|
||||||
-- @return #RECOVERYTANKER self
|
-- @return #RECOVERYTANKER self
|
||||||
function RECOVERYTANKER:SetLowFuelThreshold(fuelthreshold)
|
function RECOVERYTANKER:SetLowFuelThreshold(fuelthreshold)
|
||||||
self.lowfuel=fuelthreshold or 10
|
self.lowfuel=fuelthreshold or 10
|
||||||
@@ -794,9 +794,9 @@ end
|
|||||||
|
|
||||||
--- Set TACAN channel of tanker. Note that mode is automatically set to "Y" for AA TACAN since only that works.
|
--- Set TACAN channel of tanker. Note that mode is automatically set to "Y" for AA TACAN since only that works.
|
||||||
-- @param #RECOVERYTANKER self
|
-- @param #RECOVERYTANKER self
|
||||||
-- @param #number channel TACAN channel. Default 1.
|
-- @param #number channel (Optional) TACAN channel. Default 1.
|
||||||
-- @param #string morse TACAN morse code identifier. Three letters. Default "TKR".
|
-- @param #string morse (Optional) TACAN morse code identifier. Three letters. Default "TKR".
|
||||||
-- @param #string mode TACAN mode, which can be either "Y" (default) or "X".
|
-- @param #string mode (Optional) TACAN mode, which can be either "Y" (default) or "X".
|
||||||
-- @return #RECOVERYTANKER self
|
-- @return #RECOVERYTANKER self
|
||||||
function RECOVERYTANKER:SetTACAN(channel, morse, mode)
|
function RECOVERYTANKER:SetTACAN(channel, morse, mode)
|
||||||
self.TACANchannel=channel or 1
|
self.TACANchannel=channel or 1
|
||||||
@@ -808,8 +808,8 @@ end
|
|||||||
|
|
||||||
--- Set radio frequency and optionally modulation of the tanker.
|
--- Set radio frequency and optionally modulation of the tanker.
|
||||||
-- @param #RECOVERYTANKER self
|
-- @param #RECOVERYTANKER self
|
||||||
-- @param #number frequency Radio frequency in MHz. Default 251 MHz.
|
-- @param #number frequency (Optional) Radio frequency in MHz. Default 251 MHz.
|
||||||
-- @param #string modulation Radio modulation, either "AM" or "FM". Default "AM".
|
-- @param #string modulation (Optional) Radio modulation, either "AM" or "FM". Default "AM".
|
||||||
-- @return #RECOVERYTANKER self
|
-- @return #RECOVERYTANKER self
|
||||||
function RECOVERYTANKER:SetRadio(frequency, modulation)
|
function RECOVERYTANKER:SetRadio(frequency, modulation)
|
||||||
self.RadioFreq=frequency or 251
|
self.RadioFreq=frequency or 251
|
||||||
@@ -1537,8 +1537,8 @@ end
|
|||||||
|
|
||||||
--- Init waypoint after spawn. Tanker is first guided to a position astern the carrier and starts its racetrack pattern from there.
|
--- Init waypoint after spawn. Tanker is first guided to a position astern the carrier and starts its racetrack pattern from there.
|
||||||
-- @param #RECOVERYTANKER self
|
-- @param #RECOVERYTANKER self
|
||||||
-- @param #number dist Distance [NM] of initial waypoint astern carrier. Default 8 NM.
|
-- @param #number dist (Optional) Distance [NM] of initial waypoint astern carrier. Default 8 NM.
|
||||||
-- @param #number delay Delay before routing in seconds. Default 1 second.
|
-- @param #number delay (Optional) Delay before routing in seconds. Default 1 second.
|
||||||
function RECOVERYTANKER:_InitRoute(dist, delay)
|
function RECOVERYTANKER:_InitRoute(dist, delay)
|
||||||
|
|
||||||
-- Defaults.
|
-- Defaults.
|
||||||
|
|||||||
@@ -455,7 +455,7 @@ end
|
|||||||
|
|
||||||
--- Set low fuel state of helo. When fuel is below this threshold, the helo will RTB or be respawned if takeoff type is in air.
|
--- Set low fuel state of helo. When fuel is below this threshold, the helo will RTB or be respawned if takeoff type is in air.
|
||||||
-- @param #RESCUEHELO self
|
-- @param #RESCUEHELO self
|
||||||
-- @param #number threshold Low fuel threshold in percent. Default 5%.
|
-- @param #number threshold (Optional) Low fuel threshold in percent. Default 5%.
|
||||||
-- @return #RESCUEHELO self
|
-- @return #RESCUEHELO self
|
||||||
function RESCUEHELO:SetLowFuelThreshold(threshold)
|
function RESCUEHELO:SetLowFuelThreshold(threshold)
|
||||||
self.lowfuel=threshold or 5
|
self.lowfuel=threshold or 5
|
||||||
@@ -480,7 +480,7 @@ end
|
|||||||
|
|
||||||
--- Set rescue zone radius. Crashed or ejected units inside this radius of the carrier will be rescued if possible.
|
--- Set rescue zone radius. Crashed or ejected units inside this radius of the carrier will be rescued if possible.
|
||||||
-- @param #RESCUEHELO self
|
-- @param #RESCUEHELO self
|
||||||
-- @param #number radius Radius of rescue zone in nautical miles. Default is 15 NM.
|
-- @param #number radius (Optional) Radius of rescue zone in nautical miles. Default is 15 NM.
|
||||||
-- @return #RESCUEHELO self
|
-- @return #RESCUEHELO self
|
||||||
function RESCUEHELO:SetRescueZone(radius)
|
function RESCUEHELO:SetRescueZone(radius)
|
||||||
radius=UTILS.NMToMeters(radius or 15)
|
radius=UTILS.NMToMeters(radius or 15)
|
||||||
@@ -490,7 +490,7 @@ end
|
|||||||
|
|
||||||
--- Set rescue hover speed.
|
--- Set rescue hover speed.
|
||||||
-- @param #RESCUEHELO self
|
-- @param #RESCUEHELO self
|
||||||
-- @param #number speed Speed in knots. Default 5 kts.
|
-- @param #number speed (Optional) Speed in knots. Default 5 kts.
|
||||||
-- @return #RESCUEHELO self
|
-- @return #RESCUEHELO self
|
||||||
function RESCUEHELO:SetRescueHoverSpeed(speed)
|
function RESCUEHELO:SetRescueHoverSpeed(speed)
|
||||||
self.rescuespeed=UTILS.KnotsToMps(speed or 5)
|
self.rescuespeed=UTILS.KnotsToMps(speed or 5)
|
||||||
@@ -499,7 +499,7 @@ end
|
|||||||
|
|
||||||
--- Set rescue duration. This is the time it takes to rescue a pilot at the crash site.
|
--- Set rescue duration. This is the time it takes to rescue a pilot at the crash site.
|
||||||
-- @param #RESCUEHELO self
|
-- @param #RESCUEHELO self
|
||||||
-- @param #number duration Duration in minutes. Default 5 min.
|
-- @param #number duration (Optional) Duration in minutes. Default 5 min.
|
||||||
-- @return #RESCUEHELO self
|
-- @return #RESCUEHELO self
|
||||||
function RESCUEHELO:SetRescueDuration(duration)
|
function RESCUEHELO:SetRescueDuration(duration)
|
||||||
self.rescueduration=(duration or 5)*60
|
self.rescueduration=(duration or 5)*60
|
||||||
@@ -541,7 +541,7 @@ end
|
|||||||
|
|
||||||
--- Set takeoff type.
|
--- Set takeoff type.
|
||||||
-- @param #RESCUEHELO self
|
-- @param #RESCUEHELO self
|
||||||
-- @param #number takeofftype Takeoff type. Default SPAWN.Takeoff.Hot.
|
-- @param #number takeofftype (Optional) Takeoff type. Default SPAWN.Takeoff.Hot.
|
||||||
-- @return #RESCUEHELO self
|
-- @return #RESCUEHELO self
|
||||||
function RESCUEHELO:SetTakeoff(takeofftype)
|
function RESCUEHELO:SetTakeoff(takeofftype)
|
||||||
self.takeoff=takeofftype or SPAWN.Takeoff.Hot
|
self.takeoff=takeofftype or SPAWN.Takeoff.Hot
|
||||||
@@ -574,7 +574,7 @@ end
|
|||||||
|
|
||||||
--- Set altitude of helo.
|
--- Set altitude of helo.
|
||||||
-- @param #RESCUEHELO self
|
-- @param #RESCUEHELO self
|
||||||
-- @param #number alt Altitude in meters. Default 70 m.
|
-- @param #number alt (Optional) Altitude in meters. Default 70 m.
|
||||||
-- @return #RESCUEHELO self
|
-- @return #RESCUEHELO self
|
||||||
function RESCUEHELO:SetAltitude(alt)
|
function RESCUEHELO:SetAltitude(alt)
|
||||||
self.altitude=alt or 70
|
self.altitude=alt or 70
|
||||||
@@ -583,7 +583,7 @@ end
|
|||||||
|
|
||||||
--- Set offset parallel to orientation of carrier.
|
--- Set offset parallel to orientation of carrier.
|
||||||
-- @param #RESCUEHELO self
|
-- @param #RESCUEHELO self
|
||||||
-- @param #number distance Offset distance in meters. Default 200 m (~660 ft).
|
-- @param #number distance (Optional) Offset distance in meters. Default 200 m (~660 ft).
|
||||||
-- @return #RESCUEHELO self
|
-- @return #RESCUEHELO self
|
||||||
function RESCUEHELO:SetOffsetX(distance)
|
function RESCUEHELO:SetOffsetX(distance)
|
||||||
self.offsetX=distance or 200
|
self.offsetX=distance or 200
|
||||||
@@ -592,7 +592,7 @@ end
|
|||||||
|
|
||||||
--- Set offset perpendicular to orientation to carrier.
|
--- Set offset perpendicular to orientation to carrier.
|
||||||
-- @param #RESCUEHELO self
|
-- @param #RESCUEHELO self
|
||||||
-- @param #number distance Offset distance in meters. Default 240 m (~780 ft).
|
-- @param #number distance (Optional) Offset distance in meters. Default 240 m (~780 ft).
|
||||||
-- @return #RESCUEHELO self
|
-- @return #RESCUEHELO self
|
||||||
function RESCUEHELO:SetOffsetZ(distance)
|
function RESCUEHELO:SetOffsetZ(distance)
|
||||||
self.offsetZ=distance or 240
|
self.offsetZ=distance or 240
|
||||||
@@ -650,7 +650,7 @@ end
|
|||||||
|
|
||||||
--- Set follow time update interval.
|
--- Set follow time update interval.
|
||||||
-- @param #RESCUEHELO self
|
-- @param #RESCUEHELO self
|
||||||
-- @param #number dt Time interval in seconds. Default 1.0 sec.
|
-- @param #number dt (Optional) Time interval in seconds. Default 1.0 sec.
|
||||||
-- @return #RESCUEHELO self
|
-- @return #RESCUEHELO self
|
||||||
function RESCUEHELO:SetFollowTimeInterval(dt)
|
function RESCUEHELO:SetFollowTimeInterval(dt)
|
||||||
self.dtFollow=dt or 1.0
|
self.dtFollow=dt or 1.0
|
||||||
|
|||||||
@@ -92,7 +92,7 @@ SQUADRON.version="0.8.1"
|
|||||||
--- Create a new SQUADRON object and start the FSM.
|
--- Create a new SQUADRON object and start the FSM.
|
||||||
-- @param #SQUADRON self
|
-- @param #SQUADRON self
|
||||||
-- @param #string TemplateGroupName Name of the template group.
|
-- @param #string TemplateGroupName Name of the template group.
|
||||||
-- @param #number Ngroups Number of asset groups of this squadron. Default 3.
|
-- @param #number Ngroups (Optional) Number of asset groups of this squadron. Default 3.
|
||||||
-- @param #string SquadronName Name of the squadron, e.g. "VFA-37". Must be **unique**!
|
-- @param #string SquadronName Name of the squadron, e.g. "VFA-37". Must be **unique**!
|
||||||
-- @return #SQUADRON self
|
-- @return #SQUADRON self
|
||||||
function SQUADRON:New(TemplateGroupName, Ngroups, SquadronName)
|
function SQUADRON:New(TemplateGroupName, Ngroups, SquadronName)
|
||||||
@@ -125,7 +125,7 @@ end
|
|||||||
|
|
||||||
--- Set number of units in groups.
|
--- Set number of units in groups.
|
||||||
-- @param #SQUADRON self
|
-- @param #SQUADRON self
|
||||||
-- @param #number nunits Number of units. Must be >=1 and <=4. Default 2.
|
-- @param #number nunits (Optional) Number of units. Must be >=1 and <=4. Default 2.
|
||||||
-- @return #SQUADRON self
|
-- @return #SQUADRON self
|
||||||
function SQUADRON:SetGrouping(nunits)
|
function SQUADRON:SetGrouping(nunits)
|
||||||
self.ngrouping=nunits or 2
|
self.ngrouping=nunits or 2
|
||||||
@@ -150,7 +150,7 @@ end
|
|||||||
--- Set takeoff type. All assets of this squadron will be spawned with cold (default) or hot engines.
|
--- Set takeoff type. All assets of this squadron will be spawned with cold (default) or hot engines.
|
||||||
-- Spawning on runways is not supported.
|
-- Spawning on runways is not supported.
|
||||||
-- @param #SQUADRON self
|
-- @param #SQUADRON self
|
||||||
-- @param #string TakeoffType Take off type: "Cold" (default) or "Hot" with engines on or "Air" for spawning in air.
|
-- @param #string TakeoffType (Optional) Take off type: "Cold" (default) or "Hot" with engines on or "Air" for spawning in air.
|
||||||
-- @return #SQUADRON self
|
-- @return #SQUADRON self
|
||||||
function SQUADRON:SetTakeoffType(TakeoffType)
|
function SQUADRON:SetTakeoffType(TakeoffType)
|
||||||
TakeoffType=TakeoffType or "Cold"
|
TakeoffType=TakeoffType or "Cold"
|
||||||
@@ -193,7 +193,7 @@ end
|
|||||||
--- Set despawn after landing. Aircraft will be despawned after the landing event.
|
--- Set despawn after landing. Aircraft will be despawned after the landing event.
|
||||||
-- Can help to avoid DCS AI taxiing issues.
|
-- Can help to avoid DCS AI taxiing issues.
|
||||||
-- @param #SQUADRON self
|
-- @param #SQUADRON self
|
||||||
-- @param #boolean Switch If `true` (default), activate despawn after landing.
|
-- @param #boolean Switch (Optional) If `true` (default), activate despawn after landing.
|
||||||
-- @return #SQUADRON self
|
-- @return #SQUADRON self
|
||||||
function SQUADRON:SetDespawnAfterLanding(Switch)
|
function SQUADRON:SetDespawnAfterLanding(Switch)
|
||||||
if Switch then
|
if Switch then
|
||||||
@@ -207,7 +207,7 @@ end
|
|||||||
--- Set despawn after holding. Aircraft will be despawned when they arrive at their holding position at the airbase.
|
--- Set despawn after holding. Aircraft will be despawned when they arrive at their holding position at the airbase.
|
||||||
-- Can help to avoid DCS AI taxiing issues.
|
-- Can help to avoid DCS AI taxiing issues.
|
||||||
-- @param #SQUADRON self
|
-- @param #SQUADRON self
|
||||||
-- @param #boolean Switch If `true` (default), activate despawn after holding.
|
-- @param #boolean Switch (Optional) If `true` (default), activate despawn after holding.
|
||||||
-- @return #SQUADRON self
|
-- @return #SQUADRON self
|
||||||
function SQUADRON:SetDespawnAfterHolding(Switch)
|
function SQUADRON:SetDespawnAfterHolding(Switch)
|
||||||
if Switch then
|
if Switch then
|
||||||
@@ -221,7 +221,7 @@ end
|
|||||||
|
|
||||||
--- Set low fuel threshold.
|
--- Set low fuel threshold.
|
||||||
-- @param #SQUADRON self
|
-- @param #SQUADRON self
|
||||||
-- @param #number LowFuel Low fuel threshold in percent. Default 25.
|
-- @param #number LowFuel (Optional) Low fuel threshold in percent. Default 25.
|
||||||
-- @return #SQUADRON self
|
-- @return #SQUADRON self
|
||||||
function SQUADRON:SetFuelLowThreshold(LowFuel)
|
function SQUADRON:SetFuelLowThreshold(LowFuel)
|
||||||
self.fuellow=LowFuel or 25
|
self.fuellow=LowFuel or 25
|
||||||
|
|||||||
@@ -400,7 +400,7 @@ end
|
|||||||
|
|
||||||
--- Set priority of the target.
|
--- Set priority of the target.
|
||||||
-- @param #TARGET self
|
-- @param #TARGET self
|
||||||
-- @param #number Priority Priority of the target. Default 50.
|
-- @param #number Priority (Optional) Priority of the target. Default 50.
|
||||||
-- @return #TARGET self
|
-- @return #TARGET self
|
||||||
function TARGET:SetPriority(Priority)
|
function TARGET:SetPriority(Priority)
|
||||||
self.prio=Priority or 50
|
self.prio=Priority or 50
|
||||||
@@ -409,7 +409,7 @@ end
|
|||||||
|
|
||||||
--- Set importance of the target.
|
--- Set importance of the target.
|
||||||
-- @param #TARGET self
|
-- @param #TARGET self
|
||||||
-- @param #number Importance Importance of the target. Default `nil`.
|
-- @param #number Importance (Optional) Importance of the target. Default `nil`.
|
||||||
-- @return #TARGET self
|
-- @return #TARGET self
|
||||||
function TARGET:SetImportance(Importance)
|
function TARGET:SetImportance(Importance)
|
||||||
self.importance=Importance
|
self.importance=Importance
|
||||||
@@ -508,10 +508,10 @@ end
|
|||||||
--- Add mission type and number of required assets to resource.
|
--- Add mission type and number of required assets to resource.
|
||||||
-- @param #TARGET self
|
-- @param #TARGET self
|
||||||
-- @param #string MissionType Mission Type.
|
-- @param #string MissionType Mission Type.
|
||||||
-- @param #number Nmin Min number of required assets.
|
-- @param #number Nmin (Optional) Min number of required assets. Default is 1.
|
||||||
-- @param #number Nmax Max number of requried assets.
|
-- @param #number Nmax (Optional) Max number of requried assets. Default is 1.
|
||||||
-- @param #table Attributes Generalized attribute(s).
|
-- @param #table Attributes Generalized attribute(s).
|
||||||
-- @param #table Properties DCS attribute(s). Default `nil`.
|
-- @param #table Properties (Optional) DCS attribute(s). Default `nil`.
|
||||||
-- @return #TARGET.Resource The resource table.
|
-- @return #TARGET.Resource The resource table.
|
||||||
function TARGET:AddResource(MissionType, Nmin, Nmax, Attributes, Properties)
|
function TARGET:AddResource(MissionType, Nmin, Nmax, Attributes, Properties)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user