Knuckle Cracker Wiki

User Tools

Site Tools

Trace:
crpl:docs:getallunitsinrange

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:getallunitsinrange [2013/11/27 03:24] – ThirdPartycrpl:docs:getallunitsinrange [2025/02/14 14:57] (current) – external edit 127.0.0.1
Line 1: Line 1:
-~~DISCUSSION~~+
 <- [[crpl:crplreference| CRPL reference]] <- [[crpl:crplreference#unit_commands|Unit Commands]] <- [[crpl:crplreference| CRPL reference]] <- [[crpl:crplreference#unit_commands|Unit Commands]]
 =====  GetAllUnitsInRange  ===== =====  GetAllUnitsInRange  =====
 +(or GAUIR)
  
 ^Arguments^Result^Notation^ ^Arguments^Result^Notation^
-|Coordinates, range, square?|Number of units in range |''x1 y1 f1 b1 -- [l1 l2...]i3 ''|+|Coordinates, range, square?|Number of units in range |''x1 y1 f1 b1 -- u1 u2... un n ''|
  
  
 === Description === === Description ===
-Returns a list of unit UID's.  Returns all units (including player/enemy and flying/landed) that are 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's of all units (including player/enemy and flying/landed) that are within range.  The function pushes the n UID's onto the stack followed by the integer n, where n is the number of units.
  
 If "square?" is set to TRUE, the command uses a square range instead of the usual circular one. If "square?" is set to TRUE, the command uses a square range instead of the usual circular one.
 === Examples === === Examples ===
 +Find all CRPL cores on the map
 +
 <code> <code>
-put example here+#Standard Notation 
 +once 
 + 0 0 9999 TRUE GetAllUnitsInRange 0 do 
 + ->unit 
 + 
 + <-unit GetUnitType "CRPLCORE" eq if 
 + "Found a CRPL core: " <-unit Trace2 
 + endif 
 + loop 
 +endonce 
 +</code> 
 +<code> 
 +#Warp Notation 
 +once 
 + GetAllUnitsInRange(0 0 9999 TRUE) 0 do 
 + ->unit 
 + if(GetUnitType(<-unit) "CRPLCORE" eq) 
 + Trace2("Found a CRPL core: " <-unit) 
 + endif 
 + loop 
 +endonce
 </code>  </code> 
 +
 +----
 +
 +Destroy every unit in range of the core this script is attached to
 +<code>
 +#Standard Notation
 +CurrentCoords 10 FALSE GetAllUnitsInRange 0 do
 + ->unit
 +
 +        <-unit CONST_DESTROYMODE GetUnitAttribute ->destroyMode
 +
 +        <-unit <-destroyMode Destroy
 +loop
 +</code>
 +
 +----
 +
 +After 10 seconds, on coordinates (50, 50), if there is an Emitter there, destroy it, even if there are multiple units occupying that cell.
 +
 +<code>
 +once
 + 300 SetTimer0
 +endonce
 +
 +GetTimer0 eq0 if
 + once
 + 50 50 0 TRUE GetAllUnitsInRange 0 do
 + ->unit
 +
 + <-unit GetUnitType "EMITTER" eq if
 + <-unit CONST_DESTROYMODE GetUnitAttribute ->destroyMode
 + <-unit <-destroyMode Destroy
 + endif
 + loop
 + endonce
 +endif
 +</code>
crpl/docs/getallunitsinrange.1385522697.txt.gz · Last modified: 2025/02/14 14:56 (external edit)

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