ctrlMapAnimAdd: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added note on use of position other than position2d)
(Note about map scale limits not always being 0.001 to 1)
(73 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= arma1
|version1= 1.00


|1.00|= Game version
|game2= arma2
____________________________________________________________________________________________
|version2= 1.00


| Adds the next frame to the map animation. The format of frame is [time, zoom, position], the format of position is [[Position2D]]. |= Description
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| map '''ctrlMapAnimAdd''' frame |= Syntax
|game4= tkoh
|version4= 1.00


|p1= map: [[Control]] |= Parameter 1
|game5= arma3
|version5= 0.50


|p2= frame: [[Array]] |= Parameter 2
|arg= local


| [[Nothing]] |= Return value
|eff= local
____________________________________________________________________________________________
 
|x1= <pre>_map ctrlMapAnimAdd [1, 0.1, getMarkerPos "anim1"]</pre> |= Example 1
____________________________________________________________________________________________


| |= See also
|gr1= GUI Control - Map


}}
|descr= Adds the next frame to the map animation.
 
|pr= When used on a [[CT_MAP]] that was created dynamically the target position could be offset. Use [[ctrlMapSetPosition]] before adding animation (Example 3).
 
|s1= map [[ctrlMapAnimAdd]]  [time, zoom, position]
 
|p1= map: [[Control]] - [[CT_MAP]] control
 
|p2= time: [[Number]] - duration of the animation in seconds
 
|p3= zoom: [[Number]] - zoom in range from 0.001 (max) to 1 (min). Custom map scales can be set in map control's config. See also [[ctrlMapScale]]
 
|p4= position: [[Array]] or [[Object]] - formats: [[Position#Introduction|Position2D]], [[Position#Introduction|Position3D]], [[Object]]
 
|r1= [[Nothing]]
 
|x1= <sqf>_map ctrlMapAnimAdd [1, 0.1, getMarkerPos "anim1"];
ctrlMapAnimCommit _map;</sqf>


<h3 style="display:none">Notes</h3>
|x2= Center map on player:
<dl class="command_description">
<sqf>
<!-- Note Section BEGIN -->
_ctrl ctrlMapAnimAdd [0, 0.05, player];
<dt class="note">'''[[User:Besselinksjm|besselinksjm]]'''</dt>
ctrlMapAnimCommit _ctrl;
<dd class="note">At least in VBS2 1.3 it is not necessary to use Position2D. Besides [[Position2D]], both [[Object]]s and [[Position3D]] work.</dd>
</sqf>
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
|x3= <sqf>
_map ctrlMapSetPosition [];
_map ctrlMapAnimAdd [1, 0.1, getMarkerPos "anim1"];
ctrlMapAnimCommit _map;
</sqf>


[[Category:Scripting Commands|CTRLMAPANIMADD]]
|seealso= [[ctrlMapSetPosition]] [[mapAnimAdd]] [[mapAnimClear]] [[mapAnimCommit]] [[mapAnimDone]] [[ctrlMapAnimClear]] [[ctrlMapAnimCommit]] [[ctrlMapAnimDone]]
[[Category:Scripting Commands ArmA|CTRLMAPANIMADD]]
}}
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands VBS2|{{uc:{{PAGENAME}}}}]]

Revision as of 11:56, 19 December 2023

Hover & click on the images for description

Description

Description:
Adds the next frame to the map animation.
Problems:
When used on a CT_MAP that was created dynamically the target position could be offset. Use ctrlMapSetPosition before adding animation (Example 3).
Groups:
GUI Control - Map

Syntax

Syntax:
map ctrlMapAnimAdd [time, zoom, position]
Parameters:
map: Control - CT_MAP control
time: Number - duration of the animation in seconds
zoom: Number - zoom in range from 0.001 (max) to 1 (min). Custom map scales can be set in map control's config. See also ctrlMapScale
position: Array or Object - formats: Position2D, Position3D, Object
Return Value:
Nothing

Examples

Example 1:
_map ctrlMapAnimAdd [1, 0.1, getMarkerPos "anim1"]; ctrlMapAnimCommit _map;
Example 2:
Center map on player:
_ctrl ctrlMapAnimAdd [0, 0.05, player]; ctrlMapAnimCommit _ctrl;
Example 3:
_map ctrlMapSetPosition []; _map ctrlMapAnimAdd [1, 0.1, getMarkerPos "anim1"]; ctrlMapAnimCommit _map;

Additional Information

See also:
ctrlMapSetPosition mapAnimAdd mapAnimClear mapAnimCommit mapAnimDone 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