BIS fnc locationDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1 = Map and Markers |GROUP1=
|gr1 = Map and Markers


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


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


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


| [[String]] |RETURNVALUE=
| [[String]]


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


| [[BIS_fnc_position]], [[cameraOn]], [[getPos]], [[getPosATL]], [[getPosASL]], [[getPosASLW]] |SEEALSO=
| [[BIS_fnc_position]], [[cameraOn]], [[getPos]], [[getPosATL]], [[getPosASL]], [[getPosASLW]]
}}
}}



Revision as of 00:09, 18 January 2021

Hover & click on the images for description

Description

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

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_positioncameraOngetPosgetPosATLgetPosASLgetPosASLW

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

Bottom Section