nearEntities: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Image:" to "[[File:")
No edit summary
Line 37: Line 37:


|r2= [[Array]] of [[Object]]s - not sorted
|r2= [[Array]] of [[Object]]s - not sorted
|s3= marker [[nearEntities]] [types, matchExactType, aliveOnly]
|s3since= Arma3 2.18
|p41= marker: [[String]] - marker area
|p42= types: [[Array]] of [[String]]s - type(s) to search for or [] empty array to return every type
|p43= matchExactType (Optional): [[Boolean]] - [[true]]: exact type match, [[false]]: [[isKindOf]] match. Default: [[false]]
|p44= aliveOnly (Optional): [[Boolean]] - [[true]]: ignore dead entities, [[false]]: include dead entites. Default: [[true]]
|r3= [[Array]] of [[Object]]s - not sorted
|s4= trigger [[nearEntities]] [types, matchExactType, aliveOnly]
|s4since= Arma3 2.18
|p61= trigger: [[Object]] - trigger area
|p62= types: [[Array]] of [[String]]s - type(s) to search for or [] empty array to return every type
|p63= matchExactType (Optional): [[Boolean]] - [[true]]: exact type match, [[false]]: [[isKindOf]] match. Default: [[false]]
|p64= aliveOnly (Optional): [[Boolean]] - [[true]]: ignore dead entities, [[false]]: include dead entites. Default: [[true]]
|r4= [[Array]] of [[Object]]s - not sorted
|s5= area [[nearEntities]] [types, matchExactType, aliveOnly]
|s5since= Arma3 2.18
|p81= area: [[Array]] - area in format [center, a, b, angle, isRectangular, c] (see [[inArea]] for explanation)
|p82= types: [[Array]] of [[String]]s - type(s) to search for or [] empty array to return every type
|p83= matchExactType (Optional): [[Boolean]] - [[true]]: exact type match, [[false]]: [[isKindOf]] match. Default: [[false]]
|p84= aliveOnly (Optional): [[Boolean]] - [[true]]: ignore dead entities, [[false]]: include dead entites. Default: [[true]]
|r5= [[Array]] of [[Object]]s - not sorted
|x1= <sqf>
|x1= <sqf>
_list = player nearEntities 20;
_list = player nearEntities 20;

Revision as of 03:47, 18 January 2024

Hover & click on the images for description

Description

Description:
sphere radius.jpg
Finds entities inside a sphere with the given radius. If the alternative syntax is used, only entities of given types or subtypes are listed. Entities returned are not sorted by distance. This command doesn't return dead entities or entities inside vehicles. If you need to return those, use entities command.
This command is much faster than nearestObjects for on-foot soldier and vehicle detection.
Groups:
Object Detection

Syntax 1

Syntax:
position nearEntities radius
Parameters:
position: Object or Array in format PositionAGL or Position2D - center of the sphere
radius: Number - radius of the sphere
Return Value:
Array of Objects - not sorted

Syntax 2

Syntax:
position nearEntities [type, radius]
Parameters:
position: Object or Array in format PositionAGL or Position2D - center of the sphere
type: String or Array of Strings - type(s) to search for. See isKindOf
radius: Number - radius of the sphere
Return Value:
Array of Objects - not sorted

Syntax 3

Syntax:
marker nearEntities [types, matchExactType, aliveOnly]
Parameters:
marker: String - marker area
types: Array of Strings - type(s) to search for or [] empty array to return every type
matchExactType (Optional): Boolean - true: exact type match, false: isKindOf match. Default: false
aliveOnly (Optional): Boolean - true: ignore dead entities, false: include dead entites. Default: true
Return Value:
Array of Objects - not sorted

Syntax 4

Syntax:
trigger nearEntities [types, matchExactType, aliveOnly]
Parameters:
trigger: Object - trigger area
types: Array of Strings - type(s) to search for or [] empty array to return every type
matchExactType (Optional): Boolean - true: exact type match, false: isKindOf match. Default: false
aliveOnly (Optional): Boolean - true: ignore dead entities, false: include dead entites. Default: true
Return Value:
Array of Objects - not sorted

Syntax 5

Syntax:
area nearEntities [types, matchExactType, aliveOnly]
Parameters:
area: Array - area in format [center, a, b, angle, isRectangular, c] (see inArea for explanation)
types: Array of Strings - type(s) to search for or [] empty array to return every type
matchExactType (Optional): Boolean - true: exact type match, false: isKindOf match. Default: false
aliveOnly (Optional): Boolean - true: ignore dead entities, false: include dead entites. Default: true
Return Value:
Array of Objects - not sorted

Examples

Example 1:
_list = player nearEntities 20; _list = ASLToAGL getPosASL player nearEntities 50; _list = player nearEntities ["Man", 1000]; _list = ASLToAGL getPosASL player nearEntities ["LaserTarget", 3000]; _list = player nearEntities [["Car", "Motorcycle", "Tank"], 50]; _list = ASLToAGL getPosASL player nearEntities [["Man", "Air", "Car", "Motorcycle", "Tank"], 200];

Additional Information

See also:
entities findNearestEnemy nearestBuilding nearestObject nearestObjects nearObjects nearestLocation nearTargets nearSupplies nearestLocationWithDubbing nearObjectsReady nearRoads nearestMines

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