Difference between revisions of "GetEntityPosition"

From Nomad DB
Line 3: Line 3:
 
== Syntax ==
 
== Syntax ==
 
<pre>
 
<pre>
GetEntityPosition(EntityId, index)
+
GetEntityPosition(entityId, component)
 
</pre>
 
</pre>
  
* [[EntityId]]
+
* '''entityID''' (string): [[EntityId|ID]] of the target entity
* '''index''' (number) 0 for x, 1 for y, 2 for z
+
* '''component'' (number): Coordinate component to return (0 = x; 1 = y; 2 = z)
* '''Returns: position component''' (number/float)
+
* '''Returns''' (number): position component
  
 
== Example ==
 
== Example ==

Revision as of 19:03, 14 April 2020

Retrieves a position from an Entity.

Syntax

GetEntityPosition(entityId, component)
  • entityID (string): ID of the target entity
  • 'component (number): Coordinate component to return (0 = x; 1 = y; 2 = z)
  • Returns (number): position component

Example

local lplayerId = GetLocalPlayerEntityId()
if lplayerId ~= GetInvalidEntityId() then
	local x = GetEntityPosition(lplayerId, 0)
	local y = GetEntityPosition(lplayerId, 0)
	local z = GetEntityPosition(lplayerId, 0)
	
	print("Position: ", x, y, z)
end

Related Pages