4rpl:commands:getunitsinrange
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| 4rpl:commands:getunitsinrange [2021/01/20 19:48] – Regallion | 4rpl:commands:getunitsinrange [2025/02/14 14:57] (current) – external edit 127.0.0.1 | ||
|---|---|---|---|
| Line 6: | Line 6: | ||
| ===== Description ===== | ===== Description ===== | ||
| - | Returns list of units in range of a startPos. 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. |
| - | startPos | + | |
| - | range is a floating point number that is the maximum distance from startPos.\\ | + | :!: **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. \\ |
| - | isSquare | + | Whether a custom unit occupies space can be controlled through the CMOD Settings: **Settings > Basic > " |
| - | is3D is a boolean. It determines if a true 3d distance is used for range, or if only the X and Z components (2D) distance calculation is used.\\ | + | |
| - | requireLOS | + | For short range searches refer to the [[cw4: |
| - | enemyState | + | |
| - | builtState | + | |
| - | imperviousState | + | ? startPos: |
| + | : a [[V3]] (vector3) indicating the point to search outwards from. | ||
| + | ? | ||
| + | : a floating point number that is the maximum distance from startPos. | ||
| + | ? | ||
| + | : a boolean. It means to check in a square rather than a circle around startPos. For 3D checks, the vertical displacement is also checked (so the range is effectivly a cube rather than a sphere). (( **Note:** When isSquare is true, the search will also not use the unit's exact position to see if they are in range, but rather their hitbox (footprint & height). If any part of the hitbox crosses into the square, it will be selected.)) | ||
| + | ? | ||
| + | : a boolean. It determines if a true 3d distance is used for range, or if only the X and Z components (2D) distance calculation is used. | ||
| + | ? | ||
| + | : a boolean indicating if terrain line of sight is required. | ||
| + | ? | ||
| + | : an int (either 0, | ||
| + | ? 0 = | ||
| + | : ignore enemy status. | ||
| + | ? 1 = | ||
| + | : Only find units that are enemies. | ||
| + | ? 2 = | ||
| + | : Only find units that are not enemies. | ||
| + | ? | ||
| + | : an int (either 0, | ||
| + | ? 0 = | ||
| + | : ignore built state. | ||
| + | ? 1 = | ||
| + | : Only find units that are built. | ||
| + | ? 2 = | ||
| + | : Only find units that are not built. | ||
| + | ? | ||
| + | : an int (either 0, | ||
| + | ? 0 = | ||
| + | : ignore impervious state. | ||
| + | ? 1 = | ||
| + | : Only find units that are not impervious. | ||
| + | ? 2 = | ||
| + | : Only find units that are impervious. Things like ore deposits are impervious. | ||
| ===== Examples ===== | ===== Examples ===== | ||
| Line 31: | Line 64: | ||
| GetUnitsInRange( V3(< | GetUnitsInRange( V3(< | ||
| </ | </ | ||
| + | |||
| + | === See Also === | ||
| + | * [[GetUnits]] | ||
| + | | ||
| < | < | ||
4rpl/commands/getunitsinrange.1611172105.txt.gz · Last modified: 2025/02/14 14:56 (external edit)
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
