nearEntities
Jump to navigation
Jump to search
Description
- Description:
- 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.
- 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, includeCrew]
- 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
- includeCrew (Optional): Boolean - true: to include crew of vehicles in search. Default: false
- Return Value:
- Array of Objects - not sorted
Syntax 4
- Syntax:
- trigger nearEntities [types, matchExactType, aliveOnly, includeCrew]
- 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
- includeCrew (Optional): Boolean - true: to include crew of vehicles in search. Default: false
- Return Value:
- Array of Objects - not sorted
Syntax 5
- Syntax:
- area nearEntities [types, matchExactType, aliveOnly, includeCrew]
- 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
- includeCrew (Optional): Boolean - true: to include crew of vehicles in search. Default: false
- 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