Knuckle Cracker Wiki

User Tools

Site Tools

Trace:
4rpl:commands:getunitposition

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
4rpl:commands:getunitposition [2022/06/19 12:22] – [Description] Karsten754rpl: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.  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 ===== ===== Examples =====
 <code 4rpl> <code 4rpl>
 GetUnitPosition(<-UID) ->pos 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> </code>
 +
 +
 +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>
 + Trace (@UnitPos(7) )
 +
 +:unitPos
 +    StackSize ->size
 +    GetUnitPosition
 +    If (Stacksize <-size NEQ)
 +        V3(-1 -1 -1)
 +    endif
 +</code>
 +
 <=[[4rpl:start| Index]] <=[[4rpl:start| Index]]
  
4rpl/commands/getunitposition.txt · Last modified: 2023/01/19 09:28 by Karsten75

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