Knuckle Cracker Wiki

User Tools

Site Tools

Trace: • setdigitalis
4rpl:commands:getunits

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:getunits [2021/10/01 13:45] – So many notes need their own heading :) Some other format changes as well Karsten754rpl:commands:getunits [2024/03/21 18:05] (current) – Fixed minor conflation of UID with GUID qople
Line 8: Line 8:
 ===== 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.\\ 
- 
- 
-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. 
  
   ? unitType:   ? unitType:
-  : a string indicating the [[unit types|unit type]]((Unit Type can also be the UID of a CMOD)) to return. If empty string (""), then all units are searched.+  : a string indicating the [[unit types|unit type]]((Unit Type can also be the GUID of a CMOD)) to return. If empty string (""), then all units are searched.
   ? startPos:   ? startPos:
   : a V3 (vector3) indicating the point to search outwards from.   : a V3 (vector3) indicating the point to search outwards from.
Line 19: Line 16:
   : a floating point number that is the maximum distance from startPos.   : a floating point number that is the maximum distance from startPos.
   ? isSquare:   ? isSquare:
-  : 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). +  : 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). :!: __Bug__: if isSquare is true, then the startPos vector will ignore the Z-value.
   ? is3D:   ? is3D:
   : 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. It determines if a true 3d distance is used for range, or if only the X and Z components (2D) distance calculation is used.
Line 30: Line 27:
   ? imperviousState:   ? imperviousState:
   : an int (either 0,1,2). 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.   : an int (either 0,1,2). 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.
 +
 +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.
  
 ===== Examples ===== ===== Examples =====
Line 49: Line 48:
  
 === Notes === === Notes ===
-  ** The difference between this API and [[GetUnitsInRange]] is this API takes a 'unitType' parameter.  By specifying a unitType, less units are searched over resulting in potentially higher performance. Furthermore, GetUnits can search for any units regardless of whether they occupy space, so units that are in flight can be found this way as well.+  ** The difference between this API and [[GetUnitsInRange]] is this API takes a 'unitType' parameter.  By specifying a unitType, fewer units are searched over resulting in potentially higher performance. Furthermore, GetUnits can search for any units regardless of whether they occupy space, so units that are in flight can be found this way as well.
   .. GetUnits takes a unit type and from that it will internally find all units of that type.  It then enumerates those units and checks if they are in range and if they match the state filters. So GetUnits can be used to find any unit (air, map, or neither). This method can be more performant than GetUnitsInRange if the unit being searched is not found in large quantities on the map.   .. GetUnits takes a unit type and from that it will internally find all units of that type.  It then enumerates those units and checks if they are in range and if they match the state filters. So GetUnits can be used to find any unit (air, map, or neither). This method can be more performant than GetUnitsInRange if the unit being searched is not found in large quantities on the map.
   * 2D square search is currently broken and will find all units as long as they are close enough on X-axis, disregarding the Z-axis. Do not use this combination of parameters.    * 2D square search is currently broken and will find all units as long as they are close enough on X-axis, disregarding the Z-axis. Do not use this combination of parameters. 
4rpl/commands/getunits.1633110312.txt.gz · Last modified: 2021/10/01 13:45 by Karsten75

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