Difference between revisions of "getPosASL"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Not sure about this change. Technically, it was introduced in Arma I, and then backported to OFP 1.99.)
m (Text replacement - "|=GROUP1" to "|GROUP1=")
 
(14 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{Command|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| ofp |= Game name
+
| arma |Game name=
  
|1.99|= Game version
+
|1.00|Game version=
  
|arg= global |= Arguments in MP
+
|game2= ofp |Game2 name=
 +
 
 +
|version2= 1.99 |Game2 version=
 +
 
 +
|arg= global |Multiplayer Arguments=
 +
 
 +
|gr1= Positions |GROUP1=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Returns the object position height above sea level. |= Description
+
| Returns the object position height above sea level. |DESCRIPTION=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[Array]] <nowiki>=</nowiki> '''getPosASL''' object |= Syntax
+
| [[Array]] <nowiki>=</nowiki> '''getPosASL''' object |SYNTAX=
  
|p1= object: [[Object]] |= Parameter 1
+
|p1= object: [[Object]] |PARAMETER1=
  
| [[Array]] - format [[PositionASL]] |= Return value
+
| [[Array]] - format [[PositionASL]] |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
   
 
   
|x1= <code>_AslPos = [[getPosASL]] [[player]];</code> |= Example 1
+
|x1= <code>_AslPos = [[getPosASL]] [[player]];</code> |EXAMPLE1=
|x2= <code>[[hint]] [[format]] ["position above sea level: %1", ([[getPosASL]] [[player]]) [[select]] 2];</code> |= Example 2
+
 
 +
|x2= <code>[[hint]] [[format]] ["position above sea level: %1", ([[getPosASL]] [[player]]) [[select]] 2];</code> |EXAMPLE2=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[setPosASL]], [[setPosASL2]], [[position]], [[getPos]], [[getPosATL]], [[getPosASLW]], [[visiblePosition]], [[visiblePositionASL]], [[getTerrainHeightASL]] |= See also
+
| [[getPosASLVisual]], [[setPosASL]], [[setPosASL2]], [[position]], [[getPos]], [[getPosATL]], [[getPosASLW]], [[visiblePosition]], [[visiblePositionASL]], [[getTerrainHeightASL]] |SEEALSO=
 
 
 
}}
 
}}
  
Line 32: Line 38:
  
 
<dd class="notedate">Posted on 23 Feb, 2007
 
<dd class="notedate">Posted on 23 Feb, 2007
<dt class="note">'''[[User:Dr_Eyeball|Dr_Eyeball]]'''<dd class="note">
+
<dt class="note">[[User:Dr_Eyeball|Dr_Eyeball]]
 +
<dd class="note">
 
<code>[[getPosASL]] _obj [[select]] 2;</code>  
 
<code>[[getPosASL]] _obj [[select]] 2;</code>  
 
might sometimes return the vertical position above sea level, but over land for stacked objects, it returns the vertical position above the object beneath it or at least affected by this offset. The same problem exists for [[getPos]]. 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 sometimes return the vertical position above sea level, but over land for stacked objects, it returns the vertical position above the object beneath it or at least affected by this offset. The same problem exists for [[getPos]]. 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 class="notedate">Posted on 27 Mar, 2014
 
<dd class="notedate">Posted on 27 Mar, 2014
<dt class="note">'''[[User:Floriangeyer|Floriangeyer]]'''<dd class="note">
+
<dt class="note">[[User:Floriangeyer|Floriangeyer]]
 +
<dd class="note">
 
According to [[Code Optimisation]], this function is the fastest (2x) and should be used instead of [[getPos]], [[getPosATL]] and [[position]].
 
According to [[Code Optimisation]], this function is the fastest (2x) and should be used instead of [[getPos]], [[getPosATL]] and [[position]].
 
Conversion keep this speed ratio and is structured like: <code>[[ASLtoATL]] [[getPosASL]] [[Object]];</code>
 
Conversion keep this speed ratio and is structured like: <code>[[ASLtoATL]] [[getPosASL]] [[Object]];</code>
Line 45: Line 53:
  
 
<h3 style="display:none">Bottom Section</h3>
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|GETPOSASL]]
+
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|GETPOSASL]]
+
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP Elite |GETPOSASL]]
+
[[Category:Scripting Commands OFP Elite |{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|GETPOSASL]]
+
[[Category:Scripting Commands Armed Assault|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
+
[[Category:Scripting Commands Arma 2|{{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}}}}]]
 +
 
 +
<!-- CONTINUE Notes -->
 +
<dl class="command_description">
 +
<dd class="notedate">Posted on June 1, 2018 - 09:36 (UTC)</dd>
 +
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
 +
<dd class="note">
 +
Further to Florians post, getPosASL is indeed faster than position and getpos, but is no faster that getposATL
 +
</dd>
 +
</dl>
 +
<!-- DISCONTINUE Notes -->

Latest revision as of 17:00, 26 September 2020

Introduced with Armed Assault version 1.001.00Introduced with Operation Flashpoint version 1.991.99Arguments of this scripting command don't have to be local to the client the command is executed on
Hover & click on the images for descriptions

Description

Description:
Returns the object position height above sea level.

Syntax

Syntax:
Array = getPosASL object
Parameters:
object: Object
Return Value:
Array - format PositionASL

Examples

Example 1:
_AslPos = getPosASL player;
Example 2:
hint format ["position above sea level: %1", (getPosASL player) select 2];

Additional Information

See also:
getPosASLVisualsetPosASLsetPosASL2positiongetPosgetPosATLgetPosASLWvisiblePositionvisiblePositionASLgetTerrainHeightASL
Groups:
Positions

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

Notes

Posted on 23 Feb, 2007
Dr_Eyeball
getPosASL _obj select 2; might sometimes return the vertical position above sea level, but over land for stacked objects, it returns the vertical position above the object beneath it or at least affected by this offset. The same problem exists for getPos. 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 27 Mar, 2014
Floriangeyer
According to Code Optimisation, this function is the fastest (2x) and should be used instead of getPos, getPosATL and position. Conversion keep this speed ratio and is structured like: ASLtoATL getPosASL Object;

Bottom Section

Posted on June 1, 2018 - 09:36 (UTC)
Tankbuster
Further to Florians post, getPosASL is indeed faster than position and getpos, but is no faster that getposATL