getPosASL: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(59 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= ofpe
|version1= 1.00


|1.00|= Game version
|game2= arma1
|version2= 1.00


|arg= global |Multiplayer Arguments=
|game3= arma2
____________________________________________________________________________________________
|version3= 1.00


| Returns the object position height above sea level. |DESCRIPTION=
|game4= arma2oa
____________________________________________________________________________________________
|version4= 1.50


| [[Array]] <nowiki>=</nowiki> '''getPosASL''' object |SYNTAX=
|game5= tkoh
|version5= 1.00


|p1= object: [[Object]] |PARAMETER1=
|game6= arma3
|version6= 0.50


| [[Array]] - format [[PositionASL]] |RETURNVALUE=
|game7= ofp
____________________________________________________________________________________________
|version7= 1.99
 
|x1= <code>_AslPos = [[getPosASL]] [[player]];</code> |EXAMPLE1=
|x2= <code>[[hint]] [[format]] ["position above sea level: %1", ([[getPosASL]] [[player]]) [[select]] 2];</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[getPosASLVisual]], [[setPosASL]], [[setPosASL2]], [[position]], [[getPos]], [[getPosATL]], [[getPosASLW]], [[visiblePosition]], [[visiblePositionASL]], [[getTerrainHeightASL]] |SEEALSO=
|arg= global


}}
|gr1= Positions
 
|descr= Returns the object position height above sea level.
 
|s1= [[getPosASL]] object


<h3 style="display:none">Notes</h3>
|p1= object: [[Object]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on 23 Feb, 2007
|r1= [[Array]] format [[Position#PositionASL|PositionASL]]
<dt class="note">'''[[User:Dr_Eyeball|Dr_Eyeball]]'''<dd class="note">
<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'''.


<dd class="notedate">Posted on 27 Mar, 2014
|x1= <sqf>_aslPos = getPosASL player;</sqf>
<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]].
Conversion keep this speed ratio and is structured like: <code>[[ASLtoATL]] [[getPosASL]] [[Object]];</code>


<!-- Note Section END -->
|x2= <sqf>hint format ["position above sea level: %1", (getPosASL player) select 2];</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[getPosASLVisual]] [[setPosASL]] [[setPosASL2]] [[position]] [[getPos]] [[getPosATL]] [[getPosASLW]] [[visiblePosition]] [[visiblePositionASL]] [[getTerrainHeightASL]] [[setUnitFreefallHeight]]
[[Category:Scripting Commands|GETPOSASL]]
}}
[[Category:Scripting Commands OFP 1.99|GETPOSASL]]
[[Category:Scripting Commands OFP Elite |GETPOSASL]]
[[Category:Scripting Commands ArmA|GETPOSASL]]
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= Dr Eyeball
<dd class="notedate">Posted on June 1, 2018 - 09:36 (UTC)</dd>
|timestamp= 20070223073800
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
|text= <sqf inline>getPosASL _obj select 2;</sqf> 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.
<dd class="note">
The same problem exists for [[getPos]]. There was a {{Link|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. {{Name|arma1|short}} Ver '''1.02'''.
Further to Florians post, getPosASL is indeed faster than position and getpos, but is no faster that getposATL
}}
</dd>
 
</dl>
{{Note
<!-- DISCONTINUE Notes -->
|user= SilentKiller
|timestamp= 20140327191900
|text= According to [[Code_Optimisation#getPos.2A_and_setPos.2A|Code Optimisation]], this command is among the fastest (2x) and should be used (or [[getPosATL]] or, best performance-wise, [[getPosWorld]]) instead of [[getPos]]/[[position]].
}}

Latest revision as of 19:40, 7 April 2024

Hover & click on the images for description

Description

Description:
Returns the object position height above sea level.
Groups:
Positions

Syntax

Syntax:
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:
getPosASLVisual setPosASL setPosASL2 position getPos getPosATL getPosASLW visiblePosition visiblePositionASL getTerrainHeightASL setUnitFreefallHeight

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
Dr Eyeball - c
Posted on Feb 23, 2007 - 07:38 (UTC)
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 (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.
SilentKiller - c
Posted on Mar 27, 2014 - 19:19 (UTC)
According to Code Optimisation, this command is among the fastest (2x) and should be used (or getPosATL or, best performance-wise, getPosWorld) instead of getPos/position.