Module Functional.DetectionZones
Functional - Captures the class DETECTION_ZONES.
Global(s)
Global DETECTION_ZONES |
(old, to be revised ) Detect units within the battle zone for a list of Core.Zones detecting targets following (a) detection method(s), and will build a list (table) of Core.Set#SET_UNITs containing the Wrapper.Unit#UNITs detected. |
(old, to be revised ) Detect units within the battle zone for a list of Core.Zones detecting targets following (a) detection method(s), and will build a list (table) of Core.Set#SET_UNITs containing the Wrapper.Unit#UNITs detected.
The class is group the detected units within zones given a DetectedZoneRange parameter. A set with multiple detected zones will be created as there are groups of units detected.
4.1) Retrieve the Detected Unit Sets and Detected Zones
The methods to manage the DetectedItems[].Set(s) are implemented in Functional.Detection#DECTECTION_BASE and the methods to manage the DetectedItems[].Zone(s) is implemented in Functional.Detection#DETECTION_ZONES.
Retrieve the DetectedItems[].Set with the method Functional.Detection#DETECTION_BASE.GetDetectedSet(). A Core.Set#SET_UNIT object will be returned.
Retrieve the formed Core.Zone#ZONE_UNITs as a result of the grouping the detected units within the DetectionZoneRange, use the method Functional.Detection#DETECTION_BASE.GetDetectionZones(). To understand the amount of zones created, use the method Functional.Detection#DETECTION_BASE.GetDetectionZoneCount(). If you want to obtain a specific zone from the DetectedZones, use the method Functional.Detection#DETECTION_BASE.GetDetectionZone() with a given index.
4.4) Flare or Smoke detected units
Use the methods Functional.Detection#DETECTION_ZONES.FlareDetectedUnits() or Functional.Detection#DETECTION_ZONES.SmokeDetectedUnits() to flare or smoke the detected units when a new detection has taken place.
4.5) Flare or Smoke or Bound detected zones
Use the methods:
- Functional.Detection#DETECTION_ZONES.FlareDetectedZones() to flare in a color
- Functional.Detection#DETECTION_ZONES.SmokeDetectedZones() to smoke in a color
- Functional.Detection#DETECTION_ZONES.SmokeDetectedZones() to bound with a tire with a white flag
the detected zones when a new detection has taken place.
Type(s)
| Fields and Methods inherited from DETECTION_BASE.DetectedItem | Description |
|---|---|
| Fields and Methods inherited from DETECTION_ZONES | Description |
|---|---|
|
Bound the detected zones |
|
|
Calculate the optimal intercept point of the DetectedItem. |
|
|
Make a DetectionSet table. |
|
DETECTION_ZONES:DetectedItemReportSummary(DetectedItem, AttackGroup, Settings) |
Report summary of a detected item using a given numeric index. |
|
A list of areas containing the set of Wrapper.Units, Core.Zones, the center Wrapper.Unit within the zone, and ID of each area that was detected within a DetectionZoneRange. |
|
|
Report detailed of a detection result. |
|
|
The range till which targets are grouped upon the first detected target. |
|
|
Flare the detected units |
|
|
Flare the detected zones |
|
|
Make text documenting the changes of the detected zone. |
|
|
DETECTION_ZONES constructor. |
|
|
Smoke the detected units |
|
|
Smoke the detected zones |
|
|
Set IsDetected flag for the DetectedItem, which can have more units. |
|
DETECTION_ZONES:onafterDetection(From, Event, To, Detection, DetectionTimeStamp) |
| Fields and Methods inherited from DETECTION_BASE | Description |
|---|---|
|
Accepts changes from the detected item. |
|
DETECTION_ZONES:AddChangeItem(DetectedItem, ChangeCode, ItemUnitType) |
Add a change to the detected zone. |
DETECTION_ZONES:AddChangeUnit(DetectedItem, ChangeCode, ChangeUnitType) |
Add a change to the detected zone. |
DETECTION_ZONES:AddDetectedItem(ItemPrefix, DetectedItemKey, Set) |
Adds a new DetectedItem to the DetectedItems list. |
DETECTION_ZONES:AddDetectedItemZone(DetectedItemKey, Set, Zone, ItemPrefix) |
Adds a new DetectedItem to the DetectedItems list. |
DETECTION_ZONES:CleanDetectionItem(DetectedItem, DetectedItemID) |
Clean the DetectedItem table. |
|
Make a DetectionSet table. |
|
|
Synchronous Event Trigger for Event Detect. |
|
|
Synchronous Event Trigger for Event Detected. |
|
DETECTION_ZONES:DetectedItemReportSummary(DetectedItem, AttackGroup, Settings) |
Report summary of a detected item using a given numeric index. |
|
Report detailed of a detection result. |
|
|
Filter the detected units based on Unit.Category
Multiple Unit.Category entries can be given as a table and then these will be evaluated as an OR expression. |
|
|
Forget a Unit from a DetectionItem |
|
|
Get a detected ID using a given numeric index. |
|
|
Get a detected item using a given numeric index. |
|
|
Get a detected item using a given Key. |
|
|
Get the detected item coordinate. |
|
|
Get a list of the detected item coordinates. |
|
|
Get a detected ItemID using a given numeric index. |
|
|
Get the Core.Set#SET_UNIT of a detection area using a given numeric index. |
|
|
Get the detected item coordinate. |
|
|
Get the Core.Zone#ZONE_UNIT of a detection area using a given numeric index. |
|
|
Get the DetectedItems by Key. |
|
|
Get the DetectedItems by Index. |
|
|
Get the amount of SETs with detected objects. |
|
|
Gets a detected object with a given name. |
|
|
Gets a detected unit type name, taking into account the detection results. |
|
|
Get the Detection Set. |
|
|
Returns the distance used to identify friendlies near the detected item ... |
|
|
Returns friendly units nearby the FAC units ... |
|
|
Returns friendly units nearby the intercept point ... |
|
|
Returns friendly units nearby the FAC units ... |
|
|
Identifies a detected object during detection processing. |
|
|
Detect DLINK. |
|
|
Detect IRST. |
|
|
Detect Optical. |
|
|
Detect RWR. |
|
|
Detect Radar. |
|
|
Detect Visual. |
|
|
Checks if there is at least one UNIT detected in the Set of the the DetectedItem. |
|
|
Validate if the detected item is locked. |
|
|
Determines if a detected object has already been identified during detection processing. |
|
|
Returns if there are friendlies nearby the FAC units ... |
|
|
Returns if there are friendlies nearby the intercept ... |
|
|
Returns if there are friendlies nearby the FAC units ... |
|
|
Lock a detected item. |
|
|
Lock the detected items when created and lock all existing detected items. |
|
|
Find the nearest Recce of the DetectedItem. |
|
|
DETECTION constructor. |
|
|
OnAfter Transition Handler for Event Detect. |
|
|
OnAfter Transition Handler for Event Detected. |
|
DETECTION_ZONES:OnAfterDetectedItem(From, Event, To, DetectedItem) |
OnAfter Transition Handler for Event DetectedItem. |
|
OnAfter Transition Handler for Event Start. |
|
|
OnAfter Transition Handler for Event Stop. |
|
|
OnBefore Transition Handler for Event Detect. |
|
|
OnBefore Transition Handler for Event Detected. |
|
|
OnBefore Transition Handler for Event Start. |
|
|
OnBefore Transition Handler for Event Stop. |
|
|
OnEnter Transition Handler for State Detecting. |
|
|
OnEnter Transition Handler for State Stopped. |
|
|
OnLeave Transition Handler for State Detecting. |
|
|
OnLeave Transition Handler for State Stopped. |
|
|
Removes an existing DetectedItem from the DetectedItems list. |
|
|
Background worker function to determine if there are friendlies nearby ... |
|
|
Schedule the DETECTION construction. |
|
|
Accept detections if within a range in meters. |
|
|
Accept detections if within the specified zone(s). |
|
DETECTION_ZONES:SetAlphaAngleProbability(AlphaAngleProbability) |
Upon a visual detection, the higher the unit is during the detecting process, the more likely the detected unit is to be detected properly. |
DETECTION_ZONES:SetDetectedItemCoordinate(DetectedItem, Coordinate, DetectedItemUnit) |
Set the detected item coordinate. |
DETECTION_ZONES:SetDetectedItemThreatLevel(The, DetectedItem) |
Set the detected item threat level. |
|
Upon a visual detection, the further away a detected object is, the less likely it is to be detected properly. |
|
|
Set the radius in meters to validate if friendlies are nearby. |
|
|
This will allow during friendly search any recce or detection unit to be also considered as a friendly. |
|
|
Set the parameters to calculate to optimal intercept point. |
|
DETECTION_ZONES:SetRadarBlur(minheight, thresheight, thresblur) |
Method to make the radar detection less accurate, e.g. |
|
Set the detection interval time in seconds. |
|
|
Reject detections if within the specified zone(s). |
|
|
Upon a visual detection, the more a detected unit is within a cloudy zone, the less likely the detected unit is to be detected successfully. |
|
|
Synchronous Event Trigger for Event Start. |
|
|
Synchronous Event Trigger for Event Stop. |
|
|
UnIdentify all detected objects during detection processing. |
|
|
UnIdentify a detected object during detection processing. |
|
|
Unlock a detected item. |
|
|
Unlock the detected items when created and unlock all existing detected items. |
|
|
Set IsDetected flag for the DetectedItem, which can have more units. |
|
|
Asynchronous Event Trigger for Event Detect. |
|
|
Asynchronous Event Trigger for Event Detected. |
|
|
Asynchronous Event Trigger for Event Start. |
|
|
Asynchronous Event Trigger for Event Stop. |
|
DETECTION_ZONES:onafterDetection(From, Event, To, Detection, DetectionTimeStamp) |
|
Field(s)
local DetectedSpeed = DetectedCoord:GetVelocity()
local DetectedHeading = DetectedCoord:GetHeading()
if self.Intercept then
local DetectedSet = DetectedItem.Set
-- todo: speed
local TranslateDistance = DetectedSpeed * self.InterceptDelay
local InterceptCoord = DetectedCoord:Translate( TranslateDistance, DetectedHeading )
DetectedItem.InterceptCoord = InterceptCoord
else
DetectedItem.InterceptCoord = DetectedCoord
end
Function(s)
Field(s)
A list of areas containing the set of Wrapper.Units, Core.Zones, the center Wrapper.Unit within the zone, and ID of each area that was detected within a DetectionZoneRange.
The range till which targets are grouped upon the first detected target.
Function(s)
Bound the detected zones
Calculate the optimal intercept point of the DetectedItem.
Defined in:
DETECTION_ZONES
Parameter:
#number The
amount of alive recce.
Make a DetectionSet table.
This function will be overridden in the derived clsses.
Report summary of a detected item using a given numeric index.
Defined in:
DETECTION_ZONES
Parameters:
#DETECTION_BASE.DetectedItem DetectedItem
The DetectedItem.
Wrapper.Group#GROUP AttackGroup
The group to get the settings for.
Core.Settings#SETTINGS Settings
(Optional) Message formatting settings to use.
Return value:
The report of the detection items.
Report detailed of a detection result.
Defined in:
DETECTION_ZONES
Parameter:
Wrapper.Group#GROUP AttackGroup
The group to generate the report for.
Return value:
#string:
Flare the detected units
Flare the detected zones
Defined in:
DETECTION_ZONES
Parameters:
IteratorFunction
...
Make text documenting the changes of the detected zone.
Defined in:
DETECTION_ZONES
Parameter:
#DETECTION_BASE.DetectedItem DetectedItem
Return value:
#string:
The Changes text
DETECTION_ZONES constructor.
Defined in:
DETECTION_ZONES
Parameters:
Core.Set#SET_ZONE DetectionSetZone
The Core.Set of ZONE_RADIUS.
DCS#Coalition.side DetectionCoalition
The coalition of the detection.
Return value:
Smoke the detected units
Smoke the detected zones
Set IsDetected flag for the DetectedItem, which can have more units.
Defined in:
DETECTION_ZONES
Parameter:
DetectedItem
Return values:
DetectedItem
#boolean:
true if at least one UNIT is detected from the DetectedSet, false if no UNIT was detected from the DetectedSet.
Defined in:
DETECTION_ZONES
Parameters:
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Detection
The element on which the detection is based.
#number DetectionTimeStamp
Time stamp of detection event.
Field(s)
A list of areas containing the set of Wrapper.Units, Core.Zones, the center Wrapper.Unit within the zone, and ID of each area that was detected within a DetectionZoneRange.
The range till which targets are grouped upon the first detected target.
Function(s)
Accepts changes from the detected item.
Add a change to the detected zone.
Defined in:
Parameters:
#DETECTION_BASE.DetectedItem DetectedItem
#string ChangeCode
ItemUnitType
Return value:
self
Add a change to the detected zone.
Defined in:
Parameters:
#DETECTION_BASE.DetectedItem DetectedItem
#string ChangeCode
#string ChangeUnitType
Return value:
self
Adds a new DetectedItem to the DetectedItems list.
The DetectedItem is a table and contains a SET_UNIT in the field Set.
Defined in:
Parameters:
#string ItemPrefix
Prefix of detected item.
#number DetectedItemKey
The key of the DetectedItem. Default self.DetectedItemMax. Could also be a string in principle.
(optional) The Set of Units to be added.
Return value:
Adds a new DetectedItem to the DetectedItems list.
The DetectedItem is a table and contains a SET_UNIT in the field Set.
Defined in:
Parameters:
DetectedItemKey
The key of the DetectedItem.
(optional) The Set of Units to be added.
Core.Zone#ZONE_UNIT Zone
(optional) The Zone to be added where the Units are located.
ItemPrefix
Return value:
Clean the DetectedItem table.
Defined in:
Parameters:
DetectedItem
DetectedItemID
Return value:
@param #DETECTION_BASE self @param #number The amount of alive recce.
Defined in:
Make a DetectionSet table.
This function will be overridden in the derived clsses.
Synchronous Event Trigger for Event Detect.
Defined in:
Synchronous Event Trigger for Event Detected.
Report summary of a detected item using a given numeric index.
Defined in:
Parameters:
#DETECTION_BASE.DetectedItem DetectedItem
The DetectedItem.
Wrapper.Group#GROUP AttackGroup
The group to generate the report for.
Core.Settings#SETTINGS Settings
Message formatting settings to use.
Return value:
Report detailed of a detection result.
Defined in:
Parameter:
Wrapper.Group#GROUP AttackGroup
The group to generate the report for.
Return value:
#string:
Filter the detected units based on Unit.Category
The different values of Unit.Category can be:
- Unit.Category.AIRPLANE
- Unit.Category.GROUND_UNIT
- Unit.Category.HELICOPTER
- Unit.Category.SHIP
- Unit.Category.STRUCTURE
Multiple Unit.Category entries can be given as a table and then these will be evaluated as an OR expression.
Example to filter a single category (Unit.Category.AIRPLANE).
DetectionObject:FilterCategories( Unit.Category.AIRPLANE )
Example to filter multiple categories (Unit.Category.AIRPLANE, Unit.Category.HELICOPTER). Note the {}.
DetectionObject:FilterCategories( { Unit.Category.AIRPLANE, Unit.Category.HELICOPTER } )
Defined in:
Parameter:
#list<DCS#Unit> FilterCategories
The Categories entries
Return value:
self
@param #DETECTION_BASE self
Forget a Unit from a DetectionItem
Defined in:
Parameter:
#string UnitName
The UnitName that needs to be forgotten from the DetectionItem Sets.
Return value:
Get a detected ID using a given numeric index.
Defined in:
Parameter:
#number Index
Return value:
#string:
DetectedItemID
Get a detected item using a given numeric index.
Defined in:
Parameter:
#number Index
Return value:
Get a detected item using a given Key.
Defined in:
Parameter:
Key
Return value:
Get the detected item coordinate.
Defined in:
Parameter:
#DETECTION_BASE.DetectedItem DetectedItem
The DetectedItem to set the coordinate at.
Return value:
Get a list of the detected item coordinates.
Defined in:
Return value:
#table:
A table of Core.Point#COORDINATE
Get a detected ItemID using a given numeric index.
Defined in:
Parameter:
#DETECTION_BASE.DetectedItem DetectedItem
The DetectedItem.
Return value:
#string:
DetectedItemID
Get the Core.Set#SET_UNIT of a detection area using a given numeric index.
Get the detected item coordinate.
Defined in:
Parameter:
#DETECTION_BASE.DetectedItem DetectedItem
The DetectedItem.
Return value:
#number:
ThreatLevel
Get the Core.Zone#ZONE_UNIT of a detection area using a given numeric index.
Defined in:
Parameter:
#DETECTION_BASE.DetectedItem DetectedItem
The DetectedItem.
Return value:
DetectedZone
Get the DetectedItems by Key.
This will return the DetectedItems collection, indexed by the Key, which can be any object that acts as the key of the detection.
Get the DetectedItems by Index.
This will return the DetectedItems collection, indexed by an internal numerical Index.
Get the amount of SETs with detected objects.
Defined in:
Return value:
#number:
The amount of detected items. Note that the amount of detected items can differ with the reality, because detections are not real-time but done in intervals!
Gets a detected object with a given name.
Defined in:
Parameter:
#string ObjectName
Return value:
Gets a detected unit type name, taking into account the detection results.
Get the Detection Set.
Returns the distance used to identify friendlies near the detected item ...
Defined in:
Parameter:
#DETECTION_BASE.DetectedItem DetectedItem
The detected item.
Return value:
#table:
A table of distances to friendlies.
Returns friendly units nearby the FAC units ...
Defined in:
Parameters:
#DETECTION_BASE.DetectedItem DetectedItem
DCS#Unit.Category Category
The category of the unit.
Return value:
#map<#string,Wrapper.Unit#UNIT>:
The map of Friendly UNITs.
Returns friendly units nearby the intercept point ...
Defined in:
Parameter:
#DETECTION_BASE.DetectedItem DetectedItem
The detected item.
Return value:
#map<#string,Wrapper.Unit#UNIT>:
The map of Friendly UNITs.
Returns friendly units nearby the FAC units ...
Defined in:
Parameter:
#DETECTION_BASE.DetectedItem DetectedItem
The detected item.
Return value:
#map<#string,Wrapper.Unit#UNIT>:
The map of Friendly UNITs.
Identifies a detected object during detection processing.
Detect DLINK.
Defined in:
Parameter:
#boolean DetectDLINK
Return value:
self
Detect IRST.
Defined in:
Parameter:
#boolean DetectIRST
Return value:
self
Detect Optical.
Defined in:
Parameter:
#boolean DetectOptical
Return value:
self
Detect RWR.
Defined in:
Parameter:
#boolean DetectRWR
Return value:
self
Detect Radar.
Defined in:
Parameter:
#boolean DetectRadar
Return value:
self
Detect Visual.
Defined in:
Parameter:
#boolean DetectVisual
Return value:
self
Checks if there is at least one UNIT detected in the Set of the the DetectedItem.
Defined in:
Parameter:
#DETECTION_BASE.DetectedItem DetectedItem
Return value:
#boolean:
true if at least one UNIT is detected from the DetectedSet, false if no UNIT was detected from the DetectedSet.
Validate if the detected item is locked.
Defined in:
Parameter:
#DETECTION_BASE.DetectedItem DetectedItem
The DetectedItem.
Return value:
#boolean:
Determines if a detected object has already been identified during detection processing.
Defined in:
Parameter:
#DETECTION_BASE.DetectedObject DetectedObject
Return value:
#boolean:
true if already identified.
Returns if there are friendlies nearby the FAC units ...
Defined in:
Parameters:
#DETECTION_BASE.DetectedItem DetectedItem
DCS#Unit.Category Category
The category of the unit.
Return value:
#boolean:
true if there are friendlies nearby
Returns if there are friendlies nearby the intercept ...
Defined in:
Parameter:
#DETECTION_BASE.DetectedItem DetectedItem
Return value:
#boolean:
trhe if there are friendlies near the intercept.
Returns if there are friendlies nearby the FAC units ...
Defined in:
Parameter:
#DETECTION_BASE.DetectedItem DetectedItem
Return value:
#boolean:
true if there are friendlies nearby
Lock a detected item.
Lock the detected items when created and lock all existing detected items.
Find the nearest Recce of the DetectedItem.
DETECTION constructor.
Defined in:
Parameter:
Core.Set#SET_GROUP DetectionSet
The Core.Set of Wrapper.Groups that is used to detect the units.
Return value:
self
OnAfter Transition Handler for Event Detect.
Defined in:
Parameters:
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
OnAfter Transition Handler for Event Detected.
Defined in:
Parameters:
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
#table Units
Table of detected units.
OnAfter Transition Handler for Event DetectedItem.
Defined in:
Parameters:
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
#DetectedItem DetectedItem
The DetectedItem data structure.
OnAfter Transition Handler for Event Start.
Defined in:
Parameters:
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
OnAfter Transition Handler for Event Stop.
Defined in:
Parameters:
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
OnBefore Transition Handler for Event Detect.
Defined in:
Parameters:
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Return value:
#boolean:
Return false to cancel Transition.
OnBefore Transition Handler for Event Detected.
Defined in:
Parameters:
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Return value:
#boolean:
Return false to cancel Transition.
OnBefore Transition Handler for Event Start.
Defined in:
Parameters:
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Return value:
#boolean:
Return false to cancel Transition.
OnBefore Transition Handler for Event Stop.
Defined in:
Parameters:
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Return value:
#boolean:
Return false to cancel Transition.
OnEnter Transition Handler for State Detecting.
Defined in:
Parameters:
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
OnEnter Transition Handler for State Stopped.
Defined in:
Parameters:
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
OnLeave Transition Handler for State Detecting.
Defined in:
Parameters:
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Return value:
#boolean:
Return false to cancel Transition.
OnLeave Transition Handler for State Stopped.
Defined in:
Parameters:
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Return value:
#boolean:
Return false to cancel Transition.
Removes an existing DetectedItem from the DetectedItems list.
The DetectedItem is a table and contains a SET_UNIT in the field Set.
Defined in:
Parameter:
DetectedItemKey
The key in the DetectedItems list where the item needs to be removed.
Background worker function to determine if there are friendlies nearby ...
Schedule the DETECTION construction.
Defined in:
Parameters:
#number DelayTime
The delay in seconds to wait the reporting.
#number RepeatInterval
The repeat interval in seconds for the reporting to happen repeatedly.
Return value:
self
Accept detections if within a range in meters.
Defined in:
Parameter:
#number AcceptRange
Accept a detection if the unit is within the AcceptRange in meters.
Return value:
self
Accept detections if within the specified zone(s).
Defined in:
Parameter:
Core.Zone#ZONE_BASE AcceptZones
Can be a list or ZONE_BASE objects, or a single ZONE_BASE object.
Return value:
self
Upon a visual detection, the higher the unit is during the detecting process, the more likely the detected unit is to be detected properly.
A detection at a 90% alpha angle is the most optimal, a detection at 10% is less and a detection at 0% is less likely to be correct.
A probability factor between 0 and 1 can be given, that will model a progressive extrapolated probability if the target would be detected at a 0° angle.
For example, if a alpha angle probability factor of 0.7 is given, the extrapolated probabilities of the different angles would look like: 0°: 70%, 10°: 75,21%, 20°: 80,26%, 30°: 85%, 40°: 89,28%, 50°: 92,98%, 60°: 95,98%, 70°: 98,19%, 80°: 99,54%, 90°: 100%
Defined in:
Parameter:
AlphaAngleProbability
The probability factor.
Return value:
self
Set the detected item coordinate.
Defined in:
Parameters:
#DETECTION_BASE.DetectedItem DetectedItem
The DetectedItem to set the coordinate at.
Core.Point#COORDINATE Coordinate
The coordinate to set the last know detected position at.
Wrapper.Unit#UNIT DetectedItemUnit
The unit to set the heading and altitude from.
Return value:
Set the detected item threat level.
Defined in:
Parameters:
DetectedItem to calculate the threat level for.
DetectedItem
Return value:
Upon a visual detection, the further away a detected object is, the less likely it is to be detected properly.
Also, the speed of accurate detection plays a role. A distance probability factor between 0 and 1 can be given, that will model a linear extrapolated probability over 10 km distance. For example, if a probability factor of 0.6 (60%) is given, the extrapolated probabilities over 15 kilometers would like like: 1 km: 96%, 2 km: 92%, 3 km: 88%, 4 km: 84%, 5 km: 80%, 6 km: 76%, 7 km: 72%, 8 km: 68%, 9 km: 64%, 10 km: 60%, 11 km: 56%, 12 km: 52%, 13 km: 48%, 14 km: 44%, 15 km: 40%.
Defined in:
Parameter:
DistanceProbability
The probability factor.
Return value:
self
Set the radius in meters to validate if friendlies are nearby.
Defined in:
Parameter:
#number FriendliesRange
Radius to use when checking if Friendlies are nearby.
Return value:
self
This will allow during friendly search any recce or detection unit to be also considered as a friendly.
By default, recce aren't considered friendly, because that would mean that a recce would be also an attacking friendly, and this is wrong. However, in a CAP situation, when the CAP is part of an EWR network, the CAP is also an attacker. This, this method allows to register for a detection the CAP unit name prefixes to be considered CAP.
Defined in:
Parameter:
#string FriendlyPrefixes
A string or a list of prefixes.
Return value:
Set the parameters to calculate to optimal intercept point.
Defined in:
Parameters:
#boolean Intercept
Intercept is true if an intercept point is calculated. Intercept is false if it is disabled. The default Intercept is false.
#number InterceptDelay
If Intercept is true, then InterceptDelay is the average time it takes to get airplanes airborne.
Return value:
self
Method to make the radar detection less accurate, e.g.
for WWII scenarios.
Defined in:
Parameters:
#number minheight
Minimum flight height to be detected, in meters AGL (above ground)
#number thresheight
Threshold to escape the radar if flying below minheight, defaults to 90 (90% escape chance)
#number thresblur
Threshold to be detected by the radar overall, defaults to 85 (85% chance to be found)
Return value:
self
Set the detection interval time in seconds.
Defined in:
Parameter:
#number RefreshTimeInterval
Interval in seconds.
Return value:
self
Reject detections if within the specified zone(s).
Defined in:
Parameter:
Core.Zone#ZONE_BASE RejectZones
Can be a list or ZONE_BASE objects, or a single ZONE_BASE object.
Return value:
self
Upon a visual detection, the more a detected unit is within a cloudy zone, the less likely the detected unit is to be detected successfully.
The Cloudy Zones work with the ZONE_BASE derived classes. The mission designer can define within the mission zones that reflect cloudy areas where detected units may not be so easily visually detected.
Defined in:
Parameter:
ZoneArray
Aray of a The ZONE_BASE object and a ZoneProbability pair..
Return value:
self
Synchronous Event Trigger for Event Start.
Defined in:
Synchronous Event Trigger for Event Stop.
Defined in:
UnIdentify all detected objects during detection processing.
Defined in:
UnIdentify a detected object during detection processing.
Unlock a detected item.
Unlock the detected items when created and unlock all existing detected items.
Set IsDetected flag for the DetectedItem, which can have more units.
Defined in:
Parameter:
DetectedItem
Return values:
DetectedItem
#boolean:
true if at least one UNIT is detected from the DetectedSet, false if no UNIT was detected from the DetectedSet.
Asynchronous Event Trigger for Event Detect.
Asynchronous Event Trigger for Event Detected.
Defined in:
Parameters:
#number Delay
The delay in seconds.
#table Units
Table of detected units.
Asynchronous Event Trigger for Event Start.
Asynchronous Event Trigger for Event Stop.
@param #DETECTION_BASE self @param #string From The From State string. @param #string Event The Event string. @param #string To The To State string.
@param #DETECTION_BASE self @param #string From The From State string. @param #string Event The Event string. @param #string To The To State string. @param Wrapper.Group#GROUP Detection The Group detecting. @param #number DetectionTimeStamp Time stamp of detection event.
Defined in:
Parameters:
From
Event
To
Detection
DetectionTimeStamp
@param #DETECTION_BASE self @param #string From The From State string. @param #string Event The Event string. @param #string To The To State string.