BIS fnc locationDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
(added Positions group)
 
(38 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Map and Markers
|gr2= Positions


|1.00|= Game version
|descr= Return location description (e.g. "NE of Agia Marina")
____________________________________________________________________________________________


| <pre>/*
|s1= position call [[BIS_fnc_locationDescription]]


Description:
|p1= position: [[Position]] - (Optional, default <sqf inline>cameraOn call BIS_fnc_position</sqf>)
Return location description (e.g. "east of Kavala)


Parameter(s):
|r1= [[String]]
0: See BIS_fnc_position


Returns:
|x1= <sqf>hint format ["Player's position: %1", player call BIS_fnc_locationDescription];</sqf>
STRING
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_locationDescription]]; --> |= Syntax
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[BIS_fnc_position]] [[cameraOn]] [[getPos]] [[getPosATL]] [[getPosASL]] [[getPosASLW]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Map|{{uc:locationDescription}}]]
[[Category:Functions|{{uc:locationDescription}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:locationDescription}}]]

Latest revision as of 10:39, 1 August 2022

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Return location description (e.g. "NE of Agia Marina")
Execution:
call
Groups:
Map and MarkersPositions

Syntax

Syntax:
position call BIS_fnc_locationDescription
Parameters:
position: Position - (Optional, default cameraOn call BIS_fnc_position)
Return Value:
String

Examples

Example 1:
hint format ["Player's position: %1", player call BIS_fnc_locationDescription];

Additional Information

See also:
BIS_fnc_position cameraOn getPos getPosATL getPosASL getPosASLW

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=BIS_fnc_locationDescription&oldid=329682"