targets: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix return value)
(Add default values)
 
(One intermediate revision by the same user not shown)
Line 13: Line 13:
|s1= unitOrGroup [[targets]] [enemyOnly, maxDistance, sides, maxAge, alternateCenter]
|s1= unitOrGroup [[targets]] [enemyOnly, maxDistance, sides, maxAge, alternateCenter]


|p1= unitOrGroup: [[Object]] or {{GVI|arma3|2.12}} [[Group]] - unit or group which target knowledge is retrieved
|p1= unitOrGroup: [[Object]] or {{GVI|arma3|2.12|size= 0.75}} [[Group]] - unit or group which target knowledge is retrieved


|p2= enemyOnly: [[Boolean]] - (Optional) [[true]] to include only enemy targets, [[false]] to include all targets
|p2= enemyOnly: [[Boolean]] - (Optional, default [[false]]) [[true]] to include only enemy targets, [[false]] to include all targets


|p3= maxDistance: [[Number]] - (Optional) max. distance based on target's expected position ''(distance is measured in 2D)''; use 0 to ignore the maxDistance filter
|p3= maxDistance: [[Number]] - (Optional, default -1) maximum '''2D''' distance based on target's expected position; use 0 to ignore the filter


|p4= sides: [[Array]] - (Optional) array of accepted sides; use [] to ignore the side filter
|p4= sides: [[Array]] - (Optional, default {{hl|[]}}) array of accepted sides; use {{hl|[]}} to ignore the side filter


|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
|p5= maxAge: [[Number]] - (Optional, default 0) max. target age, targets that are known to unit for longer than maxAge are ignored; use 0 to ignore the maxAge filter


|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
|p6= alternateCenter: [[Array]] - (Optional, default ''unitOrGroup''<nowiki/>'s position) alternate (2D or 3D) position used for '''2D''' distance check


|r1= [[Array]] - ''unitOrGroup''<nowiki/>'s targets matching the criteria
|r1= [[Array]] - ''unitOrGroup''<nowiki/>'s targets matching the criteria

Latest revision as of 23:20, 30 March 2024

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.png2.12 Group - unit or group which target knowledge is retrieved
enemyOnly: Boolean - (Optional, default false) true to include only enemy targets, false to include all targets
maxDistance: Number - (Optional, default -1) maximum 2D distance based on target's expected position; use 0 to ignore the filter
sides: Array - (Optional, default []) array of accepted sides; use [] to ignore the side filter
maxAge: Number - (Optional, default 0) max. target age, targets that are known to unit for longer than maxAge are ignored; use 0 to ignore the maxAge filter
alternateCenter: Array - (Optional, default unitOrGroup's position) alternate (2D or 3D) position used for 2D distance check
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 or on the Forums.
Only post proven facts here! Add Note