Difference between revisions of "getPos"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<dl class="command_description"> <dd class="notedate">" to "<dl class="command_description"> <dt></dt> <dd class="notedate">")
m (Some wiki formatting)
Line 1: Line 1:
 
{{RV|type=command
 
{{RV|type=command
  
| ofp
+
|game1= ofp
 +
|version1= 1.00
  
|1.00
+
|game2= ofpe
 +
|version2= 1.00
 +
 
 +
|game3= arma1
 +
|version3= 1.00
 +
 
 +
|game4= arma2
 +
|version4= 1.00
 +
 
 +
|game5= arma2oa
 +
|version5= 1.50
 +
 
 +
|game6= tkoh
 +
|version6= 1.00
 +
 
 +
|game7= arma3
 +
|version7= 0.50
  
 
|arg= global
 
|arg= global
Line 9: Line 26:
 
|gr1= Positions
 
|gr1= Positions
  
| 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.<br>
+
|descr= 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.<br>
 
The alternative syntax gets the position given distance and heading away from provided object or position - the equivalent of [[BIS_fnc_relPos]].
 
The alternative syntax gets the position given distance and heading away from provided object or position - the equivalent of [[BIS_fnc_relPos]].
  
| [[getPos]] object
+
|s1= [[getPos]] object
  
 
|p1 = object: [[Object]]
 
|p1 = object: [[Object]]
  
| [[Array]] - format [[PositionAGLS]]
+
|r1= [[Array]] - format [[PositionAGLS]]
  
 
|s2= [[getPos]] location
 
|s2= [[getPos]] location
Line 32: Line 49:
 
|p43=  heading: [[Number]] - in which compass direction
 
|p43=  heading: [[Number]] - in which compass direction
  
| r3= [[Array]] - format [x,y,z], where z is land surface position in format [[PositionAGL]]
+
|r3= [[Array]] - format [x,y,z], where z is land surface position in format [[PositionAGL]]
|x1 = <code>[[hintSilent]] [[str]] [[getPos]] [[player]];</code>
 
  
|x2 = [[getPos]] vs. other methods (over sea)
+
|x1= <code>[[hintSilent]] [[str]] [[getPos]] [[player]];</code>
<code>[[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]</code>
 
  
|x3 = [[getPos]] vs. other methods (over land)
+
|x2= [[getPos]] vs. other methods (over sea)
<code>[[diag_log]] [[getPos]] car; // [2508.64, 5681.47, 0.0609589]
+
<code>[[getPos]] ship; {{cc|[2412.01, 6036.33, -0.839965]}}
[[diag_log]] [[getPosATL]] car; // [2508.64, 5681.47, 0.0356369]
+
[[getPosATL]] ship; {{cc|[2412.01, 6036.33, 19.4266]}}
[[diag_log]] [[getPosASL]] car; // [2508.64, 5681.47, 71.718]
+
[[getPosASL]] ship; {{cc|[2412.01, 6036.33, -0.920066]}}
[[diag_log]] [[getPosASLW]] car; // [2508.64, 5681.47, 71.718]
+
[[getPosASLW]] ship; {{cc|[2412.01, 6036.33, -0.865981]}}
[[diag_log]] [[visiblePosition]] car; // [2508.64, 5681.47, 0.0609512]
+
[[visiblePosition]] ship; {{cc|[2412.02, 6036.33, -0.837952]}}
[[diag_log]] [[visiblePositionASL]] car; // [2508.64, 5681.47, 71.718]
+
[[visiblePositionASL]] ship; {{cc|[2412.02, 6036.33, -0.91798]}}
[[diag_log]] [[position]] car; // [2508.64, 5681.47, 0.0609589]</code>
+
[[position]] ship; {{cc|[2412.01, 6036.33, -0.839965]}}</code>
  
|x4 = Find position 100 metres and 45 degrees from player position:<code>[[player]] [[getPos]] [100, 45];</code>
+
|x3= [[getPos]] vs. other methods (over land)
 +
<code>[[getPos]] car; {{cc|[2508.64, 5681.47, 0.0609589]}}
 +
[[getPosATL]] car; {{cc|[2508.64, 5681.47, 0.0356369]}}
 +
[[getPosASL]] car; {{cc|[2508.64, 5681.47, 71.718]}}
 +
[[getPosASLW]] car; {{cc|[2508.64, 5681.47, 71.718]}}
 +
[[visiblePosition]] car; {{cc|[2508.64, 5681.47, 0.0609512]}}
 +
[[visiblePositionASL]] car; {{cc|[2508.64, 5681.47, 71.718]}}
 +
[[position]] car; {{cc|[2508.64, 5681.47, 0.0609589]}}</code>
  
| [[getPosVisual]], [[getRelPos]], [[setPos]], [[Position#setPosAGLS|setPosAGLS]], [[position]], [[getPosATL]], [[getPosASL]], [[getPosASLW]], [[visiblePosition]], [[visiblePositionASL]], [[getMarkerPos]]
+
|x4= Find position 100 metres and 45 degrees from player position:<code>[[player]] [[getPos]] [100, 45];</code>
 +
 
 +
|seealso= [[getPosVisual]], [[getRelPos]], [[setPos]], [[Position#setPosAGLS|setPosAGLS]], [[position]], [[getPosATL]], [[getPosASL]], [[getPosASLW]], [[visiblePosition]], [[visiblePositionASL]], [[getMarkerPos]]
 
}}
 
}}
  
Line 63: Line 81:
 
<dt class="note">[[User:Dr_Eyeball|Dr_Eyeball]]</dt>
 
<dt class="note">[[User:Dr_Eyeball|Dr_Eyeball]]</dt>
 
<dd class="note">
 
<dd class="note">
<code>[[getPos]] obj [[select]] 2 </code>
+
<code>[[getPos]] obj [[select]] 2</code>
 
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 {{ExternalLink|link= http://www.flashpoint1985.com/cgi-bin/ikonboard311/ikonboard.cgi?s=e587356595b907e91f96b8817d7f8a26;act=ST;f=71;t=57918|text= 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'''.
 
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 {{ExternalLink|link= http://www.flashpoint1985.com/cgi-bin/ikonboard311/ikonboard.cgi?s=e587356595b907e91f96b8817d7f8a26;act=ST;f=71;t=57918|text= 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'''.
 
</dd>
 
</dd>
 +
 
<dt><dt>
 
<dt><dt>
 
<dd class="notedate">Posted on 23 Nov, 2011</dd>
 
<dd class="notedate">Posted on 23 Nov, 2011</dd>
Line 72: Line 91:
 
You can use [[getPos]] and [[setPos]] on triggers.  
 
You can use [[getPos]] and [[setPos]] on triggers.  
 
</dd>
 
</dd>
 
 
</dl>
 
</dl>
 
{{GameCategory|arma1|Scripting Commands}}
 
{{GameCategory|arma2|Scripting Commands}}
 
{{GameCategory|arma3|Scripting Commands}}
 
{{GameCategory|tkoh|Scripting Commands}}
 

Revision as of 21:46, 5 June 2021

Hover & click on the images for description

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.
The alternative syntax gets the position given distance and heading away from provided object or position - the equivalent of BIS_fnc_relPos.
Groups:
Positions

Syntax 1

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

Syntax 2

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

Syntax 3

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

Examples

Example 1:
hintSilent str getPos player;
Example 2:
getPos vs. other methods (over sea) getPos ship; // [2412.01, 6036.33, -0.839965] getPosATL ship; // [2412.01, 6036.33, 19.4266] getPosASL ship; // [2412.01, 6036.33, -0.920066] getPosASLW ship; // [2412.01, 6036.33, -0.865981] visiblePosition ship; // [2412.02, 6036.33, -0.837952] visiblePositionASL ship; // [2412.02, 6036.33, -0.91798] position ship; // [2412.01, 6036.33, -0.839965]
Example 3:
getPos vs. other methods (over land) getPos car; // [2508.64, 5681.47, 0.0609589] getPosATL car; // [2508.64, 5681.47, 0.0356369] getPosASL car; // [2508.64, 5681.47, 71.718] getPosASLW car; // [2508.64, 5681.47, 71.718] visiblePosition car; // [2508.64, 5681.47, 0.0609512] visiblePositionASL car; // [2508.64, 5681.47, 71.718] 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

See also:
getPosVisualgetRelPossetPossetPosAGLSpositiongetPosATLgetPosASLgetPosASLWvisiblePositionvisiblePositionASLgetMarkerPos

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
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 (dead link) 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.