User Tools

Site Tools


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/14 15:27] – already moved to top Grabz4rpl:commands:getunitsinrange [2025/02/14 14:57] (current) – external edit 127.0.0.1
Line 10: Line 10:
 :!: **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. \\ :!: **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"**. 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.
  
  
Line 64: Line 66:
  
 === See Also === === See Also ===
-  * [[4rpl:commands:GetUnits]]+  * [[GetUnits]]
      
 <=[[4rpl:start| Index]] <=[[4rpl:start| Index]]
  
4rpl/commands/getunitsinrange.1631633259.txt.gz · Last modified: 2025/02/14 14:56 (external edit)