targets: Difference between revisions

From Bohemia Interactive Community
m (Text replacement - " *\|= * " to " ")
m (Fix return value)
(26 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command


| arma3 |Game name=
|game1= arma3
|version1= 1.70


|1.70|Game version=
|arg= global


|arg= global|arguments=
|gr1= Object Detection


|gr1= Object Detection |GROUP1=
|descr= Retrieves list of given unit targets matching specified filter. If the filter is not specified, all targets are returned.
{{Feature|informative|If a unit is provided, the unit itself will be excluded from results. If a group is provided, its units will be excluded (even if renegades).}}


| Retrives list of given unit targets matching specified filter. If the filter is not specified, all targets are returned.
|s1= unitOrGroup [[targets]] [enemyOnly, maxDistance, sides, maxAge, alternateCenter]


| unit '''targets''' [enemyOnly, maxDistance, sides, maxAge, alternateCenter] |SYNTAX=
|p1= unitOrGroup: [[Object]] or {{GVI|arma3|2.12}} [[Group]] - unit or group which target knowledge is retrieved


|p1= unit: [[Object]] - unit which target knowledge is retrieved|Parameter1=
|p2= enemyOnly: [[Boolean]] - (Optional) [[true]] to include only enemy targets, [[false]] to include all targets
|p2= [enemyOnly, maxDistance, sides, maxAge, alternateCenter]: [[Array]]|Parameter2=


|p3= enemyOnly (Optional): [[Boolean]] - [[true]] to include only enemy targets, [[false]] to include all targets |PARAMETER3=
|p3= maxDistance: [[Number]] - (Optional) max. distance based on target's expected position ''(distance is measured in 2D)''; use 0 to ignore the maxDistance filter


|p4= maxDistance (Optional): [[Number]] - max. distance based on target's expected position ''(distance is measured in 2D)''; use 0 to ignore the maxDistance filter |PARAMETER4=
|p4= sides: [[Array]] - (Optional) array of accepted sides; use [] to ignore the side filter


|p5= sides (Optional): [[Array]] - array of accepted sides; use [] to ignore the side filter |PARAMETER5=
|p5= maxAge: [[Number]] - (Optional) max. target age, targets that are known to unit for longer then maxAge are ignored; use 0 to ignore the maxAge filter


|p6= maxAge (Optional): [[Number]] - max. target age, targets that are known to unit for longer then maxAge are ignored; use 0 to ignore the maxAge filter |PARAMETER6=
|p6= alternateCenter: [[Array]] - (Optional) alternate (2D or 3D) position used for distance check ''(distance is measured in 2D)''; if not specified unit position is being used


|p7= alternateCenter (Optional): [[Array]] - alternate (2D or 3D) position used for distance check ''(distance is measured in 2D)''; if not specified unit position is being used |PARAMETER7=
|r1= [[Array]] - ''unitOrGroup''<nowiki/>'s targets matching the criteria


| [[Array]] - unit's targets matching the criteria |RETURNVALUE=
|x1= <sqf>private _targets = _unit targets [false, 300, [east, sideEnemy]]; // all targets of east or renegade side in 300m</sqf>


|x2= <sqf>private _targets = _unit targets [true, 300]; // enemy targets in 300m</sqf>


|x1= <code>_targets = _unit [[targets]] [false, 300, <nowiki>[east,sideEnemy]</nowiki>]; //all targets of east or renegade side in 300m</code> |Example1=
|x3= <sqf>private _targets = _unit targets []; // all targets</sqf>
|x2= <code>_targets = _unit [[targets]] [true, 300]; //enemy targets in 300m</code> |Example2=
 
|x3= <code>_targets = _unit [[targets]] []; //all targets</code> |EXAMPLE3=
 
| [[nearTargets]], [[targetsQuery]], [[reveal]], [[side]] |SEEALSO=


|seealso= [[targetsQuery]] [[nearTargets]] [[targetsAggregate]] [[targetKnowledge]] [[knowsAbout]] [[reveal]] [[forgetTarget]] [[setTargetAge]] [[getHideFrom]] [[side]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
</dl>
<h3 style="display:none">Bottom Section</h3>
{{GameCategory|arma3|New Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Revision as of 10:23, 15 November 2022

Hover & click on the images for description

Description

Description:
Retrieves list of given unit targets matching specified filter. If the filter is not specified, all targets are returned.
If a unit is provided, the unit itself will be excluded from results. If a group is provided, its units will be excluded (even if renegades).
Groups:
Object Detection

Syntax

Syntax:
unitOrGroup targets [enemyOnly, maxDistance, sides, maxAge, alternateCenter]
Parameters:
unitOrGroup: Object or Arma 3 logo black.png 2.12 Group - unit or group which target knowledge is retrieved
enemyOnly: Boolean - (Optional) true to include only enemy targets, false to include all targets
maxDistance: Number - (Optional) max. distance based on target's expected position (distance is measured in 2D); use 0 to ignore the maxDistance filter
sides: Array - (Optional) array of accepted sides; use [] to ignore the side filter
maxAge: Number - (Optional) max. target age, targets that are known to unit for longer then maxAge are ignored; use 0 to ignore the maxAge filter
alternateCenter: Array - (Optional) alternate (2D or 3D) position used for distance check (distance is measured in 2D); if not specified unit position is being used
Return Value:
Array - unitOrGroup's targets matching the criteria

Examples

Example 1:
private _targets = _unit targets [false, 300, [east, sideEnemy]]; // all targets of east or renegade side in 300m
Example 2:
private _targets = _unit targets [true, 300]; // enemy targets in 300m
Example 3:
private _targets = _unit targets []; // all targets

Additional Information

See also:
targetsQuery nearTargets targetsAggregate targetKnowledge knowsAbout reveal forgetTarget setTargetAge getHideFrom side

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note