User Tools

Site Tools


crpl:docs: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
crpl:docs:getunitsinrange [2013/01/14 19:39] virgilwcrpl:docs:getunitsinrange [2025/02/14 14:57] (current) – external edit 127.0.0.1
Line 1: Line 1:
  
 +<- [[crpl:crplreference| CRPL reference]] <- [[crpl:crplreference#unit_commands|Unit Commands]]
 =====  GetUnitsInRange  ===== =====  GetUnitsInRange  =====
  
 ^Arguments^Result^Notation^ ^Arguments^Result^Notation^
-|Coordinates and range|Number of units in range |''i1 i2 f1 -- [l1 l2...]i3 ''|+|Coordinates and range|Number of units in range |''i1 i2 f1 -- l1 l2...ln n ''|
  
  
 === Description === === Description ===
-Returns a list of unit UID's.  Returns all built player units that are landed and within range.  A list is returned.  A list consists of some number of unit uids, with the number of items in the list being the item on the top of the stack.+Returns the unit UID'of all built player units that are landed and within range.  The function pushes the n UID's onto the stack followed by the integer n, where n is the number of units. 
 + 
 +Note: This command will also detect Tech Artifacts, Message Artifacts, Power Zones and Shield Keys. 
 === Examples === === Examples ===
 <code> <code>
Line 17: Line 21:
  
 </code>  </code> 
- 
crpl/docs/getunitsinrange.1358192341.txt.gz · Last modified: 2025/02/14 14:56 (external edit)