BIS fnc mapAnimAdd: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\{\{ *codecomment *\| *\/\/ *([^ ]+) *\}\} " to "{{cc|$1}}") |
Lou Montana (talk | contribs) m (revert + fix) |
||
| Line 1: | Line 1: | ||
{{RV|type=function | {{RV|type=function | ||
| arma3 | |game1= arma3 | ||
|1.00 | |version1= 1.00 | ||
|gr1 = Map and Markers | |gr1= Map and Markers | ||
|arg= local | |arg= local | ||
|[duration, toZoom, toPosition, interpModeZoom, interpModePosition, fromZoom, fromPosition] call [[BIS_fnc_mapAnimAdd]] | |eff= local | ||
|descr= Similar to [[mapAnimAdd]], yet it provides additional parameters to allow for a non-linear zoom and various position interpolation modes. | |||
|s1= [duration, toZoom, toPosition, interpModeZoom, interpModePosition, fromZoom, fromPosition] call [[BIS_fnc_mapAnimAdd]] | |||
|p1= duration: [[Number]] - (Optional, default 1.0) the animation duration in seconds | |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) | |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 | |p3= toPosition: [[Position]] - (Optional, default [0, 0, 0]) the position vector | ||
|p4= interpModeZoom: [[Number]] - (Optional, default 12) the interpolation mode for the zoom | |p4= interpModeZoom: [[Number]] - (Optional, default 12) the interpolation mode for the zoom | ||
|p5= interpModePosition: [[Number]] - (Optional, default 12) the interpolation mode for the position | |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) | |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 | |p7= fromPosition: [[Position]] - (Optional, default current map position) the position vector to start the animation from | ||
|[[Nothing]] | |r1= [[Nothing]] | ||
|x1= <code>[[openMap]] [[true]]; {{cc| The function won't work if the map is not open}}[2.0, 0.05, [[getPos]] [[player]]] [[call]] BIS_fnc_mapAnimAdd;</code> | |x1= <code>[[openMap]] [[true]]; {{cc|The function won't work if the map is not open}} | ||
[2.0, 0.05, [[getPos]] [[player]]] [[call]] BIS_fnc_mapAnimAdd;</code> | |||
|exec= call| [[BIS_fnc_mapAnimClear]], [[BIS_fnc_mapAnimDone]], [[mapAnimAdd]], [[mapAnimClear]], [[mapAnimCommit]], [[mapAnimDone]], [[ctrlMapAnimAdd]], [[ctrlMapAnimClear]], [[ctrlMapAnimCommit]], [[ctrlMapAnimDone]] | |exec= call | ||
|seealso= [[BIS_fnc_mapAnimClear]], [[BIS_fnc_mapAnimDone]], [[mapAnimAdd]], [[mapAnimClear]], [[mapAnimCommit]], [[mapAnimDone]], [[ctrlMapAnimAdd]], [[ctrlMapAnimClear]], [[ctrlMapAnimCommit]], [[ctrlMapAnimDone]] | |||
}} | }} | ||
Revision as of 20:32, 29 January 2021
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