BIS fnc mapGridSize: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(24 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.92


|1.92|= Game version
|gr1= Map and Markers
____________________________________________________________________________________________


| Returns the size of map grid square at current zoom level.<br><br>
|descr= Returns the size of map grid square at current zoom level.
{{Informative | This function caches config lookup result on the first use and for the duration of the mission, making subsequent access 2-3 times faster.}} |DESCRIPTION=
{{Feature|informative|This function caches config lookup result on the first use and for the duration of the mission, making subsequent access 2-3 times faster.}}
____________________________________________________________________________________________


| [map] call [[BIS_fnc_mapGridSize]] |SYNTAX=
|s1= [map] call [[BIS_fnc_mapGridSize]]


| p1= [map]: [[Array]]|= Parameter 1
|p1= map: [[Control]] - (Optional, default main mission map ([[findDisplay]] 12 [[displayCtrl]] 51)) map control
| p2= map (Optional): [[Control]] - map control. Default: main mission map ([[findDisplay]] 12 [[displayCtrl]] 51) |= Parameter 3


| [[Number]] - map grid size |RETURNVALUE=
|r1= [[Number]] - map grid size
____________________________________________________________________________________________


|x1= <code>_gridSize = [] [[call]] [[BIS_fnc_mapGridSize]];</code> |= Example 1
|x1= <sqf>private _gridSize = [] call BIS_fnc_mapGridSize;</sqf>


 
|seealso= [[BIS_fnc_mapSize]]
____________________________________________________________________________________________
 
| [[BIS_fnc_mapSize]] |SEEALSO=
}}
}}
<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:mapGridSize}}]]
[[Category:Functions|{{uc:mapGridSize}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:mapGridSize}}]]

Latest revision as of 19:13, 3 May 2022

Hover & click on the images for description

Description

Description:
Returns the size of map grid square at current zoom level.
This function caches config lookup result on the first use and for the duration of the mission, making subsequent access 2-3 times faster.
Execution:
call
Groups:
Map and Markers

Syntax

Syntax:
[map] call BIS_fnc_mapGridSize
Parameters:
map: Control - (Optional, default main mission map (findDisplay 12 displayCtrl 51)) map control
Return Value:
Number - map grid size

Examples

Example 1:
private _gridSize = [] call BIS_fnc_mapGridSize;

Additional Information

See also:
BIS_fnc_mapSize

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