Difference between revisions of "DCS func getPosition"

Latest revision as of 09:09, 28 January 2023

Envrioment:	Mission Scripting

Function:	getPosition	Added with: 1.2.0

Member Of:	Object, Spot
Syntax:	Position3 Object.getPosition(Class Self )
Description:	Returns a Position3 table of the objects current position and orientation in 3D space. X, Y, Z values are unit vectors defining the objects orientation. Coordinates are dependent on the position of the maps origin. In the case of the Caucuses theater, the origin is located in the Crimean region of the map. Function also works with Unit, Weapon, Static Object, Scenery Object, Airbase

Return Value:	Position3
Return Example:	Position 3 is a table consisting of the point and orientation tables. Position3 = { p = Vec3, x = Vec3, y = Vec3, z = Vec3 }

Examples:	Assigns a value for the heading and pitch of the unit. local unit = Unit.getByName('Bob') local unitpos = unit:getPosition() local Heading = math.atan2(unitpos.x.z, unitpos.x.x) local Pitch = math.asin(unitpos.x.y)
Related Functions:	Object Functions: isExist, destroy, getCategory, getTypeName, getDesc, hasAttribute, getName, getPoint, getPosition, getVelocity, inAir
Notes:

@@ Line 13: / Line 13: @@
 |par4=
-|desc= Returns a pos3 table of the objects current position and orientation in 3D space. X, Y, Z values are unit vectors defining the objects orientation. Coordinates are dependent on the position of the maps origin. In the case of the Caucuses theater, the origin is located in the Crimean region of the map.
+|desc= Returns a Position3 table of the objects current position and orientation in 3D space. X, Y, Z values are unit vectors defining the objects orientation. Coordinates are dependent on the position of the maps origin. In the case of the Caucuses theater, the origin is located in the Crimean region of the map.
 Function also works with [[DCS_Class_Unit|Unit]], [[DCS_Class_Weapon|Weapon]], [[DCS_Class_Static_Object|Static Object]], [[DCS_Class_Scenery_Object|Scenery Object]], [[DCS_Class_Airbase|Airbase]]
-|rtnType= vec3
+|rtnType= Position3
 |rtnExample= Position 3 is a table consisting of the point and orientation tables.
@@ Line 40: / Line 40: @@
 [[DCS_Class_Object|'''Object Functions:''']] {{listofScriptingObjectFuncs}}
-|examples=
+|examples= Assigns a value for the heading and pitch of the unit.
+    local unit = Unit.getByName('Bob')
+    local unitpos = unit:getPosition()
+    local Heading = math.atan2(unitpos.x.z, unitpos.x.x)
+    local Pitch = math.asin(unitpos.x.y)
 |notes=
 }}
 [[Category:Class Functions|getPosition]]
+[[Category:Game Patch 1.2.0|getPosition]]