User Tools

Site Tools


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/11/18 20:00] Grabz4rpl:commands:getunits [2024/03/21 18:05] (current) – Fixed minor conflation of UID with GUID qople
Line 10: Line 10:
  
   ? 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 16: 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.
4rpl/commands/getunits.txt · Last modified: 2024/03/21 18:05 by qople