locationPosition: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|x([0-9]) *= * <code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
(Fix return value)
 
Line 24: Line 24:
|p1= location: [[Location]]
|p1= location: [[Location]]


|r1= [[Array]] - format [x,y,z], where z is {{hl|-1 * [[getTerrainHeightASL]]}} at the location
|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}}


|x1= <sqf>_locationPos = locationPosition myLocation;</sqf>
|x1= <sqf>_locationPos = locationPosition myLocation;</sqf>


|x2= <sqf>_location = nearestLocation [getPos player, "nameCity"];
|x2= <sqf>
_locationPos = locationPosition _location;</sqf>
_location = nearestLocation [getPos player, "nameCity"];
_locationPos = locationPosition _location;
</sqf>
 
|x3= <sqf>
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]
</sqf>


|seealso= [[setPosition]] [[createLocation]] [[nearestLocation]] [[nearestLocations]] [[position]] [[size]]
|seealso= [[setPosition]] [[createLocation]] [[nearestLocation]] [[nearestLocations]] [[position]] [[size]]
}}
}}

Latest revision as of 23:25, 11 April 2023

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