BIS fnc locationDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Page filling)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Return location description (e.g. "NE of Agia Marina") |= Description
 
Description:
Return location description (e.g. "east of Kavala)
 
Parameter(s):
0: See BIS_fnc_position
 
Returns:
STRING
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_locationDescription]]; --> |= Syntax
| position call [[BIS_fnc_locationDescription]] |= Syntax


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


| |= Return value
| [[String]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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



Revision as of 18:06, 8 May 2018

Hover & click on the images for description

Description

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

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