DCS func getPosition

From DCS World Wiki - Hoggitworld.com
Revision as of 23:56, 20 March 2022 by Grimes (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Scripting Root

Envrioment: Mission Scripting
Function: getPosition Added with: 1.2.0
Member Of: Object, Spot
Syntax: vec3 Object.getPosition(Class Self )
Description: 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.

Function also works with Unit, Weapon, Static Object, Scenery Object, Airbase

Return Value: vec3
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