BIS fnc mapAnimAdd: 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 - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


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


|arg= local |Multiplayer Arguments=
|arg= local |Multiplayer Arguments=
Line 11: Line 11:
|eff= local |Multiplayer Effects=
|eff= local |Multiplayer Effects=


| Similar to [[mapAnimAdd]], yet it provides additional parameters to allow for a non-linear zoom and various position interpolation modes. |Description=
| 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=
|[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=
|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)
|p3= toPosition: [[Position]] - (Optional, default [0, 0, 0]) the position vector|Parameter 3=
|p3= toPosition: [[Position]] - (Optional, default [0, 0, 0]) the position vector
|p4= interpModeZoom: [[Number]] - (Optional, default 12) the interpolation mode for the zoom|Parameter 4=
|p4= interpModeZoom: [[Number]] - (Optional, default 12) the interpolation mode for the zoom
|p5= interpModePosition: [[Number]] - (Optional, default 12) the interpolation mode for the position|Parameter 5=
|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)|Parameter 6=
|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: [[Position]] - (Optional, default current map position) the position vector to start the animation from|Parameter 7=
|p7= fromPosition: [[Position]] - (Optional, default current map position) the position vector to start the animation from


|[[Nothing]]|Return value=
|[[Nothing]]


|x1= <code>[[openMap]] [[true]]; {{codecomment|// The function won't work if the map is not open}}
|x1= <code>[[openMap]] [[true]]; {{codecomment|// The function won't work if the map is not open}}
[2.0, 0.05, [[getPos]] [[player]]] [[call]] BIS_fnc_mapAnimAdd;</code>|Example 1=
[2.0, 0.05, [[getPos]] [[player]]] [[call]] BIS_fnc_mapAnimAdd;</code>


|exec= call |Execution=
|exec= call |Execution=


| [[BIS_fnc_mapAnimClear]], [[BIS_fnc_mapAnimDone]], [[mapAnimAdd]], [[mapAnimClear]], [[mapAnimCommit]], [[mapAnimDone]], [[ctrlMapAnimAdd]], [[ctrlMapAnimClear]], [[ctrlMapAnimCommit]], [[ctrlMapAnimDone]]|See also=
| [[BIS_fnc_mapAnimClear]], [[BIS_fnc_mapAnimDone]], [[mapAnimAdd]], [[mapAnimClear]], [[mapAnimCommit]], [[mapAnimDone]], [[ctrlMapAnimAdd]], [[ctrlMapAnimClear]], [[ctrlMapAnimCommit]], [[ctrlMapAnimDone]]
}}
}}



Revision as of 23:08, 17 January 2021

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: Position - (Optional, default current map position) the position vector to start the animation from
Return Value:
Nothing

Examples

Example 1:
openMap true; // The function won't work if the map is not open [2.0, 0.05, getPos player] call BIS_fnc_mapAnimAdd;

Additional Information

See also:
BIS_fnc_mapAnimClearBIS_fnc_mapAnimDonemapAnimAddmapAnimClearmapAnimCommitmapAnimDonectrlMapAnimAddctrlMapAnimClearctrlMapAnimCommitctrlMapAnimDone

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