nearEntities: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "[[Category:Scripting_Commands_Take_On_Helicopters" to "[[Category:Scripting Commands Take On Helicopters")
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{Command|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma2 |= Game name
| arma2 |Game name=


|1.00|= Game version
|1.00|Game version=


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


| Find entities in the circle with given radius. If typeName(s) is (are) given, only entities of given type (or its subtype) are listed.
| [[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>
This command returns only alive entities. If you need to return dead entities as well use [[entities]] command. |= Description
{{Informative|This command is much [[Code_Optimisation#nearEntities_and_nearestObjects | faster]] than [[nearestObjects]] for on-foot soldier and vehicle detection.}} |Description=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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


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


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


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


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


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


|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 |PARAMETER23=


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


|r2= [[Array]] of [[Object|Objects]] |= RETURNVALUE
|r2= [[Array]] of [[Object|Objects]] - not sorted |RETURNVALUE 2=
____________________________________________________________________________________________
____________________________________________________________________________________________
|x1= <code>_list = [[player]] [[nearEntities]] 20;
|x1= <code>_list = [[player]] [[nearEntities]] 20;
_list = ([[position]] [[player]]) [[nearEntities]] 50;
_list = [[ASLToAGL]] [[getPosASL]] [[player]] [[nearEntities]] 50;
_list = [[player]] [[nearEntities]] ["Man", 1000];
_list = [[player]] [[nearEntities]] ["Man", 1000];
_list = ([[position]] [[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 = ([[position]] [[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>|EXAMPLE1=


____________________________________________________________________________________________
____________________________________________________________________________________________


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


|  |= MPBEHAVIOUR
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}


Line 54: Line 53:
<dl class='command_description'>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- 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]].


<!-- Note Section END -->
<!-- Note Section END -->
Line 64: Line 58:


<h3 style='display:none'>Bottom Section</h3>
<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}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
<dl class="command_description">
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
<dd class="notedate">Posted on February 3, 2015 - 21:30 (UTC)</dd>
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
<dt class="note">[[User:Pierre MGI|Pierre MGI]]</dt>
<dd class="note">
This kind of functions remains FPS killer if you can't manage conditions in order to reduce operations for each entity or, to reduce the number of entities.
One of the most demanding CPU/GPU resource is probably a DrawIcon3D treatment for these entities.
Don't stay with a simple radius condition (disk selecting entities).
Each time you can treat visible entities, as icons displaying, try to restrict this function to your screen.
For example:
if (((worldToScreen (visiblePosition _x)) select 0 > (0 * safezoneW + safezoneX)) &&
((worldToScreen (visiblePosition _x)) select 0 <(1 * safezoneW + safezoneX))) then {...} foreach _pos nearEntities _radius
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 14:05, 6 April 2020

Logo A2.png1.00
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:
Uncategorised

Syntax

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

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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=nearEntities&oldid=150923"