Knuckle Cracker Wiki

User Tools

Site Tools

Trace:
4rpl:commands:getunitsinrange

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
4rpl:commands:getunitsinrange [2021/09/13 22:57] – additional clarification from KC Grabz4rpl:commands:getunitsinrange [2025/02/14 14:57] (current) – external edit 127.0.0.1
Line 7: Line 7:
 ===== Description ===== ===== Description =====
 Returns list of units in range of a given position. The returned list is sorted so that the first item in the list is the closest. Returns list of units in range of a given position. The returned list is sorted so that the first item in the list is the closest.
 +
 +:!: **Note:** The difference between this API and [[GetUnits]] is that this method performs a search around the specified coordinates for any units that leave a footprint on the map by occupying space. This can be more performant than GetUnits in situations where a smaller area is being searched, but it comes with a downside that it won't find flying units, **or land units that are currently moving**. Units occupy space as soon as they begin descending at their target location, they do not have to have touched the ground yet. If you need a method to find units regardless of whether or not they are occupying space, use GetUnits. \\
 +Whether a custom unit occupies space can be controlled through the CMOD Settings: **Settings > Basic > "occupies land"**.
 +
 +For short range searches refer to the [[cw4:4rpl_unit_search_analysis|unit search analysis]] to see how the different parameters interact with finding units in a short range.
 +
 +
   ? startPos:   ? startPos:
   : a [[V3]] (vector3) indicating the point to search outwards from.   : a [[V3]] (vector3) indicating the point to search outwards from.
Line 41: Line 48:
     ? 2 =      ? 2 = 
     : Only find units that are impervious. Things like ore deposits are impervious.     : Only find units that are impervious. Things like ore deposits are impervious.
- 
-:!: **Note:** Due to some technicalities units which do not occupy any space will never be detected by this command. Whether a custom unit occupies space can be controlled through the CMOD Settings: **Settings > Basic > "occupies land"**. Units occupy space as soon as they begin descending at their target location, they do not have to have touched the ground yet. 
  
 ===== Examples ===== ===== Examples =====
Line 59: Line 64:
 GetUnitsInRange( V3(<-cellX <-terrain <-cellZ) <-range <-isSquare <-is3D <-requireLOS <-enemyState <-builtState <-imperviousState) ->units GetUnitsInRange( V3(<-cellX <-terrain <-cellZ) <-range <-isSquare <-is3D <-requireLOS <-enemyState <-builtState <-imperviousState) ->units
 </code> </code>
- 
-=== Usage notes === 
-GetUnitsInRange doesn't take a unit type.  It just searches in a range around the specified coordinates.  It only finds units that leave a footprint on the map.  So it won't work for flying units (or land based units that are moving). Compare with usage note at [[getUnits]] 
- 
  
 === See Also === === See Also ===
-  * [[4rpl:commands:getUnits]]+  * [[GetUnits]]
      
 <=[[4rpl:start| Index]] <=[[4rpl:start| Index]]
  
4rpl/commands/getunitsinrange.1631573850.txt.gz · Last modified: 2025/02/14 14:56 (external edit)

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki