BIS fnc locationDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:Function Group: [a-zA-Z0-9_: ]+(\|\{\{[a-zA-Z0-9_: ]+\}\})?\]\]" to " ")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 7: Line 6:


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


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


| position call [[BIS_fnc_locationDescription]] |SYNTAX=
| position call [[BIS_fnc_locationDescription]] |SYNTAX=
Line 17: Line 14:


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


|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> |EXAMPLE1=
____________________________________________________________________________________________


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

Revision as of 00:30, 17 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

Notes

Bottom Section