Differences

This shows you the differences between two versions of the page.

--- 4rpl:commands:getunitsbytype [2020/08/02 16:11] – external edit 127.0.0.1
+++ 4rpl:commands:getunitsbytype [2025/02/14 14:57] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ~~NOTOC~~
+<=[[4rpl:start| Index]]
-====== GETUNITSBYTYPE ======
+====== GetUnitsByType ======
-GetUnitsInRange(<-unitType <-builtState) ->units
+GetUnitsByType(<-unitType <-builtState) ->units
 ===== Description =====
-Returns list of units with a type of unitType.\\
+Returns a list of units of the specified unitType((Any of the core [[unit types]] or the GUID of a custom unit.)) and builtState, ordered((The unit within this list with the lowest/smallest UID (first ever created unit of its type) will always be located at the first index (if it qualifies for the builtState). The unit with the highest/greatest UID (last created unit of its type) will always be at the last index (if it qualifies for the builtState).)) from lowest to highest UID.
-builtState is an int (either 0,1,2). 0 = ignore built state. 1 = Only find units that are built. 2 = Only find units that are not built.\\
+builtState is an int (either 0,1,2). 0 = ignore built state. 1 = Only find units that are built. 2 = Only find units that are not built.
 ===== Examples =====
 <code 4rpl>
-GetUnitsByType("Tower") ->units
+GetUnitsByType("Tower" 1) ->units
 </code>
+<=[[4rpl:start| Index]]

Knuckle Cracker Wiki