Difference between revisions of "getPos"

From Bohemia Interactive Community
Jump to navigation Jump to search
(PositionAGLS adequately describes this)
(alt syntax)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{Command|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| ofp |= Game name
+
| ofp |Game name=
  
|1.00|= Game version
+
|1.00|Game version=
  
|arg= global |= Arguments in MP
+
|arg= global |Multiplayer Arguments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Returns the object position in format [[PositionAGLS]]. Z value is height over the surface underneath. <br><br>
+
| Returns object or location position. If the argument is the object, the return value is in format [[PositionAGLS]]. Z value is height over the surface underneath. Since Arma 3 v1.55.133361, an alternative syntax is added that allows to get position given distance and heading away from original object or position, the equivalent of [[BIS_fnc_relPos]]|DESCRIPTION=
Since Arma 3 v1.55.133361, an alternative syntax is added that allows to get position given distance and heading away from original object or position, the equivalent of [[BIS_fnc_relPos]]|= Description
 
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| '''getPos''' object |= Syntax
+
| '''getPos''' object |SYNTAX=
|p1 = object: [[Object]] or [[Location]]|=
+
|p1 = object: [[Object]]|PARAMETER1=
| [[Array]] - format [[PositionAGLS]] |= Return value
+
| [[Array]] - format [[PositionAGLS]] |RETURNVALUE=
  
| s2= origin '''getPos''' [distance, heading] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; (''Since Arma 3 v1.55.133361'') |= Syntax
+
| s2= '''getPos''' location |SYNTAX2=
|p21 = origin: [[Object]], [[Position2D]] or [[Position3D]]|=
 
|p22 =  [distance, heading]: [[Array]]|=
 
|p23 =  distance: [[Number]] - distance from position|=
 
|p24 =  heading: [[Number]] - in which compass direction |=
 
  
| r2= [[Array]] - format [x,y,z], where z is land surface in format [[PositionAGL]] |= Return value
+
|p21= location: [[Location]] |PARAMETER21=
 +
 
 +
| r2= [[Array]] - format [x,y,z], where z is <tt>-1 * [[getTerrainHeightASL]]</tt> at the location |RETURNVALUE2=
 +
 
 +
| s3= origin '''getPos''' [distance, heading] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; (''Since Arma 3 v1.55.133361'') |SYNTAX3=
 +
|p41 = origin: [[Object]], [[Position2D]] or [[Position3D]]|PARAMETER41=
 +
|p42 =  [distance, heading]: [[Array]]|PARAMETER42=
 +
|p43 =  distance: [[Number]] - distance from position|PARAMETER43=
 +
|p44 =  heading: [[Number]] - in which compass direction |PARAMETER44=
 +
 
 +
| r3= [[Array]] - format [x,y,z], where z is land surface in format [[PositionAGL]] |RETURNVALUE3=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
|x1 = <code>[[hintSilent]] [[str]] [[getPos]] [[player]];</code> |= Example1
+
|x1 = <code>[[hintSilent]] [[str]] [[getPos]] [[player]];</code> |EXAMPLE1=
  
 
|x2 = [[getPos]] vs. other methods (over sea)
 
|x2 = [[getPos]] vs. other methods (over sea)
Line 34: Line 39:
 
[[diag_log]] [[visiblePosition]] ship;    // [2412.02, 6036.33, -0.837952]
 
[[diag_log]] [[visiblePosition]] ship;    // [2412.02, 6036.33, -0.837952]
 
[[diag_log]] [[visiblePositionASL]] ship; // [2412.02, 6036.33, -0.91798]
 
[[diag_log]] [[visiblePositionASL]] ship; // [2412.02, 6036.33, -0.91798]
[[diag_log]] [[position]] ship;          // [2412.01, 6036.33, -0.839965]</code> |= Example2
+
[[diag_log]] [[position]] ship;          // [2412.01, 6036.33, -0.839965]</code> |EXAMPLE2=  
  
 
|x3 = [[getPos]] vs. other methods (over land)
 
|x3 = [[getPos]] vs. other methods (over land)
Line 43: Line 48:
 
[[diag_log]] [[visiblePosition]] car;    // [2508.64, 5681.47, 0.0609512]
 
[[diag_log]] [[visiblePosition]] car;    // [2508.64, 5681.47, 0.0609512]
 
[[diag_log]] [[visiblePositionASL]] car;  // [2508.64, 5681.47, 71.718]
 
[[diag_log]] [[visiblePositionASL]] car;  // [2508.64, 5681.47, 71.718]
[[diag_log]] [[position]] car;            // [2508.64, 5681.47, 0.0609589]</code> |= Example3
+
[[diag_log]] [[position]] car;            // [2508.64, 5681.47, 0.0609589]</code> |EXAMPLE3=
  
|x4 = Find position 100 metres and 45 degrees from player position:<code>[[player]] [[getPos]] [100,45];</code> |= Example4
+
|x4 = Find position 100 metres and 45 degrees from player position:<code>[[player]] [[getPos]] [100,45];</code> |EXAMPLE4=
  
| [[getPosVisual]], [[getRelPos]], [[setPos]], [[Position#setPosAGLS|setPosAGLS]], [[position]], [[getPosATL]], [[getPosASL]], [[getPosASLW]], [[visiblePosition]], [[visiblePositionASL]], [[getMarkerPos]]  |= See also
+
| [[getPosVisual]], [[getRelPos]], [[setPos]], [[Position#setPosAGLS|setPosAGLS]], [[position]], [[getPosATL]], [[getPosASL]], [[getPosASLW]], [[visiblePosition]], [[visiblePositionASL]], [[getMarkerPos]]  |SEEALSO=
  
 
}}
 
}}

Latest revision as of 16:18, 17 November 2019

Introduced with Operation Flashpoint version 1.00
  Arguments of this scripting command don't have to be local to the client the command is executed on

Click on the images for descriptions

Introduced in

Game:
Operation Flashpoint
Version:
1.00

Description

Description:
Returns object or location position. If the argument is the object, the return value is in format PositionAGLS. Z value is height over the surface underneath. Since Arma 3 v1.55.133361, an alternative syntax is added that allows to get position given distance and heading away from original object or position, the equivalent of BIS_fnc_relPos

Syntax

Syntax:
getPos object
Parameters:
object: Object
Return Value:
Array - format PositionAGLS

Alternative Syntax

Syntax:
getPos location
Parameters:
location: Location
Return Value:
Array - format [x,y,z], where z is -1 * getTerrainHeightASL at the location

Alternative Syntax 2

Syntax:
origin getPos [distance, heading]         (Since Arma 3 v1.55.133361)
Parameters:
origin: Object, Position2D or Position3D
[distance, heading]: Array
distance: Number - distance from position
heading: Number - in which compass direction
Return Value:
Array - format [x,y,z], where z is land surface in format PositionAGL

Examples

Example 1:
hintSilent str getPos player;
Example 2:
getPos vs. other methods (over sea) diag_log getPos ship; // [2412.01, 6036.33, -0.839965] diag_log getPosATL ship; // [2412.01, 6036.33, 19.4266] diag_log getPosASL ship; // [2412.01, 6036.33, -0.920066] diag_log getPosASLW ship; // [2412.01, 6036.33, -0.865981] diag_log visiblePosition ship; // [2412.02, 6036.33, -0.837952] diag_log visiblePositionASL ship; // [2412.02, 6036.33, -0.91798] diag_log position ship; // [2412.01, 6036.33, -0.839965]
Example 3:
getPos vs. other methods (over land) diag_log getPos car; // [2508.64, 5681.47, 0.0609589] diag_log getPosATL car; // [2508.64, 5681.47, 0.0356369] diag_log getPosASL car; // [2508.64, 5681.47, 71.718] diag_log getPosASLW car; // [2508.64, 5681.47, 71.718] diag_log visiblePosition car; // [2508.64, 5681.47, 0.0609512] diag_log visiblePositionASL car; // [2508.64, 5681.47, 71.718] diag_log position car; // [2508.64, 5681.47, 0.0609589]
Example 4:
Find position 100 metres and 45 degrees from player position:player getPos [100,45];

Additional Information

Multiplayer:
-
See also:
getPosVisualgetRelPossetPossetPosAGLSpositiongetPosATLgetPosASLgetPosASLWvisiblePositionvisiblePositionASLgetMarkerPos

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Posted on 16 Feb, 2007
Dr_Eyeball
getPos obj select 2 might return the vertical position above ground level, but for a stacked object, it returns the vertical position above the object beneath it. The same problem exists for getPosASL. There was a discussion thread in the BIS forums which suggested the use of the command modelToWorld instead to get around this issue where an absolute vertical position is required. ArmA Ver 1.02.
Posted on 23 Nov, 2011
Tankbuster
You can use getPos and setPos on triggers.

Bottom Section