nearEntities: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(mp argument, example format)
m (Some wiki formatting)
 
(71 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
|version2= 1.50


|arg= global |= Arguments in MP
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| Find entities in the circle with given radius. If typeName(s) is (are) given, only entities of given type (or its subtype) are listed.
|game4= arma3
|version4= 0.50


This command returns only alive entities. If you need to return dead entities as well use [[entities]] command. |= Description
|arg= global
____________________________________________________________________________________________


| position '''nearEntities''' radius |= Syntax
|gr1= Object Detection


|p1= position: [[Object]] or [[Array]] (format [[Position]]) - center of the circle |= PARAMETER1
|descr= [[File:sphere_radius.jpg|right|200px]]
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.{{Feature|informative|This command is much [[Code_Optimisation#nearEntities_and_nearestObjects | faster]] than [[nearestObjects]] for on-foot soldier and vehicle detection.}}


|p2= radius: [[Number]] - radius of the circle |= PARAMETER2
|s1= position [[nearEntities]] radius


| [[Array]] of [[Object|Objects]]|= RETURNVALUE
|p1= position: [[Object]] or [[Array]] in format [[Position#PositionAGL|PositionAGL]] or [[Position#Introduction|Position2D]] - center of the sphere
____________________________________________________________________________________________


|s2= position '''nearEntities''' [typeName, radius] |=
|p2= radius: [[Number]] - radius of the sphere


|p21= position: [[Object]] or [[Array]] (format [[Position]]) - center of the circle |= PARAMETER1
|r1= [[Array]] of [[Object]]s - not sorted


|p22= [typeName, radius]: [[Array]] |= PARAMETER2
|s2= position [[nearEntities]] [type, radius]


|p23= typeName: [[String]] or [[Array]] of [[String|Strings]] - typeName(s) to search for |= PARAMETER3
|p21= position: [[Object]] or [[Array]] in format [[Position#PositionAGL|PositionAGL]] or [[Position#Introduction|Position2D]] - center of the sphere


|p24= radius: [[Number]] - radius of the circle |= PARAMETER4
|p22= type: [[String]] or [[Array]] of [[String]]s - type(s) to search for. See [[isKindOf]]


|r2= [[Array]] of [[Object|Objects]] |= RETURNVALUE
|p23= radius: [[Number]] - radius of the sphere
____________________________________________________________________________________________
|x1= <code>_list = [[player]] [[nearEntities]] 20;
_list = ([[position]] [[player]]) [[nearEntities]] 50;
_list = [[player]] [[nearEntities]] ["Man", 1000];
_list = ([[position]] [[player]]) [[nearEntities]] ["LaserTarget", 3000];
_list = [[player]] [[nearEntities]] <nowiki>[</nowiki>["Car", "Motorcycle", "Tank"], 50];
_list = ([[position]] [[player]]) [[nearEntities]] <nowiki>[</nowiki>["Man", "Air", "Car", "Motorcycle", "Tank"], 200];
</code>|= EXAMPLE1


____________________________________________________________________________________________
|r2= [[Array]] of [[Object]]s - not sorted


| [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearestLocation]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]] |= SEEALSO
|s3= area [[nearEntities]] [types, matchExactType, aliveOnly, includeCrew]
|s3since= arma3 2.18


| |= MPBEHAVIOUR
|p41= area: [[String]], [[Object]] or [[Array]]:
____________________________________________________________________________________________
* [[String]] - marker name
}}
* [[Object]] - trigger
* [[Array]] - format [center, a, b, angle, isRectangular, c] (see [[inArea]])
 
|p42= types: [[Array]] of [[String]]s - type(s) to search for or [] empty array to return every type
 
|p43= matchExactType: [[Boolean]] - (Optional, default [[false]]) [[true]] for an exact type match, [[false]] for an [[isKindOf]] match


<h3 style='display:none'>Notes</h3>
|p44= aliveOnly: [[Boolean]] - (Optional, default [[true]]) [[true]] to ignore dead entities, [[false]] to include them
<dl class='command_description'>
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on 27 Mar, 2014
|p45= includeCrew: [[Boolean]] - (Optional, default [[false]]) [[true]] to include crew of vehicles in search
<dt class="note">'''[[User:Floriangeyer|Floriangeyer]]'''<dd class="note">
According to [[Code Optimisation]], this function is the fastest and should be used instead of [[nearestObjects]].


|r3= [[Array]] of [[Object]]s - not sorted


<!-- Note Section END -->
|x1= <sqf>
</dl>
_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];
</sqf>


<h3 style='display:none'>Bottom Section</h3>
|seealso= [[entities]] [[findNearestEnemy]] [[nearestBuilding]] [[nearestObject]] [[nearestObjects]] [[nearObjects]] [[nearestLocation]] [[nearTargets]] [[nearSupplies]] [[nearestLocationWithDubbing]] [[nearObjectsReady]] [[nearRoads]] [[nearestMines]]
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 17:47, 4 March 2024

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobal
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:
area nearEntities [types, matchExactType, aliveOnly, includeCrew]
Parameters:
area: String, Object or Array:
types: Array of Strings - type(s) to search for or [] empty array to return every type
matchExactType: Boolean - (Optional, default false) true for an exact type match, false for an isKindOf match
aliveOnly: Boolean - (Optional, default true) true to ignore dead entities, false to include them
includeCrew: Boolean - (Optional, default false) true to include crew of vehicles in search
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
Retrieved from "https://community.bistudio.com/wiki?title=nearEntities&oldid=352923"