UPDATE: FUNCTIONAL function params

- Added (Optional) to param descriptions for params that have default values
This commit is contained in:
Rolln-dev
2026-03-02 08:03:56 -07:00
parent 877ca7176a
commit 6f16d34681
24 changed files with 187 additions and 183 deletions
+1 -1
View File
@@ -302,7 +302,7 @@ end
-- @param #SPAWNSTATIC self -- @param #SPAWNSTATIC self
-- @param #number CallsignID (Optional) Callsign ID. Default 1 (="London"). -- @param #number CallsignID (Optional) Callsign ID. Default 1 (="London").
-- @param #number Frequency (Optional) Frequency in MHz. Default 127.5 MHz. -- @param #number Frequency (Optional) Frequency in MHz. Default 127.5 MHz.
-- @param #number Modulation Modulation 0=AM, 1=FM. Defaults to 0 -- @param #number Modulation (Optional) Modulation 0=AM, 1=FM. Defaults to 0
-- @param #boolean DynamicSpawns If true, allow Dynamic Spawns -- @param #boolean DynamicSpawns If true, allow Dynamic Spawns
-- @param #boolean DynamicHotStarts If true, and DynamicSpawns is true, then allow Dynamic Spawns with hot starts. -- @param #boolean DynamicHotStarts If true, and DynamicSpawns is true, then allow Dynamic Spawns with hot starts.
-- @return #SPAWNSTATIC self -- @return #SPAWNSTATIC self
+1 -1
View File
@@ -369,7 +369,7 @@ end
--- Set draw coalition of zone. --- Set draw coalition of zone.
-- @param #ZONE_BASE self -- @param #ZONE_BASE self
-- @param #number (Optional) Coalition Coalition. Default -1. -- @param #number Coalition (Optional) Coalition. Default -1.
-- @return #ZONE_BASE self -- @return #ZONE_BASE self
function ZONE_BASE:SetDrawCoalition(Coalition) function ZONE_BASE:SetDrawCoalition(Coalition)
self.drawCoalition=Coalition or -1 self.drawCoalition=Coalition or -1
@@ -308,7 +308,7 @@ AICSAR.RadioLength = {
-- @param #string Helotemplate Helicopter template name. -- @param #string Helotemplate Helicopter template name.
-- @param Wrapper.Airbase#AIRBASE FARP FARP object or Airbase from where to start. -- @param Wrapper.Airbase#AIRBASE FARP FARP object or Airbase from where to start.
-- @param Core.Zone#ZONE MASHZone Zone where to drop pilots after rescue. -- @param Core.Zone#ZONE MASHZone Zone where to drop pilots after rescue.
-- @param #number Helonumber Max number of alive Ai Helos at the same time. Defaults to three. -- @param #number Helonumber (Optional) Max number of alive Ai Helos at the same time. Defaults to 3.
-- @return #AICSAR self -- @return #AICSAR self
function AICSAR:New(Alias,Coalition,Pilottemplate,Helotemplate,FARP,MASHZone,Helonumber) function AICSAR:New(Alias,Coalition,Pilottemplate,Helotemplate,FARP,MASHZone,Helonumber)
-- Inherit everything from FSM class. -- Inherit everything from FSM class.
@@ -543,10 +543,10 @@ end
-- @param #AICSAR self -- @param #AICSAR self
-- @param #boolean OnOff Switch on (true) or off (false). -- @param #boolean OnOff Switch on (true) or off (false).
-- @param #string Path Path to your SRS Server External Audio Component, e.g. "C:\\\\Program Files\\\\DCS-SimpleRadio-Standalone\\\\ExternalAudio" -- @param #string Path Path to your SRS Server External Audio Component, e.g. "C:\\\\Program Files\\\\DCS-SimpleRadio-Standalone\\\\ExternalAudio"
-- @param #number Frequency Defaults to 243 (guard) -- @param #number Frequency (Optional) Defaults to 243 (guard)
-- @param #number Modulation Radio modulation. Defaults to radio.modulation.AM -- @param #number Modulation (Optional) Radio modulation. Defaults to radio.modulation.AM
-- @param #string SoundPath Where to find the audio files. Defaults to nil, i.e. add messages via "Sound to..." in the Mission Editor. -- @param #string SoundPath (Optional) Where to find the audio files. Defaults to nil, i.e. add messages via "Sound to..." in the Mission Editor.
-- @param #number Port Port of the SRS, defaults to 5002. -- @param #number Port (Optional) Port of the SRS, defaults to 5002.
-- @return #AICSAR self -- @return #AICSAR self
function AICSAR:SetSRSRadio(OnOff,Path,Frequency,Modulation,SoundPath,Port) function AICSAR:SetSRSRadio(OnOff,Path,Frequency,Modulation,SoundPath,Port)
self:T(self.lid .. "SetSRSRadio") self:T(self.lid .. "SetSRSRadio")
@@ -657,8 +657,8 @@ end
--- [User] Switch sound output on and use normale (DCS) radio --- [User] Switch sound output on and use normale (DCS) radio
-- @param #AICSAR self -- @param #AICSAR self
-- @param #boolean OnOff Switch on (true) or off (false). -- @param #boolean OnOff Switch on (true) or off (false).
-- @param #number Frequency Defaults to 243 (guard). -- @param #number Frequency(Optional) Defaults to 243 (guard).
-- @param #number Modulation Radio modulation. Defaults to radio.modulation.AM. -- @param #number Modulation (Optional) Radio modulation. Defaults to radio.modulation.AM.
-- @param Wrapper.Group#GROUP Group The group to use as sending station. -- @param Wrapper.Group#GROUP Group The group to use as sending station.
-- @return #AICSAR self -- @return #AICSAR self
function AICSAR:SetDCSRadio(OnOff,Frequency,Modulation,Group) function AICSAR:SetDCSRadio(OnOff,Frequency,Modulation,Group)
@@ -1399,7 +1399,7 @@ end
-- @param #ARTY self -- @param #ARTY self
-- @param Core.Point#COORDINATE coord Coordinates of the new position. -- @param Core.Point#COORDINATE coord Coordinates of the new position.
-- @param #string time (Optional) Day time at which the group should start moving. Passed as a string in format "08:13:45". Default is now. -- @param #string time (Optional) Day time at which the group should start moving. Passed as a string in format "08:13:45". Default is now.
-- @param #number speed (Optinal) Speed in km/h the group should move at. Default 70% of max posible speed of group. -- @param #number speed (Optional) Speed in km/h the group should move at. Default 70% of max posible speed of group.
-- @param #boolean onroad (Optional) If true, group will mainly use roads. Default off, i.e. go directly towards the specified coordinate. -- @param #boolean onroad (Optional) If true, group will mainly use roads. Default off, i.e. go directly towards the specified coordinate.
-- @param #boolean cancel (Optional) If true, cancel any running attack when move should begin. Default is false. -- @param #boolean cancel (Optional) If true, cancel any running attack when move should begin. Default is false.
-- @param #string name (Optional) Name of the coordinate. Default is LL DMS string of the coordinate. If the name was already given, the numbering "#01", "#02",... is appended automatically. -- @param #string name (Optional) Name of the coordinate. Default is LL DMS string of the coordinate. If the name was already given, the numbering "#01", "#02",... is appended automatically.
@@ -1510,7 +1510,7 @@ end
--- Set minimum firing range. Targets closer than this distance are not engaged. --- Set minimum firing range. Targets closer than this distance are not engaged.
-- @param #ARTY self -- @param #ARTY self
-- @param #number range Min range in kilometers. Default is 0.1 km. -- @param #number range (Optional) Min range in kilometers. Default is 0.1 km.
-- @return self -- @return self
function ARTY:SetMinFiringRange(range) function ARTY:SetMinFiringRange(range)
self:F({range=range}) self:F({range=range})
@@ -1520,7 +1520,7 @@ end
--- Set maximum firing range. Targets further away than this distance are not engaged. --- Set maximum firing range. Targets further away than this distance are not engaged.
-- @param #ARTY self -- @param #ARTY self
-- @param #number range Max range in kilometers. Default is 1000 km. -- @param #number range (Optional) Max range in kilometers. Default is 1000 km.
-- @return self -- @return self
function ARTY:SetMaxFiringRange(range) function ARTY:SetMaxFiringRange(range)
self:F({range=range}) self:F({range=range})
@@ -1530,7 +1530,7 @@ end
--- Set time interval between status updates. During the status check, new events are triggered. --- Set time interval between status updates. During the status check, new events are triggered.
-- @param #ARTY self -- @param #ARTY self
-- @param #number interval Time interval in seconds. Default 10 seconds. -- @param #number interval (Optional) Time interval in seconds. Default 10 seconds.
-- @return self -- @return self
function ARTY:SetStatusInterval(interval) function ARTY:SetStatusInterval(interval)
self:F({interval=interval}) self:F({interval=interval})
@@ -1540,7 +1540,7 @@ end
--- Set time interval for weapon tracking. --- Set time interval for weapon tracking.
-- @param #ARTY self -- @param #ARTY self
-- @param #number interval Time interval in seconds. Default 0.2 seconds. -- @param #number interval (Optional) Time interval in seconds. Default 0.2 seconds.
-- @return self -- @return self
function ARTY:SetTrackInterval(interval) function ARTY:SetTrackInterval(interval)
self.dtTrack=interval or 0.2 self.dtTrack=interval or 0.2
@@ -1549,7 +1549,7 @@ end
--- Set time how it is waited a unit the first shot event happens. If no shot is fired after this time, the task to fire is aborted and the target removed. --- Set time how it is waited a unit the first shot event happens. If no shot is fired after this time, the task to fire is aborted and the target removed.
-- @param #ARTY self -- @param #ARTY self
-- @param #number waittime Time in seconds. Default 300 seconds. -- @param #number waittime (Optional) Time in seconds. Default 300 seconds.
-- @return self -- @return self
function ARTY:SetWaitForShotTime(waittime) function ARTY:SetWaitForShotTime(waittime)
self:F({waittime=waittime}) self:F({waittime=waittime})
@@ -1559,7 +1559,7 @@ end
--- Define the safe distance between ARTY group and rearming unit or rearming place at which rearming process is possible. --- Define the safe distance between ARTY group and rearming unit or rearming place at which rearming process is possible.
-- @param #ARTY self -- @param #ARTY self
-- @param #number distance Safe distance in meters. Default is 100 m. -- @param #number distance (Optional) Safe distance in meters. Default is 100 m.
-- @return self -- @return self
function ARTY:SetRearmingDistance(distance) function ARTY:SetRearmingDistance(distance)
self:F({distance=distance}) self:F({distance=distance})
@@ -1821,7 +1821,7 @@ end
--- Set nuclear warhead explosion strength. --- Set nuclear warhead explosion strength.
-- @param #ARTY self -- @param #ARTY self
-- @param #number strength Explosion strength in kilo tons TNT. Default is 0.075 kt. -- @param #number strength (Optional) Explosion strength in kilo tons TNT. Default is 0.075 kt.
-- @return self -- @return self
function ARTY:SetTacNukeWarhead(strength) function ARTY:SetTacNukeWarhead(strength)
self.nukewarhead=strength or 0.075 self.nukewarhead=strength or 0.075
@@ -3911,7 +3911,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 #ARTY self -- @param #ARTY self
-- @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 #number Total amount of ammo the whole group has left. -- @return #number Total amount of ammo the whole group has left.
-- @return #number Number of shells the group has left. -- @return #number Number of shells the group has left.
-- @return #number Number of rockets the group has left. -- @return #number Number of rockets the group has left.
@@ -427,7 +427,7 @@ end
--- (User) Set minimum threat level for target selection, can be 0 (lowest) to 10 (highest). --- (User) Set minimum threat level for target selection, can be 0 (lowest) to 10 (highest).
-- @param #AUTOLASE self -- @param #AUTOLASE self
-- @param #number Level Level used for filtering, defaults to 0. SAM systems and manpads have level 7 to 10, AAA level 6, MTBs and armoured vehicles level 3 to 5, APC, Artillery, Infantry and EWR level 1 to 2. -- @param #number Level (Optional) Level used for filtering, defaults to 0. SAM systems and manpads have level 7 to 10, AAA level 6, MTBs and armoured vehicles level 3 to 5, APC, Artillery, Infantry and EWR level 1 to 2.
-- @return #AUTOLASE self -- @return #AUTOLASE self
-- @usage Filter for level 3 and above: -- @usage Filter for level 3 and above:
-- `myautolase:SetMinThreatLevel(3)` -- `myautolase:SetMinThreatLevel(3)`
@@ -593,8 +593,8 @@ end
--- (User) Function to force laser cooldown and cool down time --- (User) Function to force laser cooldown and cool down time
-- @param #AUTOLASE self -- @param #AUTOLASE self
-- @param #boolean OnOff Switch cool down on (true) or off (false) - defaults to true -- @param #boolean OnOff (Optional) Switch cool down on (true) or off (false) - defaults to true
-- @param #number Seconds Number of seconds for cooldown - dafaults to 60 seconds -- @param #number Seconds (Optional) Number of seconds for cooldown - dafaults to 60 seconds
-- @return #AUTOLASE self -- @return #AUTOLASE self
function AUTOLASE:SetLaserCoolDown(OnOff, Seconds) function AUTOLASE:SetLaserCoolDown(OnOff, Seconds)
self.forcecooldown = OnOff and true self.forcecooldown = OnOff and true
@@ -615,8 +615,8 @@ end
--- (User) Function to set lasing distance in meters and duration in seconds --- (User) Function to set lasing distance in meters and duration in seconds
-- @param #AUTOLASE self -- @param #AUTOLASE self
-- @param #number Distance (Max) distance for lasing in meters - default 5000 meters -- @param #number Distance (Optional) Max distance for lasing in meters - default 5000 meters
-- @param #number Duration (Max) duration for lasing in seconds - default 300 secs -- @param #number Duration (Optional) Max duration for lasing in seconds - default 300 secs
-- @return #AUTOLASE self -- @return #AUTOLASE self
function AUTOLASE:SetLasingParameters(Distance, Duration) function AUTOLASE:SetLasingParameters(Distance, Duration)
self.LaseDistance = Distance or 5000 self.LaseDistance = Distance or 5000
@@ -640,7 +640,7 @@ end
--- (User) Function to set rounding precision for BR distance output. --- (User) Function to set rounding precision for BR distance output.
-- @param #AUTOLASE self -- @param #AUTOLASE self
-- @param #number IDP Rounding precision before/after the decimal sign. Defaults to zero. Positive values round right of the decimal sign, negative ones left of the decimal sign. -- @param #number IDP (Optional) Rounding precision before/after the decimal sign. Defaults to zero. Positive values round right of the decimal sign, negative ones left of the decimal sign.
-- @return #AUTOLASE self -- @return #AUTOLASE self
function AUTOLASE:SetRoundingPrecsion(IDP) function AUTOLASE:SetRoundingPrecsion(IDP)
self.RoundingPrecision = IDP or 0 self.RoundingPrecision = IDP or 0
@@ -178,7 +178,7 @@ end
-- Note, one can also use the method @{#CLEANUP_AIRBASE.RemoveAirbase}() to remove the airbase from the control process as a whole, -- Note, one can also use the method @{#CLEANUP_AIRBASE.RemoveAirbase}() to remove the airbase from the control process as a whole,
-- when an enemy unit is near. That is also an option... -- when an enemy unit is near. That is also an option...
-- @param #CLEANUP_AIRBASE self -- @param #CLEANUP_AIRBASE self
-- @param #string CleanMissiles (Default=true) If true, missiles fired are immediately destroyed. If false missiles are not controlled. -- @param #boolean CleanMissiles (Optional) (Default=true) If true, missiles fired are immediately destroyed. If false missiles are not controlled.
-- @return #CLEANUP_AIRBASE -- @return #CLEANUP_AIRBASE
function CLEANUP_AIRBASE:SetCleanMissiles( CleanMissiles ) function CLEANUP_AIRBASE:SetCleanMissiles( CleanMissiles )
@@ -682,7 +682,7 @@ do -- DESIGNATE
--- Set the lase duration for designations. --- Set the lase duration for designations.
-- @param #DESIGNATE self -- @param #DESIGNATE self
-- @param #number LaseDuration The time in seconds a lase will continue to hold on target. The default is 120 seconds. -- @param #number LaseDuration (Optional) The time in seconds a lase will continue to hold on target. The default is 120 seconds.
-- @return #DESIGNATE -- @return #DESIGNATE
function DESIGNATE:SetLaseDuration( LaseDuration ) function DESIGNATE:SetLaseDuration( LaseDuration )
self.LaseDuration = LaseDuration or 120 self.LaseDuration = LaseDuration or 120
@@ -1052,9 +1052,9 @@ do -- DETECTION_BASE
--- 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 #DETECTION_BASE self -- @param #DETECTION_BASE self
-- @param #number minheight Minimum flight height to be detected, in meters AGL (above ground) -- @param #number minheight Minimum flight height to be detected, in meters AGL (above ground)
-- @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 #DETECTION_BASE self -- @return #DETECTION_BASE self
function DETECTION_BASE:SetRadarBlur(minheight,thresheight,thresblur,closing) function DETECTION_BASE:SetRadarBlur(minheight,thresheight,thresblur,closing)
self.RadarBlur = true self.RadarBlur = true
@@ -1104,12 +1104,14 @@ do -- DETECTION_BASE
--- Set the parameters to calculate to optimal intercept point. --- Set the parameters to calculate to optimal intercept point.
-- @param #DETECTION_BASE self -- @param #DETECTION_BASE self
-- @param #boolean Intercept Intercept is true if an intercept point is calculated. Intercept is false if it is disabled. The default Intercept is false. -- @param #boolean Intercept (Optional) Intercept is true if an intercept point is calculated. Intercept is false if it is disabled. The default Intercept is false.
-- @param #number InterceptDelay If Intercept is true, then InterceptDelay is the average time it takes to get airplanes airborne. -- @param #number InterceptDelay If Intercept is true, then InterceptDelay is the average time it takes to get airplanes airborne.
-- @return #DETECTION_BASE self -- @return #DETECTION_BASE self
function DETECTION_BASE:SetIntercept( Intercept, InterceptDelay ) function DETECTION_BASE:SetIntercept( Intercept, InterceptDelay )
self:F2() self:F2()
Intercept = Intercept or false
self.Intercept = Intercept self.Intercept = Intercept
self.InterceptDelay = InterceptDelay self.InterceptDelay = InterceptDelay
@@ -1611,8 +1613,8 @@ do -- DETECTION_BASE
-- The DetectedItem is a table and contains a SET_UNIT in the field Set. -- The DetectedItem is a table and contains a SET_UNIT in the field Set.
-- @param #DETECTION_BASE self -- @param #DETECTION_BASE self
-- @param #string ItemPrefix Prefix of detected item. -- @param #string ItemPrefix Prefix of detected item.
-- @param #number DetectedItemKey The key of the DetectedItem. Default self.DetectedItemMax. Could also be a string in principle. -- @param #number DetectedItemKey (Optional) The key of the DetectedItem. Default self.DetectedItemMax. Could also be a string in principle.
-- @param Core.Set#SET_UNIT Set (optional) The Set of Units to be added. -- @param Core.Set#SET_UNIT Set (Optional) The Set of Units to be added.
-- @return #DETECTION_BASE.DetectedItem -- @return #DETECTION_BASE.DetectedItem
function DETECTION_BASE:AddDetectedItem( ItemPrefix, DetectedItemKey, Set ) function DETECTION_BASE:AddDetectedItem( ItemPrefix, DetectedItemKey, Set )
@@ -2536,7 +2538,7 @@ do -- DETECTION_AREAS
--- DETECTION_AREAS constructor. --- DETECTION_AREAS constructor.
-- @param #DETECTION_AREAS self -- @param #DETECTION_AREAS self
-- @param Core.Set#SET_GROUP DetectionSetGroup The @{Core.Set} of GROUPs in the Forward Air Controller role. -- @param Core.Set#SET_GROUP DetectionSetGroup The @{Core.Set} of GROUPs in the Forward Air Controller role.
-- @param #number DetectionZoneRange The range in meters within which targets are grouped upon the first detected target. Default 5000m. -- @param #number DetectionZoneRange (Optional) The range in meters within which targets are grouped upon the first detected target. Default 5000m.
-- @return #DETECTION_AREAS -- @return #DETECTION_AREAS
function DETECTION_AREAS:New( DetectionSetGroup, DetectionZoneRange ) function DETECTION_AREAS:New( DetectionSetGroup, DetectionZoneRange )
+13 -13
View File
@@ -179,7 +179,7 @@ ESCORT = {
-- @param Wrapper.Client#CLIENT EscortClient The client escorted by the EscortGroup. -- @param Wrapper.Client#CLIENT EscortClient The client escorted by the EscortGroup.
-- @param Wrapper.Group#GROUP EscortGroup The group AI escorting the EscortClient. -- @param Wrapper.Group#GROUP EscortGroup The group AI escorting the EscortClient.
-- @param #string EscortName Name of the escort. -- @param #string EscortName Name of the escort.
-- @param #string EscortBriefing A text showing the ESCORT briefing to the player. Note that if no EscortBriefing is provided, the default briefing will be shown. -- @param #string EscortBriefing (Optional) A text showing the ESCORT briefing to the player. Note that if no EscortBriefing is provided, the default briefing will be shown.
-- @return #ESCORT self -- @return #ESCORT self
-- @usage -- @usage
-- -- Declare a new EscortPlanes object as follows: -- -- Declare a new EscortPlanes object as follows:
@@ -333,9 +333,9 @@ end
--- Defines a menu slot to let the escort hold at their current position and stay low with a specified height during a specified time in seconds. --- Defines a menu slot to let the escort hold at their current position and stay low with a specified height during a specified time in seconds.
-- This menu will appear under **Hold position**. -- This menu will appear under **Hold position**.
-- @param #ESCORT self -- @param #ESCORT self
-- @param DCS#Distance Height Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters. -- @param DCS#Distance Height (Optional) parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.
-- @param DCS#Time Seconds Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given. -- @param DCS#Time Seconds (Optional) parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.
-- @param #string MenuTextFormat Optional parameter that shows the menu option text. The text string is formatted, and should contain two %d tokens in the string. The first for the Height, the second for the Time (if given). If no text is given, the default text will be displayed. -- @param #string MenuTextFormat (Optional) parameter that shows the menu option text. The text string is formatted, and should contain two %d tokens in the string. The first for the Height, the second for the Time (if given). If no text is given, the default text will be displayed.
-- @return #ESCORT -- @return #ESCORT
-- TODO: Implement Seconds parameter. Challenge is to first develop the "continue from last activity" function. -- TODO: Implement Seconds parameter. Challenge is to first develop the "continue from last activity" function.
function ESCORT:MenuHoldAtEscortPosition( Height, Seconds, MenuTextFormat ) function ESCORT:MenuHoldAtEscortPosition( Height, Seconds, MenuTextFormat )
@@ -394,9 +394,9 @@ end
--- Defines a menu slot to let the escort hold at the client position and stay low with a specified height during a specified time in seconds. --- Defines a menu slot to let the escort hold at the client position and stay low with a specified height during a specified time in seconds.
-- This menu will appear under **Navigation**. -- This menu will appear under **Navigation**.
-- @param #ESCORT self -- @param #ESCORT self
-- @param DCS#Distance Height Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters. -- @param DCS#Distance Height (Optional) parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.
-- @param DCS#Time Seconds Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given. -- @param DCS#Time Seconds (Optional) parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.
-- @param #string MenuTextFormat Optional parameter that shows the menu option text. The text string is formatted, and should contain one or two %d tokens in the string. The first for the Height, the second for the Time (if given). If no text is given, the default text will be displayed. -- @param #string MenuTextFormat (Optional) parameter that shows the menu option text. The text string is formatted, and should contain one or two %d tokens in the string. The first for the Height, the second for the Time (if given). If no text is given, the default text will be displayed.
-- @return #ESCORT -- @return #ESCORT
-- TODO: Implement Seconds parameter. Challenge is to first develop the "continue from last activity" function. -- TODO: Implement Seconds parameter. Challenge is to first develop the "continue from last activity" function.
function ESCORT:MenuHoldAtLeaderPosition( Height, Seconds, MenuTextFormat ) function ESCORT:MenuHoldAtLeaderPosition( Height, Seconds, MenuTextFormat )
@@ -455,9 +455,9 @@ end
--- Defines a menu slot to let the escort scan for targets at a certain height for a certain time in seconds. --- Defines a menu slot to let the escort scan for targets at a certain height for a certain time in seconds.
-- This menu will appear under **Scan targets**. -- This menu will appear under **Scan targets**.
-- @param #ESCORT self -- @param #ESCORT self
-- @param DCS#Distance Height Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters. -- @param DCS#Distance Height (Optional) parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.
-- @param DCS#Time Seconds Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given. -- @param DCS#Time Seconds (Optional) parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.
-- @param #string MenuTextFormat Optional parameter that shows the menu option text. The text string is formatted, and should contain one or two %d tokens in the string. The first for the Height, the second for the Time (if given). If no text is given, the default text will be displayed. -- @param #string MenuTextFormat (Optional) parameter that shows the menu option text. The text string is formatted, and should contain one or two %d tokens in the string. The first for the Height, the second for the Time (if given). If no text is given, the default text will be displayed.
-- @return #ESCORT -- @return #ESCORT
function ESCORT:MenuScanForTargets( Height, Seconds, MenuTextFormat ) function ESCORT:MenuScanForTargets( Height, Seconds, MenuTextFormat )
self:F( { Height, Seconds, MenuTextFormat } ) self:F( { Height, Seconds, MenuTextFormat } )
@@ -514,7 +514,7 @@ end
-- This menu will appear under **Navigation**. -- This menu will appear under **Navigation**.
-- The flare will be fired from the first unit in the group. -- The flare will be fired from the first unit in the group.
-- @param #ESCORT self -- @param #ESCORT self
-- @param #string MenuTextFormat Optional parameter that shows the menu option text. If no text is given, the default text will be displayed. -- @param #string MenuTextFormat (Optional) parameter that shows the menu option text. If no text is given, the default text will be displayed.
-- @return #ESCORT -- @return #ESCORT
function ESCORT:MenuFlare( MenuTextFormat ) function ESCORT:MenuFlare( MenuTextFormat )
self:F() self:F()
@@ -546,7 +546,7 @@ end
-- Note that smoke menu options will only be displayed for ships and ground units. Not for air units. -- Note that smoke menu options will only be displayed for ships and ground units. Not for air units.
-- The smoke will be fired from the first unit in the group. -- The smoke will be fired from the first unit in the group.
-- @param #ESCORT self -- @param #ESCORT self
-- @param #string MenuTextFormat Optional parameter that shows the menu option text. If no text is given, the default text will be displayed. -- @param #string MenuTextFormat (Optional) parameter that shows the menu option text. If no text is given, the default text will be displayed.
-- @return #ESCORT -- @return #ESCORT
function ESCORT:MenuSmoke( MenuTextFormat ) function ESCORT:MenuSmoke( MenuTextFormat )
self:F() self:F()
@@ -580,7 +580,7 @@ end
-- This menu will appear under **Report targets**. -- This menu will appear under **Report targets**.
-- Note that if a report targets menu is not specified, no targets will be detected by the escort, and the attack and assisted attack menus will not be displayed. -- Note that if a report targets menu is not specified, no targets will be detected by the escort, and the attack and assisted attack menus will not be displayed.
-- @param #ESCORT self -- @param #ESCORT self
-- @param DCS#Time Seconds Optional parameter that lets the escort report their current detected targets after specified time interval in seconds. The default time is 30 seconds. -- @param DCS#Time Seconds (Optional) parameter that lets the escort report their current detected targets after specified time interval in seconds. The default time is 30 seconds.
-- @return #ESCORT -- @return #ESCORT
function ESCORT:MenuReportTargets( Seconds ) function ESCORT:MenuReportTargets( Seconds )
self:F( { Seconds } ) self:F( { Seconds } )
@@ -515,7 +515,7 @@ end
--- Set time interval between updates of the formation. --- Set time interval between updates of the formation.
-- @param #FORMATION self -- @param #FORMATION self
-- @param #number dt Time step in seconds between formation updates. Default is every 0.5 seconds. -- @param #number dt (Optional) Time step in seconds between formation updates. Default is every 0.5 seconds.
-- @return #FORMATION -- @return #FORMATION
function FORMATION:SetFollowTimeInterval(dt) function FORMATION:SetFollowTimeInterval(dt)
self.dtFollow=dt or 0.5 self.dtFollow=dt or 0.5
+5 -5
View File
@@ -459,7 +459,7 @@ end
--- Set explosion power. This is an "artificial" explosion generated when the missile is destroyed. Just for the visual effect. --- Set explosion power. This is an "artificial" explosion generated when the missile is destroyed. Just for the visual effect.
-- Don't set the explosion power too big or it will harm the aircraft in the vicinity. -- Don't set the explosion power too big or it will harm the aircraft in the vicinity.
-- @param #FOX self -- @param #FOX self
-- @param #number power Explosion power in kg TNT. Default 0.1 kg. -- @param #number power (Optional) Explosion power in kg TNT. Default 0.1 kg.
-- @return #FOX self -- @return #FOX self
function FOX:SetExplosionPower(power) function FOX:SetExplosionPower(power)
@@ -470,7 +470,7 @@ end
--- Set missile-player distance when missile is destroyed. --- Set missile-player distance when missile is destroyed.
-- @param #FOX self -- @param #FOX self
-- @param #number distance Distance in meters. Default 200 m. -- @param #number distance (Optional) Distance in meters. Default 200 m.
-- @return #FOX self -- @return #FOX self
function FOX:SetExplosionDistance(distance) function FOX:SetExplosionDistance(distance)
@@ -481,8 +481,8 @@ end
--- Set missile-player distance when BIG missiles are destroyed. --- Set missile-player distance when BIG missiles are destroyed.
-- @param #FOX self -- @param #FOX self
-- @param #number distance Distance in meters. Default 500 m. -- @param #number distance (Optional) Distance in meters. Default 500 m.
-- @param #number explosivemass Explosive mass of missile threshold in kg TNT. Default 50 kg. -- @param #number explosivemass (Optional) Explosive mass of missile threshold in kg TNT. Default 50 kg.
-- @return #FOX self -- @return #FOX self
function FOX:SetExplosionDistanceBigMissiles(distance, explosivemass) function FOX:SetExplosionDistanceBigMissiles(distance, explosivemass)
@@ -516,7 +516,7 @@ end
--- Set verbosity level. --- Set verbosity level.
-- @param #FOX self -- @param #FOX self
-- @param #number VerbosityLevel Level of output (higher=more). Default 0. -- @param #number VerbosityLevel (Optional) Level of output (higher=more). Default 0.
-- @return #FOX self -- @return #FOX self
function FOX:SetVerbosity(VerbosityLevel) function FOX:SetVerbosity(VerbosityLevel)
self.verbose=VerbosityLevel or 0 self.verbose=VerbosityLevel or 0
+10 -10
View File
@@ -872,8 +872,8 @@ do
--- Set to accept accoustic detection. Set this *before* MANTIS starts! --- Set to accept accoustic detection. Set this *before* MANTIS starts!
-- @param #MANTIS self -- @param #MANTIS self
-- @param #number Radius Radius in which we can "hear" units. Defaults to 2000 meters. -- @param #number Radius (Optional) Radius in which we can "hear" units. Defaults to 2000 meters.
-- @param #table UnitCategories Set what Unit Categories we can "hear". Defaults to `{Unit.Category.HELICOPTER}` -- @param #table UnitCategories (Optional) Set what Unit Categories we can "hear". Defaults to `{Unit.Category.HELICOPTER}`
-- @return #MANTIS self -- @return #MANTIS self
function MANTIS:SetAccousticDetectionOn(Radius,UnitCategories) function MANTIS:SetAccousticDetectionOn(Radius,UnitCategories)
self.DetectAccoustic = true self.DetectAccoustic = true
@@ -1032,9 +1032,9 @@ do
--- Add a SET_ZONE of zones for Shoot&Scoot - SHORAD units will move around --- Add a SET_ZONE of zones for Shoot&Scoot - SHORAD units will move around
-- @param #MANTIS self -- @param #MANTIS self
-- @param Core.Set#SET_ZONE ZoneSet Set of zones to be used. Units will move around to the next (random) zone between 100m and 3000m away. -- @param Core.Set#SET_ZONE ZoneSet Set of zones to be used. Units will move around to the next (random) zone between 100m and 3000m away.
-- @param #number Number Number of closest zones to be considered, defaults to 3. -- @param #number Number (Optional) Number of closest zones to be considered, defaults to 3.
-- @param #boolean Random If true, use a random coordinate inside the next zone to scoot to. -- @param #boolean Random If true, use a random coordinate inside the next zone to scoot to.
-- @param #string Formation Formation to use, defaults to "Cone". See mission editor dropdown for options. -- @param #string Formation (Optional) Formation to use, defaults to "Cone". See mission editor dropdown for options.
-- @return #MANTIS self -- @return #MANTIS self
function MANTIS:AddScootZones(ZoneSet, Number, Random, Formation) function MANTIS:AddScootZones(ZoneSet, Number, Random, Formation)
self:T(self.lid .. " AddScootZones") self:T(self.lid .. " AddScootZones")
@@ -1215,11 +1215,11 @@ do
--- Function to set number of SAMs going active on a valid, detected thread --- Function to set number of SAMs going active on a valid, detected thread
-- @param #MANTIS self -- @param #MANTIS self
-- @param #number Short Number of short-range systems activated, defaults to 1. -- @param #number Short (Optional) Number of short-range systems activated, defaults to 2.
-- @param #number Mid Number of mid-range systems activated, defaults to 2. -- @param #number Mid (Optional) Number of mid-range systems activated, defaults to 2.
-- @param #number Long Number of long-range systems activated, defaults to 2. -- @param #number Long (Optional) Number of long-range systems activated, defaults to 1.
-- @param #number Classic (non-automode) Number of overall systems activated, defaults to 6. -- @param #number Classic (Optional) (non-automode) Number of overall systems activated, defaults to 6.
-- @param #number Point Number of point defense and AAA systems activated, defaults to 6. -- @param #number Point (Optional) Number of point defense and AAA systems activated, defaults to 6.
-- @return #MANTIS self -- @return #MANTIS self
function MANTIS:SetMaxActiveSAMs(Short,Mid,Long,Classic,Point) function MANTIS:SetMaxActiveSAMs(Short,Mid,Long,Classic,Point)
self:T(self.lid .. "SetMaxActiveSAMs") self:T(self.lid .. "SetMaxActiveSAMs")
@@ -1341,7 +1341,7 @@ do
--- Function to set Advanded Mode --- Function to set Advanded Mode
-- @param #MANTIS self -- @param #MANTIS self
-- @param #boolean onoff If true, will activate Advanced Mode -- @param #boolean onoff If true, will activate Advanced Mode
-- @param #number ratio [optional] Percentage to use for advanced mode, defaults to 100% -- @param #number ratio (Optional) Percentage to use for advanced mode, defaults to 100%
-- @usage Advanced mode will *decrease* reactivity of MANTIS, if HQ and/or EWR network dies. Set SAMs to RED state if both are dead. Requires usage of an **HQ** object and the **dynamic** option. -- @usage Advanced mode will *decrease* reactivity of MANTIS, if HQ and/or EWR network dies. Set SAMs to RED state if both are dead. Requires usage of an **HQ** object and the **dynamic** option.
-- E.g. `mymantis:SetAdvancedMode(true, 90)` -- E.g. `mymantis:SetAdvancedMode(true, 90)`
function MANTIS:SetAdvancedMode(onoff, ratio) function MANTIS:SetAdvancedMode(onoff, ratio)
@@ -172,7 +172,7 @@ end
--- Set duration how long messages are displayed. --- Set duration how long messages are displayed.
-- @param #PSEUDOATC self -- @param #PSEUDOATC self
-- @param #number duration Time in seconds. Default is 30 sec. -- @param #number duration (Optional) Time in seconds. Default is 30 sec.
function PSEUDOATC:SetMessageDuration(duration) function PSEUDOATC:SetMessageDuration(duration)
self.mdur=duration or 30 self.mdur=duration or 30
end end
@@ -186,21 +186,21 @@ end
--- Set time interval after which the F10 radio menu is refreshed. --- Set time interval after which the F10 radio menu is refreshed.
-- @param #PSEUDOATC self -- @param #PSEUDOATC self
-- @param #number interval Interval in seconds. Default is every 120 sec. -- @param #number interval (Optional) Interval in seconds. Default is every 120 sec.
function PSEUDOATC:SetMenuRefresh(interval) function PSEUDOATC:SetMenuRefresh(interval)
self.mrefresh=interval or 120 self.mrefresh=interval or 120
end end
--- [Deprecated] Enable/disable event handling by MOOSE or DCS. --- [Deprecated] Enable/disable event handling by MOOSE or DCS.
-- @param #PSEUDOATC self -- @param #PSEUDOATC self
-- @param #boolean switch If true, events are handled by MOOSE (default). If false, events are handled directly by DCS. -- @param #boolean switch (Optional) If true, events are handled by MOOSE (default). If false, events are handled directly by DCS.
function PSEUDOATC:SetEventsMoose(switch) function PSEUDOATC:SetEventsMoose(switch)
self.eventsmoose=switch self.eventsmoose=switch
end end
--- Set time interval for reporting altitude until touchdown. --- Set time interval for reporting altitude until touchdown.
-- @param #PSEUDOATC self -- @param #PSEUDOATC self
-- @param #number interval Interval in seconds. Default is every 3 sec. -- @param #number interval (Optional) Interval in seconds. Default is every 3 sec.
function PSEUDOATC:SetReportAltInterval(interval) function PSEUDOATC:SetReportAltInterval(interval)
self.talt=interval or 3 self.talt=interval or 3
end end
+23 -23
View File
@@ -1055,7 +1055,7 @@ end
--- Set the friendly coalitions from which the airports can be used as departure and destination. --- Set the friendly coalitions from which the airports can be used as departure and destination.
-- @param #RAT self -- @param #RAT self
-- @param #string friendly "same"=own coalition+neutral (default), "sameonly"=own coalition only, "neutral"=all neutral airports. -- @param #string friendly (Optional) "same"=own coalition+neutral (default), "sameonly"=own coalition only, "neutral"=all neutral airports.
-- Default is "same", so aircraft will use airports of the coalition their spawn template has plus all neutral airports. -- Default is "same", so aircraft will use airports of the coalition their spawn template has plus all neutral airports.
-- @return #RAT RAT self object. -- @return #RAT RAT self object.
-- @usage yak:SetCoalition("neutral") will spawn aircraft randomly on all neutral airports. -- @usage yak:SetCoalition("neutral") will spawn aircraft randomly on all neutral airports.
@@ -1137,7 +1137,7 @@ end
--- Set the scan radius around parking spots. Parking spot is considered to be occupied if any obstacle is found with the radius. --- Set the scan radius around parking spots. Parking spot is considered to be occupied if any obstacle is found with the radius.
-- @param #RAT self -- @param #RAT self
-- @param #number radius Radius in meters. Default 50 m. -- @param #number radius (Optional) Radius in meters. Default 50 m.
-- @return #RAT RAT self object. -- @return #RAT RAT self object.
function RAT:SetParkingScanRadius(radius) function RAT:SetParkingScanRadius(radius)
self:F2(radius) self:F2(radius)
@@ -1503,7 +1503,7 @@ end
--- Set the delay before first group is spawned. --- Set the delay before first group is spawned.
-- @param #RAT self -- @param #RAT self
-- @param #number delay Delay in seconds. Default is 5 seconds. Minimum delay is 0.5 seconds. -- @param #number delay (Optional) Delay in seconds. Default is 5 seconds. Minimum delay is 0.5 seconds.
-- @return #RAT RAT self object. -- @return #RAT RAT self object.
function RAT:SetSpawnDelay(delay) function RAT:SetSpawnDelay(delay)
self:F2(delay) self:F2(delay)
@@ -1514,7 +1514,7 @@ end
--- Set the interval between spawnings of the template group. --- Set the interval between spawnings of the template group.
-- @param #RAT self -- @param #RAT self
-- @param #number interval Interval in seconds. Default is 5 seconds. Minimum is 0.5 seconds. -- @param #number interval (Optional) Interval in seconds. Default is 5 seconds. Minimum is 0.5 seconds.
-- @return #RAT RAT self object. -- @return #RAT RAT self object.
function RAT:SetSpawnInterval(interval) function RAT:SetSpawnInterval(interval)
self:F2(interval) self:F2(interval)
@@ -1525,7 +1525,7 @@ end
--- Set max number of groups that will be spawned. When this limit is reached, no more RAT groups are spawned. --- Set max number of groups that will be spawned. When this limit is reached, no more RAT groups are spawned.
-- @param #RAT self -- @param #RAT self
-- @param #number Nmax Max number of groups. Default `nil`=unlimited. -- @param #number Nmax (Optional) Max number of groups. Default `nil`=unlimited.
-- @return #RAT RAT self object. -- @return #RAT RAT self object.
function RAT:SetSpawnLimit(Nmax) function RAT:SetSpawnLimit(Nmax)
self.NspawnMax=Nmax self.NspawnMax=Nmax
@@ -1545,7 +1545,7 @@ end
--- Sets the delay between despawning and respawning aircraft. --- Sets the delay between despawning and respawning aircraft.
-- @param #RAT self -- @param #RAT self
-- @param #number delay Delay in seconds until respawn happens. Default is 1 second. Minimum is 1 second. -- @param #number delay (Optional) Delay in seconds until respawn happens. Default is 1 second. Minimum is 1 second.
-- @return #RAT RAT self object. -- @return #RAT RAT self object.
function RAT:SetRespawnDelay(delay) function RAT:SetRespawnDelay(delay)
self:F2(delay) self:F2(delay)
@@ -1566,7 +1566,7 @@ end
--- Number of tries to respawn an aircraft in case it has accidentally been spawned on runway. --- Number of tries to respawn an aircraft in case it has accidentally been spawned on runway.
-- @param #RAT self -- @param #RAT self
-- @param #number n Number of retries. Default is 3. -- @param #number n (Optional) Number of retries. Default is 3.
-- @return #RAT RAT self object. -- @return #RAT RAT self object.
function RAT:SetMaxRespawnTriedWhenSpawnedOnRunway(n) function RAT:SetMaxRespawnTriedWhenSpawnedOnRunway(n)
self:F2(n) self:F2(n)
@@ -1624,7 +1624,7 @@ end
--- Check if aircraft have accidentally been spawned on the runway. If so they will be removed immediately. --- Check if aircraft have accidentally been spawned on the runway. If so they will be removed immediately.
-- @param #RAT self -- @param #RAT self
-- @param #boolean switch If true, check is performed. If false, this check is omitted. -- @param #boolean switch If true, check is performed. If false, this check is omitted.
-- @param #number radius Distance in meters until a unit is considered to have spawned accidentally on the runway. Default is 75 m. -- @param #number radius (Optional) Distance in meters until a unit is considered to have spawned accidentally on the runway. Default is 75 m.
-- @return #RAT RAT self object. -- @return #RAT RAT self object.
function RAT:CheckOnRunway(switch, distance) function RAT:CheckOnRunway(switch, distance)
self:F2(switch) self:F2(switch)
@@ -1639,7 +1639,7 @@ end
--- Check if aircraft have accidentally been spawned on top of each other. If yes, they will be removed immediately. --- Check if aircraft have accidentally been spawned on top of each other. If yes, they will be removed immediately.
-- @param #RAT self -- @param #RAT self
-- @param #boolean switch If true, check is performed. If false, this check is omitted. -- @param #boolean switch If true, check is performed. If false, this check is omitted.
-- @param #number radius Radius in meters until which a unit is considered to be on top of each other. Default is 2 m. -- @param #number radius (Optional) Radius in meters until which a unit is considered to be on top of each other. Default is 2 m.
-- @return #RAT RAT self object. -- @return #RAT RAT self object.
function RAT:CheckOnTop(switch, radius) function RAT:CheckOnTop(switch, radius)
self:F2(switch) self:F2(switch)
@@ -1755,10 +1755,10 @@ end
--- Define how aircraft that are spawned in uncontrolled state are activate. --- Define how aircraft that are spawned in uncontrolled state are activate.
-- @param #RAT self -- @param #RAT self
-- @param #number maxactivated Maximal numnber of activated aircraft. Absolute maximum will be the number of spawned groups. Default is 1. -- @param #number maxactivated (Optional) Maximal numnber of activated aircraft. Absolute maximum will be the number of spawned groups. Default is 1.
-- @param #number delay Time delay in seconds before (first) aircraft is activated. Default is 1 second. -- @param #number delay (Optional) Time delay in seconds before (first) aircraft is activated. Default is 1 second.
-- @param #number delta Time difference in seconds before next aircraft is activated. Default is 1 second. -- @param #number delta (Optional) Time difference in seconds before next aircraft is activated. Default is 1 second.
-- @param #number frand Factor [0,...,1] for randomization of time difference between aircraft activations. Default is 0, i.e. no randomization. -- @param #number frand (Optional) Factor [0,...,1] for randomization of time difference between aircraft activations. Default is 0, i.e. no randomization.
-- @return #RAT RAT self object. -- @return #RAT RAT self object.
function RAT:ActivateUncontrolled(maxactivated, delay, delta, frand) function RAT:ActivateUncontrolled(maxactivated, delay, delta, frand)
self:F2({max=maxactivated, delay=delay, delta=delta, rand=frand}) self:F2({max=maxactivated, delay=delay, delta=delta, rand=frand})
@@ -1784,7 +1784,7 @@ end
--- Set the time after which inactive groups will be destroyed. --- Set the time after which inactive groups will be destroyed.
-- @param #RAT self -- @param #RAT self
-- @param #number time Time in seconds. Default is 600 seconds = 10 minutes. Minimum is 60 seconds. -- @param #number time (Optional) Time in seconds. Default is 600 seconds = 10 minutes. Minimum is 60 seconds.
-- @return #RAT RAT self object. -- @return #RAT RAT self object.
function RAT:TimeDestroyInactive(time) function RAT:TimeDestroyInactive(time)
self:F2(time) self:F2(time)
@@ -1818,7 +1818,7 @@ end
--- Set the climb rate. This automatically sets the climb angle. --- Set the climb rate. This automatically sets the climb angle.
-- @param #RAT self -- @param #RAT self
-- @param #number rate Climb rate in ft/min. Default is 1500 ft/min. Minimum is 100 ft/min. Maximum is 15,000 ft/min. -- @param #number rate (Optional) Climb rate in ft/min. Default is 1500 ft/min. Minimum is 100 ft/min. Maximum is 15,000 ft/min.
-- @return #RAT RAT self object. -- @return #RAT RAT self object.
function RAT:SetClimbRate(rate) function RAT:SetClimbRate(rate)
self:F2(rate) self:F2(rate)
@@ -1912,7 +1912,7 @@ end
--- Max number of planes that get landing clearance of the RAT ATC. This setting effects all RAT objects and groups! --- Max number of planes that get landing clearance of the RAT ATC. This setting effects all RAT objects and groups!
-- @param #RAT self -- @param #RAT self
-- @param #number n Number of aircraft that are allowed to land simultaniously. Default is 2. -- @param #number n (Optional) Number of aircraft that are allowed to land simultaniously. Default is 2.
-- @return #RAT RAT self object. -- @return #RAT RAT self object.
function RAT:ATC_Clearance(n) function RAT:ATC_Clearance(n)
self:F2(n) self:F2(n)
@@ -1922,7 +1922,7 @@ end
--- Delay between granting landing clearance for simultanious landings. This setting effects all RAT objects and groups! --- Delay between granting landing clearance for simultanious landings. This setting effects all RAT objects and groups!
-- @param #RAT self -- @param #RAT self
-- @param #number time Delay time when the next aircraft will get landing clearance event if the previous one did not land yet. Default is 240 sec. -- @param #number time (Optional) Delay time when the next aircraft will get landing clearance event if the previous one did not land yet. Default is 240 sec.
-- @return #RAT RAT self object. -- @return #RAT RAT self object.
function RAT:ATC_Delay(time) function RAT:ATC_Delay(time)
self:F2(time) self:F2(time)
@@ -2767,7 +2767,7 @@ end
--- Despawn group. The `FLIGHTGROUP` is despawned and stopped. The ratcraft is removed from the self.ratcraft table. Menues are removed. --- Despawn group. The `FLIGHTGROUP` is despawned and stopped. The ratcraft is removed from the self.ratcraft table. Menues are removed.
-- @param #RAT self -- @param #RAT self
-- @param Wrapper.Group#GROUP group Group to be despawned. -- @param Wrapper.Group#GROUP group Group to be despawned.
-- @param #number delay Delay in seconds before the despawn happens. Default is immidiately. -- @param #number delay (Optional) Delay in seconds before the despawn happens. Default is immidiately.
function RAT:_Despawn(group, delay) function RAT:_Despawn(group, delay)
if delay and delay>0 then if delay and delay>0 then
@@ -4705,7 +4705,7 @@ end
--- Anticipated group name from alias and spawn index. --- Anticipated group name from alias and spawn index.
-- @param #RAT self -- @param #RAT self
-- @param #number index Spawnindex of group if given or self.SpawnIndex+1 by default. -- @param #number index (Optional) Spawnindex of group if given or self.SpawnIndex+1 by default.
-- @return #string Name the group will get after it is spawned. -- @return #string Name the group will get after it is spawned.
function RAT:_AnticipatedGroupName(index) function RAT:_AnticipatedGroupName(index)
local index=index or self.SpawnIndex+1 local index=index or self.SpawnIndex+1
@@ -6013,7 +6013,7 @@ end
--- Adds a RAT object to the RAT manager. Parameter min specifies the limit how many RAT groups are at least alive. --- Adds a RAT object to the RAT manager. Parameter min specifies the limit how many RAT groups are at least alive.
-- @param #RATMANAGER self -- @param #RATMANAGER self
-- @param #RAT ratobject RAT object to be managed. -- @param #RAT ratobject RAT object to be managed.
-- @param #number min Minimum number of groups for this RAT object. Default is 1. -- @param #number min (Optional) Minimum number of groups for this RAT object. Default is 1.
-- @return #RATMANAGER RATMANAGER self object. -- @return #RATMANAGER RATMANAGER self object.
function RATMANAGER:Add(ratobject,min) function RATMANAGER:Add(ratobject,min)
@@ -6041,7 +6041,7 @@ end
--- Starts the RAT manager and spawns the initial random number RAT groups for each RAT object. --- Starts the RAT manager and spawns the initial random number RAT groups for each RAT object.
-- @param #RATMANAGER self -- @param #RATMANAGER self
-- @param #number delay Time delay in seconds after which the RAT manager is started. Default is 5 seconds. -- @param #number delay (Optional) Time delay in seconds after which the RAT manager is started. Default is 5 seconds.
-- @return #RATMANAGER RATMANAGER self object. -- @return #RATMANAGER RATMANAGER self object.
function RATMANAGER:Start(delay) function RATMANAGER:Start(delay)
@@ -6114,7 +6114,7 @@ end
--- Stops the RAT manager. --- Stops the RAT manager.
-- @param #RATMANAGER self -- @param #RATMANAGER self
-- @param #number delay Delay in seconds before the manager is stopped. Default is 1 second. -- @param #number delay (Optional) Delay in seconds before the manager is stopped. Default is 1 second.
-- @return #RATMANAGER RATMANAGER self object. -- @return #RATMANAGER RATMANAGER self object.
function RATMANAGER:Stop(delay) function RATMANAGER:Stop(delay)
delay=delay or 1 delay=delay or 1
@@ -6150,7 +6150,7 @@ end
--- Sets the time interval between spawning of groups. --- Sets the time interval between spawning of groups.
-- @param #RATMANAGER self -- @param #RATMANAGER self
-- @param #number dt Time interval in seconds. Default is 1 second. -- @param #number dt (Optional) Time interval in seconds. Default is 1 second.
-- @return #RATMANAGER RATMANAGER self object. -- @return #RATMANAGER RATMANAGER self object.
function RATMANAGER:SetTspawn(dt) function RATMANAGER:SetTspawn(dt)
self.dTspawn=dt or 1.0 self.dTspawn=dt or 1.0
+36 -34
View File
@@ -949,7 +949,7 @@ end
--- Set maximal strafing altitude. Player entering a strafe pit above that altitude are not registered for a valid pass. --- Set maximal strafing altitude. Player entering a strafe pit above that altitude are not registered for a valid pass.
-- @param #RANGE self -- @param #RANGE self
-- @param #number maxalt Maximum altitude in meters AGL. Default is 914 m = 3000 ft. -- @param #number maxalt (Optional) Maximum altitude in meters AGL. Default is 914 m = 3000 ft.
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetMaxStrafeAlt( maxalt ) function RANGE:SetMaxStrafeAlt( maxalt )
self.strafemaxalt = maxalt or RANGE.Defaults.strafemaxalt self.strafemaxalt = maxalt or RANGE.Defaults.strafemaxalt
@@ -958,7 +958,7 @@ end
--- Set time interval for tracking bombs. A smaller time step increases accuracy but needs more CPU time. --- Set time interval for tracking bombs. A smaller time step increases accuracy but needs more CPU time.
-- @param #RANGE self -- @param #RANGE self
-- @param #number dt Time interval in seconds. Default is 0.005 s. -- @param #number dt (Optional) Time interval in seconds. Default is 0.005 s.
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetBombtrackTimestep( dt ) function RANGE:SetBombtrackTimestep( dt )
self.dtBombtrack = dt or RANGE.Defaults.dtBombtrack self.dtBombtrack = dt or RANGE.Defaults.dtBombtrack
@@ -967,7 +967,7 @@ end
--- Set time how long (most) messages are displayed. --- Set time how long (most) messages are displayed.
-- @param #RANGE self -- @param #RANGE self
-- @param #number time Time in seconds. Default is 30 s. -- @param #number time (Optional) Time in seconds. Default is 30 s.
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetMessageTimeDuration( time ) function RANGE:SetMessageTimeDuration( time )
self.Tmsg = time or RANGE.Defaults.Tmsg self.Tmsg = time or RANGE.Defaults.Tmsg
@@ -1009,8 +1009,8 @@ end
--- Set FunkMan socket. Bombing and strafing results will be send to your Discord bot. --- Set FunkMan socket. Bombing and strafing results will be send to your Discord bot.
-- **Requires running FunkMan program**. -- **Requires running FunkMan program**.
-- @param #RANGE self -- @param #RANGE 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 #RANGE self -- @return #RANGE self
function RANGE:SetFunkManOn(Port, Host) function RANGE:SetFunkManOn(Port, Host)
@@ -1032,7 +1032,7 @@ end
--- Set max number of player results that are displayed. --- Set max number of player results that are displayed.
-- @param #RANGE self -- @param #RANGE self
-- @param #number nmax Number of results. Default is 10. -- @param #number nmax (Optional) Number of results. Default is 10.
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetDisplayedMaxPlayerResults( nmax ) function RANGE:SetDisplayedMaxPlayerResults( nmax )
self.ndisplayresult = nmax or RANGE.Defaults.ndisplayresult self.ndisplayresult = nmax or RANGE.Defaults.ndisplayresult
@@ -1041,7 +1041,7 @@ end
--- Set range radius. Defines the area in which e.g. bomb impacts are smoked. --- Set range radius. Defines the area in which e.g. bomb impacts are smoked.
-- @param #RANGE self -- @param #RANGE self
-- @param #number radius Radius in km. Default 5 km. -- @param #number radius (Optional) Radius in km. Default 5 km.
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetRangeRadius( radius ) function RANGE:SetRangeRadius( radius )
self.rangeradius = radius * 1000 or RANGE.Defaults.rangeradius self.rangeradius = radius * 1000 or RANGE.Defaults.rangeradius
@@ -1050,7 +1050,7 @@ end
--- Set player setting whether bomb impact points are smoked or not. --- Set player setting whether bomb impact points are smoked or not.
-- @param #RANGE self -- @param #RANGE self
-- @param #boolean switch If true nor nil default is to smoke impact points of bombs. -- @param #boolean switch (Optional) If true nor nil default is to smoke impact points of bombs.
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetDefaultPlayerSmokeBomb( switch ) function RANGE:SetDefaultPlayerSmokeBomb( switch )
if switch == true or switch == nil then if switch == true or switch == nil then
@@ -1063,7 +1063,7 @@ end
--- Set bomb track threshold distance. Bombs/rockets/missiles are only tracked if player-range distance is less than this distance. Default 25 km. --- Set bomb track threshold distance. Bombs/rockets/missiles are only tracked if player-range distance is less than this distance. Default 25 km.
-- @param #RANGE self -- @param #RANGE self
-- @param #number distance Threshold distance in km. Default 25 km. -- @param #number distance (Optional) Threshold distance in km. Default 25 km.
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetBombtrackThreshold( distance ) function RANGE:SetBombtrackThreshold( distance )
self.BombtrackThreshold = (distance or 25) * 1000 self.BombtrackThreshold = (distance or 25) * 1000
@@ -1110,7 +1110,7 @@ end
--- Enable range ceiling. Aircraft must be below the ceiling altitude to be considered in the range zone. --- Enable range ceiling. Aircraft must be below the ceiling altitude to be considered in the range zone.
-- @param #RANGE self -- @param #RANGE self
-- @param #boolean enabled True if you would like to enable the ceiling check. If no value give, will Default to false. -- @param #boolean enabled (Optional) True if you would like to enable the ceiling check. If no value give, will Default to false.
-- @return #RANGE self -- @return #RANGE self
function RANGE:EnableRangeCeiling( enabled ) function RANGE:EnableRangeCeiling( enabled )
self:T(self.lid.."EnableRangeCeiling") self:T(self.lid.."EnableRangeCeiling")
@@ -1126,7 +1126,7 @@ end
--- Set smoke color for marking bomb targets. By default bomb targets are marked by red smoke. --- Set smoke color for marking bomb targets. By default bomb targets are marked by red smoke.
-- @param #RANGE self -- @param #RANGE self
-- @param Utilities.Utils#SMOKECOLOR colorid Color id. Default `SMOKECOLOR.Red`. -- @param Utilities.Utils#SMOKECOLOR colorid (Optional) Color id. Default `SMOKECOLOR.Red`.
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetBombTargetSmokeColor( colorid ) function RANGE:SetBombTargetSmokeColor( colorid )
self.BombSmokeColor = colorid or SMOKECOLOR.Red self.BombSmokeColor = colorid or SMOKECOLOR.Red
@@ -1135,7 +1135,7 @@ end
--- Set score bomb distance. --- Set score bomb distance.
-- @param #RANGE self -- @param #RANGE self
-- @param #number distance Distance in meters. Default 1000 m. -- @param #number distance (Optional) Distance in meters. Default 1000 m.
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetScoreBombDistance( distance ) function RANGE:SetScoreBombDistance( distance )
self.scorebombdistance = distance or 1000 self.scorebombdistance = distance or 1000
@@ -1144,7 +1144,7 @@ end
--- Set smoke color for marking strafe targets. By default strafe targets are marked by green smoke. --- Set smoke color for marking strafe targets. By default strafe targets are marked by green smoke.
-- @param #RANGE self -- @param #RANGE self
-- @param Utilities.Utils#SMOKECOLOR colorid Color id. Default `SMOKECOLOR.Green`. -- @param Utilities.Utils#SMOKECOLOR colorid (Optional) Color id. Default `SMOKECOLOR.Green`.
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetStrafeTargetSmokeColor( colorid ) function RANGE:SetStrafeTargetSmokeColor( colorid )
self.StrafeSmokeColor = colorid or SMOKECOLOR.Green self.StrafeSmokeColor = colorid or SMOKECOLOR.Green
@@ -1153,7 +1153,7 @@ end
--- Set smoke color for marking strafe pit approach boxes. By default strafe pit boxes are marked by white smoke. --- Set smoke color for marking strafe pit approach boxes. By default strafe pit boxes are marked by white smoke.
-- @param #RANGE self -- @param #RANGE self
-- @param Utilities.Utils#SMOKECOLOR colorid Color id. Default `SMOKECOLOR.White`. -- @param Utilities.Utils#SMOKECOLOR colorid (Optional) Color id. Default `SMOKECOLOR.White`.
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetStrafePitSmokeColor( colorid ) function RANGE:SetStrafePitSmokeColor( colorid )
self.StrafePitSmokeColor = colorid or SMOKECOLOR.White self.StrafePitSmokeColor = colorid or SMOKECOLOR.White
@@ -1162,7 +1162,7 @@ end
--- Set time delay between bomb impact and starting to smoke the impact point. --- Set time delay between bomb impact and starting to smoke the impact point.
-- @param #RANGE self -- @param #RANGE self
-- @param #number delay Time delay in seconds. Default is 3 seconds. -- @param #number delay (Optional) Time delay in seconds. Default is 3 seconds.
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetSmokeTimeDelay( delay ) function RANGE:SetSmokeTimeDelay( delay )
self.TdelaySmoke = delay or RANGE.Defaults.TdelaySmoke self.TdelaySmoke = delay or RANGE.Defaults.TdelaySmoke
@@ -1252,11 +1252,11 @@ end
--- Use SRS Simple-Text-To-Speech for transmissions. No sound files necessary. --- Use SRS Simple-Text-To-Speech for transmissions. No sound files necessary.
-- @param #RANGE self -- @param #RANGE self
-- @param #string PathToSRS Path to SRS directory. -- @param #string PathToSRS Path to SRS directory.
-- @param #number Port SRS port. Default 5002. -- @param #number Port (Optional) SRS port. Default 5002.
-- @param #number Coalition Coalition side, e.g. `coalition.side.BLUE` or `coalition.side.RED`. Default `coalition.side.BLUE`. -- @param #number Coalition (Optional) Coalition side, e.g. `coalition.side.BLUE` or `coalition.side.RED`. Default `coalition.side.BLUE`.
-- @param #number Frequency Frequency to use. Default is 256 MHz for range control and 305 MHz for instructor. If given, both control and instructor get this frequency. -- @param #number Frequency (Optional) Frequency to use. Default is 256 MHz for range control and 305 MHz for instructor. If given, both control and instructor get this frequency.
-- @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 Volume Volume, between 0.0 and 1.0. Defaults to 1.0 -- @param #number Volume (Optional) Volume, between 0.0 and 1.0. Defaults to 1.0
-- @param #string PathToGoogleKey Path to Google TTS credentials. -- @param #string PathToGoogleKey Path to Google TTS credentials.
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetSRS(PathToSRS, Port, Coalition, Frequency, Modulation, Volume, PathToGoogleKey) function RANGE:SetSRS(PathToSRS, Port, Coalition, Frequency, Modulation, Volume, PathToGoogleKey)
@@ -1300,11 +1300,11 @@ end
--- (SRS) Set range control frequency and voice. Use `RANGE:SetSRS()` once first before using this function. --- (SRS) Set range control frequency and voice. Use `RANGE:SetSRS()` once first before using this function.
-- @param #RANGE self -- @param #RANGE self
-- @param #number frequency Frequency in MHz. Default 256 MHz. -- @param #number frequency (Optional) Frequency in MHz. Default 256 MHz.
-- @param #number modulation Modulation, defaults to radio.modulation.AM. -- @param #number modulation (Optional) Modulation, defaults to radio.modulation.AM.
-- @param #string voice Voice. -- @param #string voice Voice.
-- @param #string culture Culture, defaults to "en-US". -- @param #string culture (Optional) Culture, defaults to "en-US".
-- @param #string gender Gender, defaults to "female". -- @param #string gender (Optional) Gender, defaults to "female".
-- @param #string relayunitname Name of the unit used for transmission location. -- @param #string relayunitname Name of the unit used for transmission location.
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetSRSRangeControl( frequency, modulation, voice, culture, gender, relayunitname ) function RANGE:SetSRSRangeControl( frequency, modulation, voice, culture, gender, relayunitname )
@@ -1334,11 +1334,11 @@ end
--- (SRS) Set range instructor frequency and voice. Use `RANGE:SetSRS()` once first before using this function. --- (SRS) Set range instructor frequency and voice. Use `RANGE:SetSRS()` once first before using this function.
-- @param #RANGE self -- @param #RANGE self
-- @param #number frequency Frequency in MHz. Default 305 MHz. -- @param #number frequency (Optional) Frequency in MHz. Default 305 MHz.
-- @param #number modulation Modulation, defaults to radio.modulation.AM. -- @param #number modulation (Optional) Modulation, defaults to radio.modulation.AM.
-- @param #string voice Voice. -- @param #string voice Voice.
-- @param #string culture Culture, defaults to "en-US". -- @param #string culture (Optional) Culture, defaults to "en-US".
-- @param #string gender Gender, defaults to "male". -- @param #string gender (Optional) Gender, defaults to "male".
-- @param #string relayunitname Name of the unit used for transmission location. -- @param #string relayunitname Name of the unit used for transmission location.
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetSRSRangeInstructor( frequency, modulation, voice, culture, gender, relayunitname ) function RANGE:SetSRSRangeInstructor( frequency, modulation, voice, culture, gender, relayunitname )
@@ -1368,7 +1368,7 @@ end
--- Enable range control and set frequency (non-SRS). --- Enable range control and set frequency (non-SRS).
-- @param #RANGE self -- @param #RANGE self
-- @param #number frequency Frequency in MHz. Default 256 MHz. -- @param #number frequency (Optional) Frequency in MHz. Default 256 MHz.
-- @param #string relayunitname Name of the unit used for transmission. -- @param #string relayunitname Name of the unit used for transmission.
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetRangeControl( frequency, relayunitname ) function RANGE:SetRangeControl( frequency, relayunitname )
@@ -1379,7 +1379,7 @@ end
--- Enable instructor radio and set frequency (non-SRS). --- Enable instructor radio and set frequency (non-SRS).
-- @param #RANGE self -- @param #RANGE self
-- @param #number frequency Frequency in MHz. Default 305 MHz. -- @param #number frequency (Optional) Frequency in MHz. Default 305 MHz.
-- @param #string relayunitname Name of the unit used for transmission. -- @param #string relayunitname Name of the unit used for transmission.
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetInstructorRadio( frequency, relayunitname ) function RANGE:SetInstructorRadio( frequency, relayunitname )
@@ -1390,7 +1390,7 @@ end
--- Set sound files folder within miz file. --- Set sound files folder within miz file.
-- @param #RANGE self -- @param #RANGE self
-- @param #string path Path for sound files. Default "Range Soundfiles/". Mind the slash "/" at the end! -- @param #string path (Optional) Path for sound files. Default "Range Soundfiles/". Mind the slash "/" at the end!
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetSoundfilesPath( path ) function RANGE:SetSoundfilesPath( path )
self.soundpath = tostring( path or "Range Soundfiles/" ) self.soundpath = tostring( path or "Range Soundfiles/" )
@@ -1630,11 +1630,13 @@ end
-- @param #RANGE self -- @param #RANGE self
-- @param #table targetnames Single or multiple (Table) names of unit or static objects serving as bomb targets. -- @param #table targetnames Single or multiple (Table) names of unit or static objects serving as bomb targets.
-- @param #number goodhitrange (Optional) Max distance from target unit (in meters) which is considered as a good hit. Default is 25 m. -- @param #number goodhitrange (Optional) Max distance from target unit (in meters) which is considered as a good hit. Default is 25 m.
-- @param #boolean randommove If true, unit will move randomly within the range. Default is false. -- @param #boolean randommove (Optional) If true, unit will move randomly within the range. Default is false.
-- @return #RANGE self -- @return #RANGE self
function RANGE:AddBombingTargets( targetnames, goodhitrange, randommove ) function RANGE:AddBombingTargets( targetnames, goodhitrange, randommove )
self:F( { targetnames = targetnames, goodhitrange = goodhitrange, randommove = randommove } ) self:F( { targetnames = targetnames, goodhitrange = goodhitrange, randommove = randommove } )
randommove = randommove or false
-- Create a table if necessary. -- Create a table if necessary.
if type( targetnames ) ~= "table" then if type( targetnames ) ~= "table" then
targetnames = { targetnames } targetnames = { targetnames }
@@ -1669,7 +1671,7 @@ end
-- @param #RANGE self -- @param #RANGE self
-- @param Wrapper.Positionable#POSITIONABLE unit Positionable (unit or static) of the bombing target. -- @param Wrapper.Positionable#POSITIONABLE unit Positionable (unit or static) of the bombing target.
-- @param #number goodhitrange Max distance from unit which is considered as a good hit. -- @param #number goodhitrange Max distance from unit which is considered as a good hit.
-- @param #boolean randommove If true, unit will move randomly within the range. Default is false. -- @param #boolean randommove (Optional) If true, unit will move randomly within the range. Default is false.
-- @return #RANGE self -- @return #RANGE self
function RANGE:AddBombingTargetUnit( unit, goodhitrange, randommove ) function RANGE:AddBombingTargetUnit( unit, goodhitrange, randommove )
self:F( { unit = unit, goodhitrange = goodhitrange, randommove = randommove } ) self:F( { unit = unit, goodhitrange = goodhitrange, randommove = randommove } )
@@ -1785,7 +1787,7 @@ end
-- @param #RANGE self -- @param #RANGE self
-- @param Wrapper.Group#GROUP group Group of bombing targets. Can also be given as group name. -- @param Wrapper.Group#GROUP group Group of bombing targets. Can also be given as group name.
-- @param #number goodhitrange Max distance from unit which is considered as a good hit. -- @param #number goodhitrange Max distance from unit which is considered as a good hit.
-- @param #boolean randommove If true, unit will move randomly within the range. Default is false. -- @param #boolean randommove (Optional) If true, unit will move randomly within the range. Default is false.
-- @return #RANGE self -- @return #RANGE self
function RANGE:AddBombingTargetGroup( group, goodhitrange, randommove ) function RANGE:AddBombingTargetGroup( group, goodhitrange, randommove )
self:F( { group = group, goodhitrange = goodhitrange, randommove = randommove } ) self:F( { group = group, goodhitrange = goodhitrange, randommove = randommove } )
@@ -394,7 +394,7 @@ end
--- Set a prefix string that will be displayed at each scoring message sent. --- Set a prefix string that will be displayed at each scoring message sent.
-- @param #SCORING self -- @param #SCORING self
-- @param #string DisplayMessagePrefix (Default="Scoring: ") The scoring prefix string. -- @param #string DisplayMessagePrefix (Optional) (Default="Scoring: ") The scoring prefix string.
-- @return #SCORING -- @return #SCORING
function SCORING:SetDisplayMessagePrefix( DisplayMessagePrefix ) function SCORING:SetDisplayMessagePrefix( DisplayMessagePrefix )
self.DisplayMessagePrefix = DisplayMessagePrefix or "" self.DisplayMessagePrefix = DisplayMessagePrefix or ""
+2 -2
View File
@@ -182,7 +182,7 @@ end
--- Sets the engagement range of the SAMs. Defaults to 75% to make it more deadly. Feature Request #1355 --- Sets the engagement range of the SAMs. Defaults to 75% to make it more deadly. Feature Request #1355
-- @param #SEAD self -- @param #SEAD self
-- @param #number range Set the engagement range in percent, e.g. 55 (default 75) -- @param #number range (Optional) Set the engagement range in percent, e.g. 55 (default 75)
-- @return #SEAD self -- @return #SEAD self
function SEAD:SetEngagementRange(range) function SEAD:SetEngagementRange(range)
self:T( { range } ) self:T( { range } )
@@ -197,7 +197,7 @@ end
--- Set the padding in seconds, which extends the radar off time calculated by SEAD --- Set the padding in seconds, which extends the radar off time calculated by SEAD
-- @param #SEAD self -- @param #SEAD self
-- @param #number Padding Extra number of seconds to add for the switch-on (default 10 seconds) -- @param #number Padding (Optional) Extra number of seconds to add for the switch-on (default 10 seconds)
-- @return #SEAD self -- @return #SEAD self
function SEAD:SetPadding(Padding) function SEAD:SetPadding(Padding)
self:T( { Padding } ) self:T( { Padding } )
@@ -158,15 +158,15 @@ do
--- Instantiates a new SHORAD object --- Instantiates a new SHORAD object
-- @param #SHORAD self -- @param #SHORAD self
-- @param #string Name Name of this SHORAD -- @param #string Name (Optional) Name of this SHORAD. Default "MyShorad"
-- @param #string ShoradPrefix Filter for the Shorad #SET_GROUP -- @param #string ShoradPrefix (Optional) Filter for the Shorad #SET_GROUP. Default "SAM SHORAD"
-- @param Core.Set#SET_GROUP Samset The #SET_GROUP of SAM sites to defend -- @param Core.Set#SET_GROUP Samset (Optional) The #SET_GROUP of SAM sites to defend. Default is based on default ShoradPrefix and default Coalition.
-- @param #number Radius Defense radius in meters, used to switch on SHORAD groups **within** this radius -- @param #number Radius (Optional) Defense radius in meters, used to switch on SHORAD groups **within** this radius. Default is 20000m.
-- @param #number ActiveTimer Determines how many seconds the systems stay on red alert after wake-up call -- @param #number ActiveTimer (Optional) Determines how many seconds the systems stay on red alert after wake-up call. Default 600s
-- @param #string Coalition Coalition, i.e. "blue", "red", or "neutral" -- @param #string Coalition Coalition, i.e. "blue", "red", or "neutral"
-- @param #boolean UseEmOnOff Use Emissions On/Off rather than Alarm State Red/Green (default: use Emissions switch) -- @param #boolean UseEmOnOff Use Emissions On/Off rather than Alarm State Red/Green (default: use Emissions switch)
-- @param #boolean SmokeDecoy Throw smoke decoy when getting activated. Defaults to false. -- @param #boolean SmokeDecoy (Optional) Throw smoke decoy when getting activated. Defaults to false.
-- @param #number SmokeDecoyColor SMOLECOLOR to use. Defaults to SMOLECOLOR.White -- @param #number SmokeDecoyColor (Optional) SMOLECOLOR to use. Defaults to SMOLECOLOR.White
-- @return #SHORAD self -- @return #SHORAD self
function SHORAD:New(Name, ShoradPrefix, Samset, Radius, ActiveTimer, Coalition, UseEmOnOff, SmokeDecoy, SmokeDecoyColor) function SHORAD:New(Name, ShoradPrefix, Samset, Radius, ActiveTimer, Coalition, UseEmOnOff, SmokeDecoy, SmokeDecoyColor)
local self = BASE:Inherit( self, FSM:New() ) local self = BASE:Inherit( self, FSM:New() )
@@ -240,9 +240,9 @@ do
--- Add a SET_ZONE of zones for Shoot&Scoot --- Add a SET_ZONE of zones for Shoot&Scoot
-- @param #SHORAD self -- @param #SHORAD self
-- @param Core.Set#SET_ZONE ZoneSet Set of zones to be used. Units will move around to the next (random) zone between 100m and 3000m away. -- @param Core.Set#SET_ZONE ZoneSet Set of zones to be used. Units will move around to the next (random) zone between 100m and 3000m away.
-- @param #number Number Number of closest zones to be considered, defaults to 3. -- @param #number Number (Optional) Number of closest zones to be considered, defaults to 3.
-- @param #boolean Random If true, use a random coordinate inside the next zone to scoot to. -- @param #boolean Random If true, use a random coordinate inside the next zone to scoot to.
-- @param #string Formation Formation to use, defaults to "Cone". See mission editor dropdown for options. -- @param #string Formation (Optional) Formation to use, defaults to "Cone". See mission editor dropdown for options.
-- @return #SHORAD self -- @return #SHORAD self
function SHORAD:AddScootZones(ZoneSet, Number, Random, Formation) function SHORAD:AddScootZones(ZoneSet, Number, Random, Formation)
self:T(self.lid .. " AddScootZones") self:T(self.lid .. " AddScootZones")
+10 -10
View File
@@ -251,7 +251,7 @@ STRATEGO.Type = {
-- @param #STRATEGO self -- @param #STRATEGO self
-- @param #string Name Name of the Adviser. -- @param #string Name Name of the Adviser.
-- @param #number Coalition Coalition, e.g. coalition.side.BLUE. -- @param #number Coalition Coalition, e.g. coalition.side.BLUE.
-- @param #number MaxDist Maximum distance of a single route in kilometers, defaults to 150. -- @param #number MaxDist (Optional) Maximum distance of a single route in kilometers, defaults to 150.
-- @return #STRATEGO self -- @return #STRATEGO self
function STRATEGO:New(Name,Coalition,MaxDist) function STRATEGO:New(Name,Coalition,MaxDist)
-- Inherit everything from FSM class. -- Inherit everything from FSM class.
@@ -362,7 +362,7 @@ end
--- [USER] Set up usage of budget and set an initial budget in points. --- [USER] Set up usage of budget and set an initial budget in points.
-- @param #STRATEGO self -- @param #STRATEGO self
-- @param #boolean Usebudget If true, use budget for advisory calculations. -- @param #boolean Usebudget If true, use budget for advisory calculations.
-- @param #number StartBudget Initial budget to be used, defaults to 500. -- @param #number StartBudget (Optional) Initial budget to be used, defaults to 500.
function STRATEGO:SetUsingBudget(Usebudget,StartBudget) function STRATEGO:SetUsingBudget(Usebudget,StartBudget)
self:T(self.lid.."SetUsingBudget") self:T(self.lid.."SetUsingBudget")
self.usebudget = Usebudget self.usebudget = Usebudget
@@ -394,10 +394,10 @@ end
--- [USER] Set weights for nodes and routes to determine their importance. --- [USER] Set weights for nodes and routes to determine their importance.
-- @param #STRATEGO self -- @param #STRATEGO self
-- @param #number MaxRunways Set the maximum number of runways the big (equals strategic) airbases on the map have. Defaults to 3. The weight of an airbase node hence equals the number of runways. -- @param #number MaxRunways (Optional) Set the maximum number of runways the big (equals strategic) airbases on the map have. Defaults to 3. The weight of an airbase node hence equals the number of runways.
-- @param #number PortWeight Set what weight a port node has. Defaults to 3. -- @param #number PortWeight (Optional) Set what weight a port node has. Defaults to 3.
-- @param #number POIWeight Set what weight a POI node has. Defaults to 1. -- @param #number POIWeight (Optional) Set what weight a POI node has. Defaults to 1.
-- @param #number RouteFactor Defines which weight each route between two defined nodes gets: Weight * RouteFactor. -- @param #number RouteFactor (Optional) Defines which weight each route between two defined nodes gets: Weight * RouteFactor. Defaults to 5.
-- @return #STRATEGO self -- @return #STRATEGO self
function STRATEGO:SetWeights(MaxRunways,PortWeight,POIWeight,RouteFactor) function STRATEGO:SetWeights(MaxRunways,PortWeight,POIWeight,RouteFactor)
self:T(self.lid.."SetWeights") self:T(self.lid.."SetWeights")
@@ -410,7 +410,7 @@ end
--- [USER] Set neutral benefit, i.e. how many points it is cheaper to decide for a neutral vs an enemy node when taking decisions. --- [USER] Set neutral benefit, i.e. how many points it is cheaper to decide for a neutral vs an enemy node when taking decisions.
-- @param #STRATEGO self -- @param #STRATEGO self
-- @param #number NeutralBenefit Pointsm defaults to 100. -- @param #number NeutralBenefit (Optional) Pointsm defaults to 100.
-- @return #STRATEGO self -- @return #STRATEGO self
function STRATEGO:SetNeutralBenefit(NeutralBenefit) function STRATEGO:SetNeutralBenefit(NeutralBenefit)
self:T(self.lid.."SetNeutralBenefit") self:T(self.lid.."SetNeutralBenefit")
@@ -420,9 +420,9 @@ end
--- [USER] Set how many units of which minimum threat level are needed to capture one node (i.e. the underlying OpsZone). --- [USER] Set how many units of which minimum threat level are needed to capture one node (i.e. the underlying OpsZone).
-- @param #STRATEGO self -- @param #STRATEGO self
-- @param #number CaptureUnits Number of units needed, defaults to three. -- @param #number CaptureUnits (Optional) Number of units needed, defaults to 3.
-- @param #number CaptureThreatlevel Threat level needed, can be 0..10, defaults to one. -- @param #number CaptureThreatlevel (Optional) Threat level needed, can be 0..10, defaults to 1.
-- @param #table CaptureCategories Table of object categories which can capture a node, defaults to `{Object.Category.UNIT}`. -- @param #table CaptureCategories (Optional) Table of object categories which can capture a node, defaults to `{Object.Category.UNIT}`.
-- @return #STRATEGO self -- @return #STRATEGO self
function STRATEGO:SetCaptureOptions(CaptureUnits,CaptureThreatlevel,CaptureCategories) function STRATEGO:SetCaptureOptions(CaptureUnits,CaptureThreatlevel,CaptureCategories)
self:T(self.lid.."SetCaptureOptions") self:T(self.lid.."SetCaptureOptions")
@@ -642,7 +642,7 @@ end
--- Set average, minimum and maximum time a unit is suppressed each time it gets hit. --- Set average, minimum and maximum time a unit is suppressed each time it gets hit.
-- @param #SUPPRESSION self -- @param #SUPPRESSION 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.
function SUPPRESSION:SetSuppressionTime(Tave, Tmin, Tmax) function SUPPRESSION:SetSuppressionTime(Tave, Tmin, Tmax)
@@ -697,7 +697,7 @@ end
--- Set the formation a group uses for fall back, hide or retreat. --- Set the formation a group uses for fall back, hide or retreat.
-- @param #SUPPRESSION self -- @param #SUPPRESSION self
-- @param #string formation Formation of the group. Default "Vee". -- @param #string formation (Optional) Formation of the group. Default "Vee".
function SUPPRESSION:SetFormation(formation) function SUPPRESSION:SetFormation(formation)
self:F(formation) self:F(formation)
self.Formation=formation or "Vee" self.Formation=formation or "Vee"
@@ -705,7 +705,7 @@ end
--- Set speed a group moves at for fall back, hide or retreat. --- Set speed a group moves at for fall back, hide or retreat.
-- @param #SUPPRESSION self -- @param #SUPPRESSION self
-- @param #number speed Speed in km/h of group. Default max speed the group can do. -- @param #number speed (Optional) Speed in km/h of group. Default max speed the group can do.
function SUPPRESSION:SetSpeed(speed) function SUPPRESSION:SetSpeed(speed)
self:F(speed) self:F(speed)
self.Speed=speed or self.SpeedMax self.Speed=speed or self.SpeedMax
@@ -793,7 +793,7 @@ end
-- If the group consists of only a singe unit, this referrs to the life of the unit. -- If the group consists of only a singe unit, this referrs to the life of the unit.
-- If the group consists of more than one unit, this referrs to the group strength relative to its initial strength. -- If the group consists of more than one unit, this referrs to the group strength relative to its initial strength.
-- @param #SUPPRESSION self -- @param #SUPPRESSION self
-- @param #number damage Damage in percent. If group gets damaged above this value, the group will retreat. Default 50 %. -- @param #number damage (Optional) Damage in percent. If group gets damaged above this value, the group will retreat. Default 50 %.
function SUPPRESSION:SetRetreatDamage(damage) function SUPPRESSION:SetRetreatDamage(damage)
self:F(damage) self:F(damage)
self.RetreatDamage=damage or 50 self.RetreatDamage=damage or 50
@@ -801,7 +801,7 @@ end
--- Set time a group waits in the retreat zone before it resumes its mission. Default is two hours. --- Set time a group waits in the retreat zone before it resumes its mission. Default is two hours.
-- @param #SUPPRESSION self -- @param #SUPPRESSION self
-- @param #number time Time in seconds. Default 7200 seconds = 2 hours. -- @param #number time (Optional) Time in seconds. Default 7200 seconds = 2 hours.
function SUPPRESSION:SetRetreatWait(time) function SUPPRESSION:SetRetreatWait(time)
self:F(time) self:F(time)
self.RetreatWait=time or 7200 self.RetreatWait=time or 7200
@@ -809,7 +809,7 @@ end
--- Set alarm state a group will get after it returns from a fall back or take cover. --- Set alarm state a group will get after it returns from a fall back or take cover.
-- @param #SUPPRESSION self -- @param #SUPPRESSION self
-- @param #string alarmstate Alarm state. Possible "Auto", "Green", "Red". Default is "Auto". -- @param #string alarmstate (Optional) Alarm state. Possible "Auto", "Green", "Red". Default is "Auto".
function SUPPRESSION:SetDefaultAlarmState(alarmstate) function SUPPRESSION:SetDefaultAlarmState(alarmstate)
self:F(alarmstate) self:F(alarmstate)
if alarmstate:lower()=="auto" then if alarmstate:lower()=="auto" then
@@ -825,7 +825,7 @@ end
--- Set Rules of Engagement (ROE) a group will get when it recovers from suppression. --- Set Rules of Engagement (ROE) a group will get when it recovers from suppression.
-- @param #SUPPRESSION self -- @param #SUPPRESSION self
-- @param #string roe ROE after suppression. Possible "Free", "Hold" or "Return". Default "Free". -- @param #string roe (Optional) ROE after suppression. Possible "Free", "Hold" or "Return". Default "Free".
function SUPPRESSION:SetDefaultROE(roe) function SUPPRESSION:SetDefaultROE(roe)
self:F(roe) self:F(roe)
if roe:lower()=="free" then if roe:lower()=="free" then
@@ -841,7 +841,7 @@ end
--- Create an F10 menu entry for the suppressed group. The menu is mainly for Debugging purposes. --- Create an F10 menu entry for the suppressed group. The menu is mainly for Debugging purposes.
-- @param #SUPPRESSION self -- @param #SUPPRESSION self
-- @param #boolean switch Enable=true or disable=false menu group. Default is true. -- @param #boolean switch (Optional) Enable=true or disable=false menu group. Default is true.
function SUPPRESSION:MenuOn(switch) function SUPPRESSION:MenuOn(switch)
self:F(switch) self:F(switch)
if switch==nil then if switch==nil then
@@ -1682,9 +1682,9 @@ end
--- Make group run/drive to a certain point. We put in several intermediate waypoints because sometimes the group stops before it arrived at the desired point. --- Make group run/drive to a certain point. We put in several intermediate waypoints because sometimes the group stops before it arrived at the desired point.
--@param #SUPPRESSION self --@param #SUPPRESSION self
--@param Core.Point#COORDINATE fin Coordinate where we want to go. --@param Core.Point#COORDINATE fin Coordinate where we want to go.
--@param #number speed Speed of group. Default is 20. --@param #number speed (Optional) Speed of group. Default is 20.
--@param #string formation Formation of group. Default is "Vee". --@param #string formation (Optional) Formation of group. Default is "Vee".
--@param #number wait Time the group will wait/hold at final waypoint. Default is 30 seconds. --@param #number wait (Optional) Time the group will wait/hold at final waypoint. Default is 30 seconds.
function SUPPRESSION:_Run(fin, speed, formation, wait) function SUPPRESSION:_Run(fin, speed, formation, wait)
speed=speed or 20 speed=speed or 20
@@ -1946,7 +1946,7 @@ end
--- Sets the ROE for the group and updates the current ROE variable. --- Sets the ROE for the group and updates the current ROE variable.
-- @param #SUPPRESSION self -- @param #SUPPRESSION self
-- @param #string roe ROE the group will get. Possible "Free", "Hold", "Return". Default is self.DefaultROE. -- @param #string roe (Optional) ROE the group will get. Possible "Free", "Hold", "Return". Default is self.DefaultROE.
function SUPPRESSION:_SetROE(roe) function SUPPRESSION:_SetROE(roe)
local group=self.Controllable --Wrapper.Controllable#CONTROLLABLE local group=self.Controllable --Wrapper.Controllable#CONTROLLABLE
@@ -1975,7 +1975,7 @@ end
--- Sets the alarm state of the group and updates the current alarm state variable. --- Sets the alarm state of the group and updates the current alarm state variable.
-- @param #SUPPRESSION self -- @param #SUPPRESSION self
-- @param #string state Alarm state the group will get. Possible "Auto", "Green", "Red". Default is self.DefaultAlarmState. -- @param #string state (Optional) Alarm state the group will get. Possible "Auto", "Green", "Red". Default is self.DefaultAlarmState.
function SUPPRESSION:_SetAlarmState(state) function SUPPRESSION:_SetAlarmState(state)
local group=self.Controllable --Wrapper.Controllable#CONTROLLABLE local group=self.Controllable --Wrapper.Controllable#CONTROLLABLE
@@ -181,8 +181,8 @@ end
--- [USER] Set activation radius for Helos and Planes in Nautical Miles. --- [USER] Set activation radius for Helos and Planes in Nautical Miles.
-- @param #TIRESIAS self -- @param #TIRESIAS self
-- @param #number HeloMiles Radius around a Helicopter in which AI ground units will be activated. Defaults to 10NM. -- @param #number HeloMiles (Optional) Radius around a Helicopter in which AI ground units will be activated. Defaults to 10NM.
-- @param #number PlaneMiles Radius around an Airplane in which AI ground units will be activated. Defaults to 25NM. -- @param #number PlaneMiles (Optional) Radius around an Airplane in which AI ground units will be activated. Defaults to 25NM.
-- @return #TIRESIAS self -- @return #TIRESIAS self
function TIRESIAS:SetActivationRanges(HeloMiles, PlaneMiles) function TIRESIAS:SetActivationRanges(HeloMiles, PlaneMiles)
self.HeloSwitchRange = HeloMiles or 10 self.HeloSwitchRange = HeloMiles or 10
@@ -194,8 +194,8 @@ end
---[USER] Set AAA Ranges - AAA equals non-SAM systems which qualify as AAA in DCS world. ---[USER] Set AAA Ranges - AAA equals non-SAM systems which qualify as AAA in DCS world.
-- @param #TIRESIAS self -- @param #TIRESIAS self
-- @param #number FiringRange The engagement range that AAA units will be set to. Can be 0 to 100 (percent). Defaults to 60. -- @param #number FiringRange (Optional) The engagement range that AAA units will be set to. Can be 0 to 100 (percent). Defaults to 60.
-- @param #boolean SwitchAAA Decide if these system will have their AI switched off, too. Defaults to true. -- @param #boolean SwitchAAA (Optional) Decide if these system will have their AI switched off, too. Defaults to true.
-- @return #TIRESIAS self -- @return #TIRESIAS self
function TIRESIAS:SetAAARanges(FiringRange, SwitchAAA) function TIRESIAS:SetAAARanges(FiringRange, SwitchAAA)
self.AAARange = FiringRange or 60 self.AAARange = FiringRange or 60
@@ -2467,14 +2467,14 @@ function WAREHOUSE:New(warehouse, alias)
--- Triggers the FSM event "Save" when the warehouse assets are saved to file on disk. --- Triggers the FSM event "Save" when the warehouse assets are saved to file on disk.
-- @function [parent=#WAREHOUSE] Save -- @function [parent=#WAREHOUSE] Save
-- @param #WAREHOUSE self -- @param #WAREHOUSE self
-- @param #string path Path where the file is saved. Default is the DCS installation root directory. -- @param #string path (Optional) Path where the file is saved. Default is the DCS installation root directory.
-- @param #string filename (Optional) File name. Default is WAREHOUSE-<UID>_<ALIAS>.txt. -- @param #string filename (Optional) File name. Default is WAREHOUSE-<UID>_<ALIAS>.txt.
--- Triggers the FSM event "Save" with a delay when the warehouse assets are saved to a file. --- Triggers the FSM event "Save" with a delay when the warehouse assets are saved to a file.
-- @function [parent=#WAREHOUSE] __Save -- @function [parent=#WAREHOUSE] __Save
-- @param #WAREHOUSE self -- @param #WAREHOUSE self
-- @param #number delay Delay in seconds. -- @param #number delay Delay in seconds.
-- @param #string path Path where the file is saved. Default is the DCS installation root directory. -- @param #string path (Optional) Path where the file is saved. Default is the DCS installation root directory.
-- @param #string filename (Optional) File name. Default is WAREHOUSE-<UID>_<ALIAS>.txt. -- @param #string filename (Optional) File name. Default is WAREHOUSE-<UID>_<ALIAS>.txt.
--- On after "Save" event user function. Called when the warehouse assets are saved to disk. --- On after "Save" event user function. Called when the warehouse assets are saved to disk.
@@ -2483,21 +2483,21 @@ function WAREHOUSE:New(warehouse, alias)
-- @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 saved. Default is the DCS installation root directory. -- @param #string path (Optional) Path where the file is saved. Default is the DCS installation root directory.
-- @param #string filename (Optional) File name. Default is WAREHOUSE-<UID>_<ALIAS>.txt. -- @param #string filename (Optional) File name. Default is WAREHOUSE-<UID>_<ALIAS>.txt.
--- Triggers the FSM event "Load" when the warehouse is loaded from a file on disk. --- Triggers the FSM event "Load" when the warehouse is loaded from a file on disk.
-- @function [parent=#WAREHOUSE] Load -- @function [parent=#WAREHOUSE] Load
-- @param #WAREHOUSE self -- @param #WAREHOUSE self
-- @param #string path Path where the file is located. Default is the DCS installation root directory. -- @param #string path (Optional) Path where the file is located. Default is the DCS installation root directory.
-- @param #string filename (Optional) File name. Default is WAREHOUSE-<UID>_<ALIAS>.txt. -- @param #string filename (Optional) File name. Default is WAREHOUSE-<UID>_<ALIAS>.txt.
--- Triggers the FSM event "Load" with a delay when the warehouse assets are loaded from disk. --- Triggers the FSM event "Load" with a delay when the warehouse assets are loaded from disk.
-- @function [parent=#WAREHOUSE] __Load -- @function [parent=#WAREHOUSE] __Load
-- @param #WAREHOUSE self -- @param #WAREHOUSE self
-- @param #number delay Delay in seconds. -- @param #number delay Delay in seconds.
-- @param #string path Path where the file is located. Default is the DCS installation root directory. -- @param #string path (Optional) Path where the file is located. Default is the DCS installation root directory.
-- @param #string filename (Optional) File name. Default is WAREHOUSE-<UID>_<ALIAS>.txt. -- @param #string filename (Optional) File name. Default is WAREHOUSE-<UID>_<ALIAS>.txt.
--- On after "Load" event user function. Called when the warehouse assets are loaded from disk. --- On after "Load" event user function. Called when the warehouse assets are loaded from disk.
@@ -2506,7 +2506,7 @@ function WAREHOUSE:New(warehouse, alias)
-- @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 located. Default is the DCS installation root directory. -- @param #string path (Optional) Path where the file is located. Default is the DCS installation root directory.
-- @param #string filename (Optional) File name. Default is WAREHOUSE-<UID>_<ALIAS>.txt. -- @param #string filename (Optional) File name. Default is WAREHOUSE-<UID>_<ALIAS>.txt.
@@ -2576,7 +2576,7 @@ end
--- Set low fuel threshold. If one unit of an asset has less fuel than this number, the event AssetLowFuel will be fired. --- Set low fuel threshold. If one unit of an asset has less fuel than this number, the event AssetLowFuel will be fired.
-- @param #WAREHOUSE self -- @param #WAREHOUSE self
-- @param #number threshold Relative low fuel threshold, i.e. a number in [0,1]. Default 0.15 (15%). -- @param #number threshold (Optional) Relative low fuel threshold, i.e. a number in [0,1]. Default 0.15 (15%).
-- @return #WAREHOUSE self -- @return #WAREHOUSE self
function WAREHOUSE:SetLowFuelThreshold(threshold) function WAREHOUSE:SetLowFuelThreshold(threshold)
self.lowfuelthresh=threshold or 0.15 self.lowfuelthresh=threshold or 0.15
@@ -2594,7 +2594,7 @@ end
--- Set verbosity level. --- Set verbosity level.
-- @param #WAREHOUSE self -- @param #WAREHOUSE self
-- @param #number VerbosityLevel Level of output (higher=more). Default 0. -- @param #number VerbosityLevel (Optional) Level of output (higher=more). Default 0.
-- @return #WAREHOUSE self -- @return #WAREHOUSE self
function WAREHOUSE:SetVerbosityLevel(VerbosityLevel) function WAREHOUSE:SetVerbosityLevel(VerbosityLevel)
self.verbosity=VerbosityLevel or 0 self.verbosity=VerbosityLevel or 0
@@ -2705,7 +2705,7 @@ end
--- Enable auto save of warehouse assets at mission end event. --- Enable auto save of warehouse assets at mission end event.
-- @param #WAREHOUSE self -- @param #WAREHOUSE self
-- @param #string path Path where to save the asset data file. -- @param #string path Path where to save the asset data file.
-- @param #string filename File name. Default is generated automatically from warehouse id. -- @param #string filename (Optional) File name. Default is generated automatically from warehouse id.
-- @return #WAREHOUSE self -- @return #WAREHOUSE self
function WAREHOUSE:SetSaveOnMissionEnd(path, filename) function WAREHOUSE:SetSaveOnMissionEnd(path, filename)
self.autosave=true self.autosave=true
@@ -3349,7 +3349,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 #WAREHOUSE self -- @param #WAREHOUSE self
-- @param #number RepairTime Time in seconds until the runway is repaired. Default 3600 sec (one hour). -- @param #number RepairTime (Optional) Time in seconds until the runway is repaired. Default 3600 sec (one hour).
-- @return #WAREHOUSE self -- @return #WAREHOUSE self
function WAREHOUSE:SetRunwayRepairtime(RepairTime) function WAREHOUSE:SetRunwayRepairtime(RepairTime)
self.runwayrepairtime=RepairTime or 3600 self.runwayrepairtime=RepairTime or 3600
@@ -3891,7 +3891,7 @@ end
-- @param #string Event Event. -- @param #string Event Event.
-- @param #string To To state. -- @param #string To To state.
-- @param Wrapper.Group#GROUP group Group or template group to be added to the warehouse stock. -- @param Wrapper.Group#GROUP group Group or template group to be added to the warehouse stock.
-- @param #number ngroups Number of groups to add to the warehouse stock. Default is 1. -- @param #number ngroups (Optional) Number of groups to add to the warehouse stock. Default is 1.
-- @param #WAREHOUSE.Attribute forceattribute (Optional) Explicitly force a generalized attribute for the asset. This has to be an @{#WAREHOUSE.Attribute}. -- @param #WAREHOUSE.Attribute forceattribute (Optional) Explicitly force a generalized attribute for the asset. This has to be an @{#WAREHOUSE.Attribute}.
-- @param #number forcecargobay (Optional) Explicitly force cargobay weight limit in kg for cargo carriers. This is for each *unit* of the group. -- @param #number forcecargobay (Optional) Explicitly force cargobay weight limit in kg for cargo carriers. This is for each *unit* of the group.
-- @param #number forceweight (Optional) Explicitly force weight in kg of each unit in the group. -- @param #number forceweight (Optional) Explicitly force weight in kg of each unit in the group.
@@ -6226,7 +6226,7 @@ end
-- @param #WAREHOUSE self -- @param #WAREHOUSE self
-- @param Wrapper.Group#GROUP Group The train group. -- @param Wrapper.Group#GROUP Group The train group.
-- @param Core.Point#COORDINATE Coordinate of the destination. Tail will be routed to the closest point -- @param Core.Point#COORDINATE Coordinate of the destination. Tail will be routed to the closest point
-- @param #number Speed Speed in km/h to drive to the destination coordinate. Default is 60% of max possible speed the unit can go. -- @param #number Speed (Optional) Speed in km/h to drive to the destination coordinate. Default is 60% of max possible speed the unit can go.
function WAREHOUSE:_RouteTrain(Group, Coordinate, Speed) function WAREHOUSE:_RouteTrain(Group, Coordinate, Speed)
if Group and Group:IsAlive() then if Group and Group:IsAlive() then
@@ -8783,7 +8783,7 @@ end
--- Info Message. Message send to coalition if reports or debug mode activated (and duration > 0). Text self:I(text) added to DCS.log file. --- Info Message. Message send to coalition if reports or debug mode activated (and duration > 0). Text self:I(text) added to DCS.log file.
-- @param #WAREHOUSE self -- @param #WAREHOUSE self
-- @param #string text The text of the error message. -- @param #string text The text of the error message.
-- @param #number duration Message display duration in seconds. Default 20 sec. If duration is zero, no message is displayed. -- @param #number duration (Optional) Message display duration in seconds. Default 20 sec. If duration is zero, no message is displayed.
function WAREHOUSE:_InfoMessage(text, duration) function WAREHOUSE:_InfoMessage(text, duration)
duration=duration or 20 duration=duration or 20
if duration>0 and self.Debug or self.Report then if duration>0 and self.Debug or self.Report then
@@ -8796,7 +8796,7 @@ end
--- Debug message. Message send to all if debug mode is activated (and duration > 0). Text self:T(text) added to DCS.log file. --- Debug message. Message send to all if debug mode is activated (and duration > 0). Text self:T(text) added to DCS.log file.
-- @param #WAREHOUSE self -- @param #WAREHOUSE self
-- @param #string text The text of the error message. -- @param #string text The text of the error message.
-- @param #number duration Message display duration in seconds. Default 20 sec. If duration is zero, no message is displayed. -- @param #number duration (Optional) Message display duration in seconds. Default 20 sec. If duration is zero, no message is displayed.
function WAREHOUSE:_DebugMessage(text, duration) function WAREHOUSE:_DebugMessage(text, duration)
duration=duration or 20 duration=duration or 20
if self.Debug and duration>0 then if self.Debug and duration>0 then
@@ -8808,7 +8808,7 @@ end
--- Error message. Message send to all (if duration > 0). Text self:E(text) added to DCS.log file. --- Error message. Message send to all (if duration > 0). Text self:E(text) added to DCS.log file.
-- @param #WAREHOUSE self -- @param #WAREHOUSE self
-- @param #string text The text of the error message. -- @param #string text The text of the error message.
-- @param #number duration Message display duration in seconds. Default 20 sec. If duration is zero, no message is displayed. -- @param #number duration (Optional) Message display duration in seconds. Default 20 sec. If duration is zero, no message is displayed.
function WAREHOUSE:_ErrorMessage(text, duration) function WAREHOUSE:_ErrorMessage(text, duration)
duration=duration or 20 duration=duration or 20
if duration>0 then if duration>0 then
@@ -365,8 +365,8 @@ do -- ZONE_CAPTURE_COALITION
-- @param #ZONE_CAPTURE_COALITION self -- @param #ZONE_CAPTURE_COALITION self
-- @param Core.Zone#ZONE Zone A @{Core.Zone} object with the goal to be achieved. Alternatively, can be handed as the name of late activated group describing a @{Core.Zone#ZONE_POLYGON} with its waypoints. -- @param Core.Zone#ZONE Zone A @{Core.Zone} object with the goal to be achieved. Alternatively, can be handed as the name of late activated group describing a @{Core.Zone#ZONE_POLYGON} with its waypoints.
-- @param #number Coalition The initial coalition owning the zone. -- @param #number Coalition The initial coalition owning the zone.
-- @param #table UnitCategories Table of unit categories. See [DCS Class Unit](https://wiki.hoggitworld.com/view/DCS_Class_Unit). Default {Unit.Category.GROUND_UNIT}. -- @param #table UnitCategories (Optional) Table of unit categories. See [DCS Class Unit](https://wiki.hoggitworld.com/view/DCS_Class_Unit). Default {Unit.Category.GROUND_UNIT}.
-- @param #table ObjectCategories Table of unit categories. See [DCS Class Object](https://wiki.hoggitworld.com/view/DCS_Class_Object). Default {Object.Category.UNIT, Object.Category.STATIC}, i.e. all UNITS and STATICS. -- @param #table ObjectCategories (Optional) Table of unit categories. See [DCS Class Object](https://wiki.hoggitworld.com/view/DCS_Class_Object). Default {Object.Category.UNIT, Object.Category.STATIC}, i.e. all UNITS and STATICS.
-- @return #ZONE_CAPTURE_COALITION -- @return #ZONE_CAPTURE_COALITION
-- @usage -- @usage
-- --
@@ -54,8 +54,8 @@ do -- ZoneGoal
--- ZONE_GOAL_COALITION Constructor. --- ZONE_GOAL_COALITION Constructor.
-- @param #ZONE_GOAL_COALITION self -- @param #ZONE_GOAL_COALITION self
-- @param Core.Zone#ZONE Zone A @{Core.Zone} object with the goal to be achieved. -- @param Core.Zone#ZONE Zone A @{Core.Zone} object with the goal to be achieved.
-- @param #number Coalition The initial coalition owning the zone. Default coalition.side.NEUTRAL. -- @param #number Coalition (Optional) The initial coalition owning the zone. Default coalition.side.NEUTRAL.
-- @param #table UnitCategories Table of unit categories. See [DCS Class Unit](https://wiki.hoggitworld.com/view/DCS_Class_Unit). Default {Unit.Category.GROUND_UNIT}. -- @param #table UnitCategories (Optional) Table of unit categories. See [DCS Class Unit](https://wiki.hoggitworld.com/view/DCS_Class_Unit). Default {Unit.Category.GROUND_UNIT}.
-- @return #ZONE_GOAL_COALITION -- @return #ZONE_GOAL_COALITION
function ZONE_GOAL_COALITION:New( Zone, Coalition, UnitCategories ) function ZONE_GOAL_COALITION:New( Zone, Coalition, UnitCategories )
@@ -90,7 +90,7 @@ do -- ZoneGoal
--- Set the owning coalition of the zone. --- Set the owning coalition of the zone.
-- @param #ZONE_GOAL_COALITION self -- @param #ZONE_GOAL_COALITION self
-- @param #table UnitCategories Table of unit categories. See [DCS Class Unit](https://wiki.hoggitworld.com/view/DCS_Class_Unit). Default {Unit.Category.GROUND_UNIT}. -- @param #table UnitCategories (Optional) Table of unit categories. See [DCS Class Unit](https://wiki.hoggitworld.com/view/DCS_Class_Unit). Default {Unit.Category.GROUND_UNIT}.
-- @return #ZONE_GOAL_COALITION -- @return #ZONE_GOAL_COALITION
function ZONE_GOAL_COALITION:SetUnitCategories( UnitCategories ) function ZONE_GOAL_COALITION:SetUnitCategories( UnitCategories )
@@ -105,7 +105,7 @@ do -- ZoneGoal
--- Set the owning coalition of the zone. --- Set the owning coalition of the zone.
-- @param #ZONE_GOAL_COALITION self -- @param #ZONE_GOAL_COALITION self
-- @param #table ObjectCategories Table of unit categories. See [DCS Class Object](https://wiki.hoggitworld.com/view/DCS_Class_Object). Default {Object.Category.UNIT, Object.Category.STATIC}, i.e. all UNITS and STATICS. -- @param #table ObjectCategories (Optional) Table of unit categories. See [DCS Class Object](https://wiki.hoggitworld.com/view/DCS_Class_Object). Default {Object.Category.UNIT, Object.Category.STATIC}, i.e. all UNITS and STATICS.
-- @return #ZONE_GOAL_COALITION -- @return #ZONE_GOAL_COALITION
function ZONE_GOAL_COALITION:SetObjectCategories( ObjectCategories ) function ZONE_GOAL_COALITION:SetObjectCategories( ObjectCategories )