Differences

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

--- 4rpl:commands:getunitposition [2022/06/21 10:19] – Karsten75
+++ 4rpl:commands:getunitposition [2023/01/19 09:28] (current) – Expanded example to show how to use vector (aka TrickyCorp Discord Version mod) Karsten75
@@ Line 15: / Line 15: @@
 Note: If this call is attempted on an non-existing unit, nothing will be put on the stack.
+In V 2.4, this behavior changes and this API will now return V3(0 0 0), similar to other APIs.
 ===== Examples =====
 <code 4rpl>
 GetUnitPosition(<-UID) ->pos
+# to extract the individual values from the above vector:
+<-pos.x ->positionX
+<-pos.y ->positionY
+<-pos.z ->positonZ
+# or use the .dot syntax above to directly access the values in the vector, or
+EV3(<-pos) ->z ->y ->x
 </code>
-A "safe" method to use this function and to handle the lack of a return value on non-existent units  Are as follows:
+A "safe" method to use this function and to handle the lack of a return value on non-existent units are as follows:
 <code 4rpl>
@@ Line 28: / Line 39: @@
 :unitPos
-	StackSize ->stackSize   # be careful that this variable is not used in other code.
+    StackSize ->size
-	GetUnitPosition
+    GetUnitPosition
-	If (Stacksize <-stackSize EQ)
+    If (Stacksize <-size NEQ)
-		Return
+        V3(-1 -1 -1)
-	else
+    endif
-		V3(-1 -1 -1)
-	endif
 </code>
 <=[[4rpl:start| Index]]

Knuckle Cracker Wiki