Difference between revisions of "getPos"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|=GROUP1" to "|GROUP1=")
m
 
(38 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|Comments=
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| ofp |Game name=
+
|game1= ofp
 +
|version1= 1.00
  
|1.00|Game version=
+
|game2= ofpe
 +
|version2= 1.00
  
|arg= global |Multiplayer Arguments=
+
|game3= arma1
 +
|version3= 1.00
  
|gr1= Positions |GROUP1=
+
|game4= arma2
____________________________________________________________________________________________
+
|version4= 1.00
  
| 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>
+
|game5= arma2oa
The alternative syntax gets the position given distance and heading away from provided object or position - the equivalent of [[BIS_fnc_relPos]]. |DESCRIPTION=
+
|version5= 1.50
____________________________________________________________________________________________
 
  
| [[getPos]] object |SYNTAX=
+
|game6= tkoh
 +
|version6= 1.00
  
|p1 = object: [[Object]]|PARAMETER1=
+
|game7= arma3
 +
|version7= 0.50
  
| [[Array]] - format [[PositionAGLS]] |RETURNVALUE=
+
|arg= global
____________________________________________________________________________________________
 
  
|s2= [[getPos]] location |SYNTAX2=
+
|gr1= Positions
  
|p21= location: [[Location]] |PARAMETER21=
+
|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]].
 +
{{Feature | Important | Do not use this command to get an object's position in 3D format, as the Z value from this command is '''relative''' to the surface underneath, and there is no compatible setter command to use it with. Therefore the commonly misused code: {{ic|_obj1 [[setPos]] [[getPos]] _obj2}} is '''absolutely wrong'''.}}
 +
{{Feature | Informative | The only '''correct''' use case for this command is to determine the placement height of an object. For example, to determine if a free-falling unit is close enough to the surface (including buildings) to deploy the parachute:
 +
<code>[[waitUntil]] {([[getPos]] _parachute) [[select]] 2 [[a_less_b|<]] 200}; {{cc|deploy the parachute now!}}</code>}}
 +
{{Feature | Important | This command is significantly '''slower''' than other position commands, because it has to calculate the surface below a position. See [[Code_Optimisation#getPos.2A_and_setPos.2A|this page]] for more details.}}
 +
|s1= [[getPos]] object
  
|r2= [[Array]] - format [x,y,z], where z is <tt>-1 * [[getTerrainHeightASL]]</tt> at the location |RETURNVALUE2=
+
|p1= object: [[Object]]
____________________________________________________________________________________________
 
  
|s3= origin [[getPos]] [distance, heading] {{since|arma3|1.55.133361|y}} |SYNTAX3=
+
|r1= [[Array]] - format [[PositionAGLS]]
  
|p41= origin: [[Object]], [[Position2D]] or [[Position3D]] |PARAMETER41=
+
|s2= [[getPos]] location
  
|p42= distance: [[Number]] - distance from position |PARAMETER43=
+
|p21= location: [[Location]]
  
|p43= heading: [[Number]] - in which compass direction |PARAMETER44=
+
|r2= [[Array]] - format [x,y,z], where z is <tt>-1 * [[getTerrainHeightASL]]</tt> at the location
  
| r3= [[Array]] - format [x,y,z], where z is land surface in format [[PositionAGL]] |RETURNVALUE3=
+
|s3= origin [[getPos]] [distance, heading]
____________________________________________________________________________________________
 
|x1 = <code>[[hintSilent]] [[str]] [[getPos]] [[player]];</code> |EXAMPLE1=
 
  
|x2 = [[getPos]] vs. other methods (over sea)
+
|s3since= arma3 1.56
<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> |EXAMPLE2=
 
  
|x3 = [[getPos]] vs. other methods (over land)
+
|p41= origin: [[Object]], [[Position2D]] or [[Position3D]]
<code>[[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]</code> |EXAMPLE3=
 
  
|x4 = Find position 100 metres and 45 degrees from player position:<code>[[player]] [[getPos]] [100, 45];</code> |EXAMPLE4=
+
|p42= distance: [[Number]] - distance from position
  
| [[getPosVisual]], [[getRelPos]], [[setPos]], [[Position#setPosAGLS|setPosAGLS]], [[position]], [[getPosATL]], [[getPosASL]], [[getPosASLW]], [[visiblePosition]], [[visiblePositionASL]], [[getMarkerPos]] |SEEALSO=
+
|p43= heading: [[Number]] - in which compass direction
 +
 
 +
|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). Pay attention to Z values:
 +
<code>[[getPos]] ship; {{cc|[2412.01, 6036.33, -0.839965]}}
 +
[[getPosATL]] ship; {{cc|[2412.01, 6036.33, 19.4266]}}
 +
[[getPosASL]] ship; {{cc|[2412.01, 6036.33, -0.920066]}}
 +
[[getPosASLW]] ship; {{cc|[2412.01, 6036.33, -0.865981]}}
 +
[[visiblePosition]] ship; {{cc|[2412.02, 6036.33, -0.837952]}}
 +
[[visiblePositionASL]] ship; {{cc|[2412.02, 6036.33, -0.91798]}}
 +
[[position]] ship; {{cc|[2412.01, 6036.33, -0.839965]}}</code>
 +
 
 +
|x3= [[getPos]] vs. other methods (over land, on top of a 100m high building). Pay attention to Z values:
 +
<code>[[getPos]] car; {{cc|[2508.64, 5681.47, 0.0609589]}}
 +
[[getPosATL]] car; {{cc|[2508.64, 5681.47, 100.0356369]}}
 +
[[getPosASL]] car; {{cc|[2508.64, 5681.47, 171.718]}}
 +
[[getPosASLW]] car; {{cc|[2508.64, 5681.47, 171.718]}}
 +
[[visiblePosition]] car; {{cc|[2508.64, 5681.47, 0.0609512]}}
 +
[[visiblePositionASL]] car; {{cc|[2508.64, 5681.47, 171.718]}}
 +
[[position]] car; {{cc|[2508.64, 5681.47, 0.0609589]}}</code>
 +
 
 +
|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]]
 
}}
 
}}
  
<h3 style="display:none">Notes</h3>
 
 
<dl class="command_description">
 
<dl class="command_description">
<!-- Note Section BEGIN -->
+
 
 +
<dt></dt>
 
<dd class="notedate">Posted on 16 Feb, 2007</dd>
 
<dd class="notedate">Posted on 16 Feb, 2007</dd>
 
<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 [http://www.flashpoint1985.com/cgi-bin/ikonboard311/ikonboard.cgi?s=e587356595b907e91f96b8817d7f8a26;act=ST;f=71;t=57918 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 existed for [[getPosASL]] ('''pre-Arma 2 games only'''). 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>
 
<dd class="notedate">Posted on 23 Nov, 2011</dd>
 
<dd class="notedate">Posted on 23 Nov, 2011</dd>
 
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
 
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
Line 80: Line 98:
 
</dd>
 
</dd>
  
<!-- Note Section END -->
 
 
</dl>
 
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Armed Assault|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 13:23, 11 August 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.
Do not use this command to get an object's position in 3D format, as the Z value from this command is relative to the surface underneath, and there is no compatible setter command to use it with. Therefore the commonly misused code: _obj1 setPos getPos _obj2 is absolutely wrong.
The only correct use case for this command is to determine the placement height of an object. For example, to determine if a free-falling unit is close enough to the surface (including buildings) to deploy the parachute: waitUntil {(getPos _parachute) select 2 < 200}; // deploy the parachute now!
This command is significantly slower than other position commands, because it has to calculate the surface below a position. See this page for more details.
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]
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). Pay attention to Z values: 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, on top of a 100m high building). Pay attention to Z values: getPos car; // [2508.64, 5681.47, 0.0609589] getPosATL car; // [2508.64, 5681.47, 100.0356369] getPosASL car; // [2508.64, 5681.47, 171.718] getPosASLW car; // [2508.64, 5681.47, 171.718] visiblePosition car; // [2508.64, 5681.47, 0.0609512] visiblePositionASL car; // [2508.64, 5681.47, 171.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 existed for getPosASL (pre-Arma 2 games only). 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.