BIS fnc zoomOnArea: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Function|= Comments " to "{{Function|Comments= ")
m (Some wiki formatting)
 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.78


|1.78|Game version=
|gr1= Map and Markers


<!---|arg= local |Multiplayer Arguments=--->
|descr= Map will zoom on the given area. Function always takes the longer side of the area to zoom on.


<!---|eff= local |Multiplayer Effects=--->
|s1= [area, center, time, handler, forceCam] call [[BIS_fnc_zoomOnArea]]


| <pre>/*
|p1= area: [[Array]] - area to zoom on
Author: ZoZo


Description:
|p2= center: [[Array]] - coordinates of the center
  Map will zoom on the given area. Function always takes the longer side of the area to zoom on.


Parameters:
|p3= time: [[Number]] - (Optional, default 1) time of the zoom operation
Select 0 - ARRAY: Area to zoom on
Select 1 - ARRAY: Coordinates of the center
Select 2 - (OPTIONAL) - NUMBER: time of the zoom operation. Default is 1
Select 3 - (OPTIONAL) - CONTROL: handler to the map display control (you can pass one if already exists, if not, handler is created)
Select 4 - (OPTIONAL) - BOOL: whether we have to force the camera in position after the zoom.


Returns:
|p4= handler: [[Control]] - (Optional, default [[nil]]) handler to the map display control (you can pass one if already exists, if not, handler is created)
Amount of zoom (can be used for the check if the zoom operation is already done)


Examples:
|p5= forceCam: [[Boolean]] - (Optional, default [[false]]) whether to force the camera in position after the zoom.
_xHandle = [markerSize "BIS_areaMarker", markerPos "BIS_areaMarker", 5] call BIS_fnc_zoomOnArea //zoom on the area given by the marker in 5 seconds.
_xHandle = [markerSize "BIS_areaMarker", markerPos "BIS_areaMarker"] call BIS_fnc_zoomOnArea //zoom on the area given by the marker in default 1 second.
BIS_mapDisplay = (findDisplay 12 displayCtrl 51); ... ; _xHandle = [markerSize "BIS_areaMarker", markerPos "BIS_areaMarker", 2, BIS_mapDisplay] call BIS_fnc_zoomOnArea //zoom on the area given by the marker in default 2 seconds.
*/</pre>{{placeholder}}<!-- Remove this after fill-in --> |Description=


|[] call [[BIS_fnc_zoomOnArea]]|Syntax=
|r1= [[Number]] - zoom level


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|x1= <sqf>
openMap true;
[markerSize "BIS_areaMarker", markerPos "BIS_areaMarker", 5] call BIS_fnc_zoomOnArea;
</sqf>


|Datatype - description|Return value=
|seealso= [[BIS_fnc_zoomLock]] [[BIS_fnc_zoomUnlock]]
 
|x1= <code></code>|Example 1=
 
|exec= call |Execution=
 
| |See also=
}}
}}
[[Category:Function Group: Map|{{uc:zoomOnArea}}]]
[[Category:Functions|{{uc:zoomOnArea}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:zoomOnArea}}]]

Latest revision as of 22:47, 31 May 2022

Arma 3 logo black.png1.78
Hover & click on the images for description

Description

Description:
Map will zoom on the given area. Function always takes the longer side of the area to zoom on.
Execution:
call
Groups:
Map and Markers

Syntax

Syntax:
[area, center, time, handler, forceCam] call BIS_fnc_zoomOnArea
Parameters:
area: Array - area to zoom on
center: Array - coordinates of the center
time: Number - (Optional, default 1) time of the zoom operation
handler: Control - (Optional, default nil) handler to the map display control (you can pass one if already exists, if not, handler is created)
forceCam: Boolean - (Optional, default false) whether to force the camera in position after the zoom.
Return Value:
Number - zoom level

Examples

Example 1:
openMap true; [markerSize "BIS_areaMarker", markerPos "BIS_areaMarker", 5] call BIS_fnc_zoomOnArea;

Additional Information

See also:
BIS_fnc_zoomLock BIS_fnc_zoomUnlock

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_zoomOnArea&oldid=322348"