nearEntities: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (fixed examples)
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ |()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
(26 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
| arma2


|1.00|= Game version
|1.00


|arg= global |= Arguments in MP
|arg= global
____________________________________________________________________________________________


| [[Image:sphere_radius.jpg|right|150px]] Find entities in the sphere with given radius. If typeName(s) is (are) given, only entities of given type (or its subtype) are listed.
|gr1= Object Detection


This command returns only alive entities. If you need to return dead entities as well use [[entities]] command.|= Description
| [[Image: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.<br><br>
{{Feature|Informative|This command is much [[Code_Optimisation#nearEntities_and_nearestObjects | faster]] than [[nearestObjects]] for on-foot soldier and vehicle detection.}}


| position '''nearEntities''' radius |= Syntax
| position [[nearEntities]] radius


|p1= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] - center of the sphere |= PARAMETER1
|p1= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] - center of the sphere


|p2= radius: [[Number]] - radius of the sphere |= PARAMETER2
|p2= radius: [[Number]] - radius of the sphere


| [[Array]] of [[Object|Objects]]|= RETURNVALUE
| [[Array]] of [[Object|Objects]] - not sorted
____________________________________________________________________________________________


|s2= position '''nearEntities''' [typeName, radius] |=
|s2= position [[nearEntities]] [type, radius]


|p21= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] - center of the sphere |= PARAMETER1
|p21= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] - center of the sphere


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


|p23= typeName: [[String]] or [[Array]] of [[String|Strings]] - typeName(s) to search for |= PARAMETER3
|p23= type: [[String]] or [[Array]] of [[String|Strings]] - type(s) to search for


|p24= radius: [[Number]] - radius of the sphere |= PARAMETER4
|p24= radius: [[Number]] - radius of the sphere


|r2= [[Array]] of [[Object|Objects]] |= RETURNVALUE
|r2= [[Array]] of [[Object|Objects]] - not sorted
____________________________________________________________________________________________
|x1= <code>_list = [[player]] [[nearEntities]] 20;
|x1= <code>_list = [[player]] [[nearEntities]] 20;
_list = ([[ASLToAGL]] ([[getPosASL]] [[player]])) [[nearEntities]] 50;
_list = [[ASLToAGL]] [[getPosASL]] [[player]] [[nearEntities]] 50;
_list = [[player]] [[nearEntities]] ["Man", 1000];
_list = [[player]] [[nearEntities]] ["Man", 1000];
_list = ([[ASLToAGL]] ([[getPosASL]] [[player]])) [[nearEntities]] ["LaserTarget", 3000];
_list = [[ASLToAGL]] [[getPosASL]] [[player]] [[nearEntities]] ["LaserTarget", 3000];
_list = [[player]] [[nearEntities]] <nowiki>[</nowiki>["Car", "Motorcycle", "Tank"], 50];
_list = [[player]] [[nearEntities]] [<nowiki/>["Car", "Motorcycle", "Tank"], 50];
_list = ([[ASLToAGL]] ([[getPosASL]] [[player]])) [[nearEntities]] <nowiki>[</nowiki>["Man", "Air", "Car", "Motorcycle", "Tank"], 200];
_list = [[ASLToAGL]] [[getPosASL]] [[player]] [[nearEntities]] [<nowiki/>["Man", "Air", "Car", "Motorcycle", "Tank"], 200];
</code>|= EXAMPLE1
</code>


____________________________________________________________________________________________
|seealso= [[entities]], [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearestLocation]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]]
 
| [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearestLocation]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]] |= SEEALSO
 
|  |= MPBEHAVIOUR
____________________________________________________________________________________________
}}
}}


<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on 27 Mar, 2014
<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]] when suitable.


[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]


<!-- Note Section END -->
{{GameCategory|arma2|Scripting Commands}}
</dl>
{{GameCategory|tkoh|Scripting Commands}}
 
{{GameCategory|arma3|Scripting Commands}}
<h3 style='display:none'>Bottom Section</h3>
[[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}}}}]]

Revision as of 00:54, 17 February 2021

Game1 needed - Version1 needed
GAGlobal
Hover & click on the images for description

Description

Description:
This article is a Stub. You can help BI Community Wiki by expanding it.
Description needed
Groups:
Object Detection

Syntax

Syntax:
Syntax needed
Parameters:
position: Object or Array in format PositionAGL or Position2D - center of the sphere
radius: Number - radius of the sphere
Return Value:
Return value needed

Alternative Syntax

Syntax:
position nearEntities [type, radius]
Parameters:
position: Object or Array in format PositionAGL or Position2D - center of the sphere
[type, radius]: Array
type: String or Array of Strings - type(s) to search for
radius: Number - radius of the sphere
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:
entitiesfindNearestEnemynearestBuildingnearestObjectnearestObjectsnearObjectsnearestLocationnearTargetsnearSuppliesnearestLocationWithDubbingnearObjectsReadynearRoads

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=247367"