BIS fnc mapAnimAdd: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added desc, examples, parameters, returns, see also)
m (Some wiki formatting)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.00


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


|arg= local |Multiplayer Arguments=
|arg= local


|eff= local |Multiplayer Effects=
|eff= local


| Similar to [[mapAnimAdd]], yet it provides additional parameters to allow for a non-linear zoom and various position interpolation modes. |Description=
|descr= Similar to [[mapAnimAdd]], yet it provides additional parameters to allow for a non-linear zoom and various position interpolation modes.


|[duration, toZoom, toPosition, interpModeZoom, interpModePosition, fromZoom, fromPosition] call [[BIS_fnc_mapAnimAdd]]|Syntax=
|s1= [duration, toZoom, toPosition, interpModeZoom, interpModePosition, fromZoom, fromPosition] call [[BIS_fnc_mapAnimAdd]]


|p1= duration: [[Number]] - (Optional, default 1.0) the animation duration in seconds|Parameter 1=
|p1= duration: [[Number]] - (Optional, default 1.0) the animation duration in seconds
|p2= toZoom: [[Number]] - (Optional, default 0.05) the zoom at the end of the animation, ranging from 0.01 (max. zoom) to 1 (zoomed out)|Parameter 2=
|p3= toPosition: [[Position]] - (Optional, default [0, 0, 0]) the position vector|Parameter 3=
|p4= interpModeZoom: [[Number]] - (Optional, default 12) the interpolation mode for the zoom|Parameter 4=
|p5= interpModePosition: [[Number]] - (Optional, default 12) the interpolation mode for the position|Parameter 5=
|p6= fromZoom: [[Number]] - (Optional, default current map zoom) the zoom at the begnning of the animation, ranging from 0.01 (max. zoom) to 1 (zoomed out)|Parameter 6=
|p7= fromPosition: [[Position]] - (Optional, default current map position) the position vector to start the animation from|Parameter 7=


|[[Nothing]]|Return value=
|p2= toZoom: [[Number]] - (Optional, default 0.05) the zoom at the end of the animation, ranging from 0.01 (max. zoom) to 1 (zoomed out)


|x1= <code>[[openMap]] [[true]]; {{codecomment|// The function won't work if the map is not open}}
|p3= toPosition: [[Position]] - (Optional, default [0, 0, 0]) the position vector
[2.0, 0.05, [[getPos]] [[player]]] [[call]] BIS_fnc_mapAnimAdd;</code>|Example 1=


|exec= call |Execution=
|p4= interpModeZoom: [[Number]] - (Optional, default 12) the interpolation mode for the zoom


| [[BIS_fnc_mapAnimClear]], [[BIS_fnc_mapAnimDone]], [[mapAnimAdd]], [[mapAnimClear]], [[mapAnimCommit]], [[mapAnimDone]], [[ctrlMapAnimAdd]], [[ctrlMapAnimClear]], [[ctrlMapAnimCommit]], [[ctrlMapAnimDone]]|See also=
|p5= interpModePosition: [[Number]] - (Optional, default 12) the interpolation mode for the position
 
|p6= fromZoom: [[Number]] - (Optional, default current map zoom) the zoom at the begnning of the animation, ranging from 0.01 (max. zoom) to 1 (zoomed out)
 
|p7= fromPosition: [[Array]] format [[Position]] - (Optional, default current map position) the position vector from which to start the animation
 
|r1= [[Nothing]]
 
|x1= <sqf>
openMap true; // the function will not work if the map is not open
[2.0, 0.05, getPosASL player] call BIS_fnc_mapAnimAdd;
</sqf>
 
|seealso= [[BIS_fnc_mapAnimClear]] [[BIS_fnc_mapAnimDone]] [[mapAnimAdd]] [[mapAnimClear]] [[mapAnimCommit]] [[mapAnimDone]] [[ctrlMapAnimAdd]] [[ctrlMapAnimClear]] [[ctrlMapAnimCommit]] [[ctrlMapAnimDone]]
}}
}}
[[Category:Function Group: MapAnimation|{{uc:mapAnimAdd}}]]
[[Category:Functions|{{uc:mapAnimAdd}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:mapAnimAdd}}]]

Latest revision as of 12:31, 1 July 2022

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

Description

Description:
Similar to mapAnimAdd, yet it provides additional parameters to allow for a non-linear zoom and various position interpolation modes.
Execution:
call
Groups:
Map and Markers

Syntax

Syntax:
[duration, toZoom, toPosition, interpModeZoom, interpModePosition, fromZoom, fromPosition] call BIS_fnc_mapAnimAdd
Parameters:
duration: Number - (Optional, default 1.0) the animation duration in seconds
toZoom: Number - (Optional, default 0.05) the zoom at the end of the animation, ranging from 0.01 (max. zoom) to 1 (zoomed out)
toPosition: Position - (Optional, default [0, 0, 0]) the position vector
interpModeZoom: Number - (Optional, default 12) the interpolation mode for the zoom
interpModePosition: Number - (Optional, default 12) the interpolation mode for the position
fromZoom: Number - (Optional, default current map zoom) the zoom at the begnning of the animation, ranging from 0.01 (max. zoom) to 1 (zoomed out)
fromPosition: Array format Position - (Optional, default current map position) the position vector from which to start the animation
Return Value:
Nothing

Examples

Example 1:
openMap true; // the function will not work if the map is not open [2.0, 0.05, getPosASL player] call BIS_fnc_mapAnimAdd;

Additional Information

See also:
BIS_fnc_mapAnimClear BIS_fnc_mapAnimDone mapAnimAdd mapAnimClear mapAnimCommit mapAnimDone ctrlMapAnimAdd ctrlMapAnimClear ctrlMapAnimCommit ctrlMapAnimDone

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_mapAnimAdd&oldid=323161"