locationPosition: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
(Fix return value)
 
(35 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma1 |Game name=
|game1= arma1
|version1= 1.08


|1.08|Game version=
|game2= arma2
|version2= 1.00


|arg= |Multiplayer Arguments=
|game3= arma2oa
|version3= 1.50


|eff= |Multiplayer Effects=
|game4= tkoh
|version4= 1.00


|gr1= Locations |GROUP1=
|game5= arma3
____________________________________________________________________________________________
|version5= 0.50


| Returns the [[Position|position]] of a location. If the location is attached to an object, that object's position is returned. |DESCRIPTION=
|gr1= Locations
____________________________________________________________________________________________


| '''locationPosition''' location |SYNTAX=
|descr= Returns the [[Position|position]] of a location. If the location is attached to an object, that object's position is returned.


|p1= location: [[Location]] |PARAMETER1=
|s1= [[locationPosition]] location


| [[Array]] - format [x,y,z], where z is <tt>-1 * [[getTerrainHeightASL]]</tt> at the location |RETURNVALUE=
|p1= location: [[Location]]
____________________________________________________________________________________________
 
|x1= <code>_locationPos = [[locationPosition]] myLocation;</code> |EXAMPLE1=


|x2= <code>_location = [[nearestLocation]] [<nowiki/>[[getPos]] [[player]], "nameCity"];
|r1= [[Array]] format [[Position#PositionAGL|PositionAGL]] - as locations are placed at Z = zero [[Position#PositionASL|ASL]] the returned Z is negative on land and around zero on water, see {{Link|#Example 3}}
_locationPos = [[locationPosition]] _location;</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[setPosition]], [[createLocation]], [[nearestLocation]], [[nearestLocations]], [[position]], [[size]] |SEEALSO=
|x1= <sqf>_locationPos = locationPosition myLocation;</sqf>


}}
|x2= <sqf>
_location = nearestLocation [getPos player, "nameCity"];
_locationPos = locationPosition _location;
</sqf>


<h3 style="display:none">Notes</h3>
|x3= <sqf>
<dl class="command_description">
private _landLocation = locationPosition nearestLocation [[2915.2, 6164.52], "NameCityCapital"]; // "Agia Marina" [2915.2, 6164.52, -21.9009]
<!-- Note Section BEGIN -->
private _waterLocation = locationPosition nearestLocation [[2647.8799, 5989.9502], "NameMarine"]; // "Marina Bay" [2647.88, 5989.95, 0.0161484]
</sqf>


<!-- Note Section END -->
|seealso= [[setPosition]] [[createLocation]] [[nearestLocation]] [[nearestLocations]] [[position]] [[size]]
</dl>
}}
 
<h3 style="display:none">Bottom Section</h3>
 
 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 22:25, 11 April 2023

Logo A1 black.png1.08Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Returns the position of a location. If the location is attached to an object, that object's position is returned.
Groups:
Locations

Syntax

Syntax:
locationPosition location
Parameters:
location: Location
Return Value:
Array format PositionAGL - as locations are placed at Z = zero ASL the returned Z is negative on land and around zero on water, see Example 3

Examples

Example 1:
_locationPos = locationPosition myLocation;
Example 2:
_location = nearestLocation [getPos player, "nameCity"]; _locationPos = locationPosition _location;
Example 3:
private _landLocation = locationPosition nearestLocation [[2915.2, 6164.52], "NameCityCapital"]; // "Agia Marina" [2915.2, 6164.52, -21.9009] private _waterLocation = locationPosition nearestLocation [[2647.8799, 5989.9502], "NameMarine"]; // "Marina Bay" [2647.88, 5989.95, 0.0161484]

Additional Information

See also:
setPosition createLocation nearestLocation nearestLocations position size

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
Retrieved from "https://community.bistudio.com/wiki?title=locationPosition&oldid=338856"