BIS fnc locationDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Comments" to "|Comments=")
(added Positions group)
 
(33 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.00


|1.00|= Game version
|gr1= Map and Markers
____________________________________________________________________________________________
|gr2= Positions


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


| position call [[BIS_fnc_locationDescription]] |SYNTAX=
|s1= position call [[BIS_fnc_locationDescription]]


|p1= position: [[Position]] - (Optional, default {{Inline code|[[cameraOn]] [[call]] [[BIS_fnc_position]]}}) |PARAMETER1=
|p1= position: [[Position]] - (Optional, default <sqf inline>cameraOn call BIS_fnc_position</sqf>)


| [[String]] |RETURNVALUE=
|r1= [[String]]
____________________________________________________________________________________________


|x1= <code>[[hint]] [[format]] ["Player's position: %1", [[player]] [[call]] [[BIS_fnc_locationDescription]]];</code> |EXAMPLE1=
|x1= <sqf>hint format ["Player's position: %1", player call BIS_fnc_locationDescription];</sqf>
____________________________________________________________________________________________


| [[BIS_fnc_position]], [[cameraOn]], [[getPos]], [[getPosATL]], [[getPosASL]], [[getPosASLW]] |SEEALSO=
|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 11: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"