Differences

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

--- 4rpl:commands:stununitsinrange [2021/01/21 23:34] – created virgilw
+++ 4rpl:commands:stununitsinrange [2025/02/14 14:57] (current) – external edit 127.0.0.1
@@ Line 4: / Line 4: @@
 :!: Available in version 1.3 and later.
 ====== StunUnitsInRange ======
-StunUnitsInRange(<-cellX <-cellY <-range)
+StunUnitsInRange(<-cellX <-cellY <-range <-enemy)
 ===== Description =====
-Stuns the units. In range of the specified cell coordinates. This is the same routine that shrapnel uses to stun units. It will not stun enemy units.
+Stuns the units in range of the specified cell coordinates. This is the same routine that shrapnel uses to stun units. The 'enemy' parameter is a bool indicting if only enemy, or non enemies, should be stunned. Note that for a unit to be stunned, it must also have the CAN_STUN property set (regardless of the enemy parameter).
+:NOTE:
+Default StunCount is 10 seconds or 300 Frames.
 ===== Examples =====
 <code 4rpl>
-StunUnitsInRange(50 50 20)
+StunUnitsInRange(50 50 20 false)
 </code>
 <=[[4rpl:start| Index]]

Knuckle Cracker Wiki