getPos: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(format)
mNo edit summary
(19 intermediate revisions by 5 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=
 
|gr1= Positions |=GROUP1
____________________________________________________________________________________________
 
| 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]]. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns the object position in format [[Position]]. Z value is height over the surface underneath. |= Description
| [[getPos]] object |SYNTAX=
 
|p1 = object: [[Object]]|PARAMETER1=
 
| [[Array]] - format [[PositionAGLS]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''getPos''' object |= Syntax
|s2= [[getPos]] location |SYNTAX2=
|p1 = object: [[Object]] or [[Location]]
 
| [[Array]] - format [[Position]] |= Return value
|p21= location: [[Location]] |PARAMETER21=
 
|r2= [[Array]] - format [x,y,z], where z is <tt>-1 * [[getTerrainHeightASL]]</tt> at the location |RETURNVALUE2=
____________________________________________________________________________________________
____________________________________________________________________________________________
|x1 = <code>[[hintSilent]] [[str]] [[getPos]] [[player]];</code> |= Example1
 
|s3= origin [[getPos]] [distance, heading] {{since|arma3|1.55.133361|y}} |SYNTAX3=
 
|p41= origin: [[Object]], [[Position2D]] or [[Position3D]] |PARAMETER41=
 
|p42=  distance: [[Number]] - distance from position |PARAMETER43=
 
|p43=  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=


|x2 = [[getPos]] vs. other methods (over sea)
|x2 = [[getPos]] vs. other methods (over sea)
<code>[[diag_log]] [[getPos]] ship;           // [2412.01, 6036.33, -0.839965]
<code>[[diag_log]] [[getPos]] ship; // [2412.01, 6036.33, -0.839965]
[[diag_log]] [[getPosATL]] ship;         // [2412.01, 6036.33, 19.4266]
[[diag_log]] [[getPosATL]] ship; // [2412.01, 6036.33, 19.4266]
[[diag_log]] [[getPosASL]] ship;         // [2412.01, 6036.33, -0.920066]
[[diag_log]] [[getPosASL]] ship; // [2412.01, 6036.33, -0.920066]
[[diag_log]] [[getPosASLW]] ship;         // [2412.01, 6036.33, -0.865981]
[[diag_log]] [[getPosASLW]] ship; // [2412.01, 6036.33, -0.865981]
[[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)
<code>[[diag_log]] [[getPos]] car;             // [2508.64, 5681.47, 0.0609589]
<code>[[diag_log]] [[getPos]] car; // [2508.64, 5681.47, 0.0609589]
[[diag_log]] [[getPosATL]] car;           // [2508.64, 5681.47, 0.0356369]
[[diag_log]] [[getPosATL]] car; // [2508.64, 5681.47, 0.0356369]
[[diag_log]] [[getPosASL]] car;           // [2508.64, 5681.47, 71.718]
[[diag_log]] [[getPosASL]] car; // [2508.64, 5681.47, 71.718]
[[diag_log]] [[getPosASLW]] 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]] [[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=


| [[getPosVisual]], [[setPos]], [[position]], [[getPosATL]], [[getPosASL]], [[getPosASLW]], [[visiblePosition]], [[visiblePositionASL]], [[getMarkerPos]] |= See also
|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]] |SEEALSO=
}}
}}


Line 43: Line 67:
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on 16 Feb, 2007
<dd class="notedate">Posted on 16 Feb, 2007</dd>
<dt class="note">'''[[User:Dr_Eyeball|Dr_Eyeball]]'''<dd class="note">
<dt class="note">[[User:Dr_Eyeball|Dr_Eyeball]]</dt>
getPos obj select 2  
<dd class="note">
<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 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'''.
</dd>


<dd class="notedate">Posted on 14 Dec, 2010
<dd class="notedate">Posted on 23 Nov, 2011</dd>
<dt class="note">'''[[User:disat|disat]]'''<dd class="note">
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
This command returns a [[PositionAGL]].  Apparently, [[Position]] and [[PositionAGL]] are the same thing.
<dd class="note">
 
You can use [[getPos]] and [[setPos]] on triggers.  
<dd class="notedate">Posted on 6 Feb, 2011
</dd>
<dt class="note">'''[[User:Hduregger|Hduregger]]'''<dd class="note">
The z height returned changes dynamically with the height of waves beneath the object, if the object is located over sea. The z height returned by [[getPosATL]] and [[getPosASL]] does not change like this. This was tested by continuously retrieving the position of a static object, like the cross in the empty/corpses category, placed over sea or land.
[[getPos]] behaves similar to
_obj modelToWorld [0.0, 0.0, 0.0]
but it does not give the same result, therefore
(_obj modelToWorld [0.0, 0.0, 0.0]) is not the same as (getPos _obj).
 
<dd class="notedate">Posted on 23 Nov, 2011
<dt class="note">'''[[User:Tankbuster|Tankbuster]]'''<dd class="note">
You can use getPos and setPos on triggers.


<!-- Note Section END -->
<!-- Note Section END -->
Line 68: Line 84:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|GETPOS]]
[[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 OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|GETPOS]]
[[Category:Scripting Commands Armed Assault|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.46|GETPOS]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|GETPOS]]
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Revision as of 09:34, 16 September 2020

Logo A0.png1.00
GAGlobal
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 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

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

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

Retrieved from "https://community.bistudio.com/wiki?title=getPos&oldid=157580"