targetsAggregate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style='display:none'>Notes</h3> <dl class='command_description'> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> <h3 style='display:none'>Bottom Section</h3>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma2 |Game name=
| arma2


|1.00|Game version=
|1.00


| Aggregate candidates. |DESCRIPTION=
| Aggregate candidates.


|gr1= Object Manipulation |GROUP1=
|gr1= Object Manipulation


| [speaker, side, unit, place, time] '''targetsAggregate''' candidates |SYNTAX=
| [speaker, side, unit, place, time] '''targetsAggregate''' candidates


|p1= [speaker, side, unit, place, time]: [[Array]] |PARAMETER1=
|p1= [speaker, side, unit, place, time]: [[Array]]


|p2= candidates: [[Array]] -  array of targets in the following format:
|p2= candidates: [[Array]] -  array of targets in the following format:
Line 20: Line 20:
* targetType: [[String]] - target [[typeOf]]
* targetType: [[String]] - target [[typeOf]]
* 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)|PARAMETER2=
* targetAge: [[Number]] - the actual target age in seconds (can be negative)


| [[Array]] |RETURNVALUE=
| [[Array]]


|x1 = <pre>_aggregation = [player, sideEnemy, "", [], 0] targetsAggregate (player targetsQuery [objNull, sideUnknown, "", [], 0])</pre>could return something like this: <br>
|x1 = <pre>_aggregation = [player, sideEnemy, "", [], 0] targetsAggregate (player targetsQuery [objNull, sideUnknown, "", [], 0])</pre>could return something like this: <br>
<nowiki>[[["COUNT0",1],["SIDE0",WEST],["UNIT0","B_Soldier_F"],["PLACE0",[[<null>,<null>],0,<null>]],["TIME0",[-0.9,-0.9]],["UCOUNT0",1],["UTYPE0","...</nowiki>|EXAMPLE1=
<nowiki>[[["COUNT0",1],["SIDE0",WEST],["UNIT0","B_Soldier_F"],["PLACE0",[[<null>,<null>],0,<null>]],["TIME0",[-0.9,-0.9]],["UCOUNT0",1],["UTYPE0","...</nowiki>




| [[targetsQuery]], [[forgetTarget]] |SEEALSO=
| [[targetsQuery]], [[forgetTarget]]


| |MPBEHAVIOUR=
|
}}
}}



Revision as of 11:28, 18 January 2021

Hover & click on the images for description

Description

Description:
Aggregate candidates.
Groups:
Object Manipulation

Syntax

Syntax:
[speaker, side, unit, place, time] targetsAggregate candidates
Parameters:
[speaker, side, unit, place, time]: Array
candidates: Array - array of 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)
Return Value:
Array

Examples

Example 1:
_aggregation = [player, sideEnemy, "", [], 0] targetsAggregate (player targetsQuery [objNull, sideUnknown, "", [], 0])
could return something like this:
[[["COUNT0",1],["SIDE0",WEST],["UNIT0","B_Soldier_F"],["PLACE0",[[<null>,<null>],0,<null>]],["TIME0",[-0.9,-0.9]],["UCOUNT0",1],["UTYPE0","...

Additional Information

See also:
targetsQueryforgetTarget

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