targetsQuery: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2")
 
(56 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Returns sorted array of targets, '''known''' to the querier (including own troops), where the accuracy coefficient reflects how close the result matches the query. This command could be CPU intensive. |= Description
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| querier '''targetsQuery''' [targetIgnore, targetSide, targetType, targetPosition, targetMaxAge] |= Syntax
|game4= arma3
|version4= 0.50


|p1= querier: [[Object]] - For whom the query will be made |= PARAMETER1
|gr1= Object Detection


|p2= [targetIgnore, targetSide, targetType, targetPosition, targetAgeLimit]: [[Array]] - Query |= PARAMETER2
|descr= Returns sorted array of targets, '''known''' to the enquirer (including own troops), where the accuracy coefficient reflects how close the result matches the query. This command could be CPU intensive.


|p3= targetIgnore: [[Object]] - Target object to exclude from results. [[objNull]] - return every target |= PARAMETER3
|s1= enquirer [[targetsQuery]] [targetIgnore, targetSide, targetType, targetPosition, targetMaxAge]
|p4= targetSide: [[Side]] - Desired side of the target. [[sideUnknown]] - any side |= PARAMETER3
|p5= targetType; [[String]] - Desired target [[typeOf]]. "" - any type |= PARAMETER3
|p6= targetPosition: [[Array]] - Desired target position in format of [[Position2D]] or [[Position3D]] (only [x,y] is considered). Position tolerance is 200m from the actual position of the target. [] - any position|= PARAMETER3
|p7= targetMaxAge: [[Number]] - Desired max age of the target. This will limit returned results to the targets younger than specified age. 0 - any age|= PARAMETER3


| [[Array]] - '''sorted''' array of returned targets in the following format:  
|p1= enquirer: [[Object]] - for whom the query will be made
 
|p2= targetIgnore: [[Object]] - target object to exclude from results. [[objNull]] - return every target
 
|p3= targetSide: [[Side]] - desired side of the target. [[sideUnknown]] - any side
 
|p4= targetType: [[String]] - desired target [[typeOf]]. "" - any type
 
|p5= targetPosition: [[Array]] - desired target position in format of [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] (only [x,y] is considered). Position tolerance is 200m from the actual position of the target. [] - any position
 
|p6= targetMaxAge: [[Number]] - desired max age of the target. This will limit returned results to the targets younger than specified age. 0 - any age
 
|r1= [[Array]] - '''sorted''' array of returned targets in the following format:
<nowiki>[</nowiki>[accuracy, target, targetSide, targetType, targetPosition, targetAge],...] where:
<nowiki>[</nowiki>[accuracy, target, targetSide, targetType, targetPosition, targetAge],...] where:
* accuracy: [[Number]] - a coefficient, which reflects how close the returned result to the query filter. Range: 0 - 1 (1 - best match)
* accuracy: [[Number]] - a coefficient, which reflects how close the returned result to the query filter. Range: 0 - 1 (1 - best match)
Line 30: Line 39:
* targetPosition: [[Array]] - [x,y] of the target  
* targetPosition: [[Array]] - [x,y] of the target  
* targetAge: [[Number]] - the actual target age in seconds (can be negative)
* targetAge: [[Number]] - the actual target age in seconds (can be negative)
|= RETURNVALUE
|x1= Return all known targets for player:<code>_targets = [[player]] [[targetsQuery]] <nowiki>[</nowiki>[[objNull]], [[sideUnknown]], "", [], 0];</code>|= EXAMPLE1
|x2= Return all known OPFOR targets less than 10 seconds old:<code>_targets = [[player]] [[targetsQuery]] <nowiki>[</nowiki>[[objNull]], [[east]], "", [], 10];</code>|= EXAMPLE2
____________________________________________________________________________________________


| [[targetsAggregate]], [[targetKnowledge]], [[knowsAbout]] |= SEEALSO
|x1= Return all known targets for player:
<sqf>_targets = player targetsQuery [objNull, sideUnknown, "", [], 0];</sqf>
|x2= Prioritise all known OPFOR targets and return targets less than 10 seconds old:
<sqf>_targets = player targetsQuery [objNull, east, "", [], 10];</sqf>


| |= MPBEHAVIOUR
|seealso= [[targets]] [[nearTargets]] [[targetsAggregate]] [[targetKnowledge]] [[knowsAbout]] [[reveal]] [[forgetTarget]] [[setTargetAge]] [[getHideFrom]]
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 15:50, 8 November 2023

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Returns sorted array of targets, known to the enquirer (including own troops), where the accuracy coefficient reflects how close the result matches the query. This command could be CPU intensive.
Groups:
Object Detection

Syntax

Syntax:
enquirer targetsQuery [targetIgnore, targetSide, targetType, targetPosition, targetMaxAge]
Parameters:
enquirer: Object - for whom the query will be made
targetIgnore: Object - target object to exclude from results. objNull - return every target
targetSide: Side - desired side of the target. sideUnknown - any side
targetType: String - desired target typeOf. "" - any type
targetPosition: Array - desired target position in format of Position2D or Position3D (only [x,y] is considered). Position tolerance is 200m from the actual position of the target. [] - any position
targetMaxAge: Number - desired max age of the target. This will limit returned results to the targets younger than specified age. 0 - any age
Return Value:
Array - sorted array of returned targets in the following format: [[accuracy, target, targetSide, targetType, targetPosition, targetAge],...] where:
  • accuracy: Number - a coefficient, which reflects how close the returned result to the query filter. Range: 0 - 1 (1 - best match)
  • target: Object - the actual target object
  • targetSide: Side - side of the target
  • targetType: String - target typeOf
  • targetPosition: Array - [x,y] of the target
  • targetAge: Number - the actual target age in seconds (can be negative)

Examples

Example 1:
Return all known targets for player:
_targets = player targetsQuery [objNull, sideUnknown, "", [], 0];
Example 2:
Prioritise all known OPFOR targets and return targets less than 10 seconds old:
_targets = player targetsQuery [objNull, east, "", [], 10];

Additional Information

See also:
targets nearTargets targetsAggregate targetKnowledge knowsAbout reveal forgetTarget setTargetAge getHideFrom

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Retrieved from "https://community.bistudio.com/wiki?title=targetsQuery&oldid=349176"