ctrlMapAnimAdd: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]2(\|.*)\]\]" to "{{GameCategory|arma2|Scripting Commands}}")
(Note about map scale limits not always being 0.001 to 1)
 
(42 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


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


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


|arg= local |Multiplayer Arguments=
|game3= arma2oa
|version3= 1.50


|eff= local |Multiplayer Effects=
|game4= tkoh
|version4= 1.00


|gr1= GUI Control - Map |GROUP1=
|game5= arma3
____________________________________________________________________________________________
|version5= 0.50


| Adds the next frame to the map animation. |DESCRIPTION=
|arg= local
____________________________________________________________________________________________


| map '''ctrlMapAnimAdd''' [time, zoom, position] |SYNTAX=
|eff= local


|p1= map: [[Control]] |PARAMETER1=
|gr1= GUI Control - Map
|p2= [time, zoom, position]: [[Array]] |PARAMETER2=
|p3= time: [[Number]] |PARAMETER3=
|p4= zoom: [[Number]] |PARAMETER4=
|p5= position: [[Array]] or [[Object]] - formats: [[Position2D]], [[Position3D]], [[Object]] |PARAMETER5=


| [[Nothing]] |RETURNVALUE=
|descr= Adds the next frame to the map animation.
____________________________________________________________________________________________
 
|x1= <code>_map [[ctrlMapAnimAdd]] [1, 0.1, [[getMarkerPos]] "anim1"];
[[ctrlMapAnimCommit]] _map;</code> |EXAMPLE1=


|x2= Center map on player: <code>_ctrl [[ctrlMapAnimAdd]] [0, 0.05, [[player]]];
|pr= When used on a [[CT_MAP]] that was created dynamically the target position could be offset. Use [[ctrlMapSetPosition]] before adding animation (Example 3).
[[ctrlMapAnimCommit]] _ctrl;</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[mapAnimAdd]], [[mapAnimClear]], [[mapAnimCommit]], [[mapAnimDone]], [[ctrlMapAnimClear]], [[ctrlMapAnimCommit]], [[ctrlMapAnimDone]] |SEEALSO=
|s1= map [[ctrlMapAnimAdd]] [time, zoom, position]


}}
|p1= map: [[Control]] - [[CT_MAP]] control
<h3 style="display:none">Notes</h3>
 
<dl class="command_description">
|p2= time: [[Number]] - duration of the animation in seconds
<!-- Note Section BEGIN -->
 
<dd class="notedate">Posted on 03:48, 27 August 2017</dd>
|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]]
<dt class="note">[[User:Demellion|Demellion]]
 
<dd class="note">Map control created with [[ctrlCreate]] have a weird behaviour. Control doesn't respect the aspects of Controls Group or Display itself. Results of '''ctrlMapAnimAdd''' applied to this control are also shifted for some reason.
|p4= position: [[Array]] or [[Object]] - formats: [[Position#Introduction|Position2D]], [[Position#Introduction|Position3D]], [[Object]]
<!-- Note Section END -->
 
</dl>
|r1= [[Nothing]]
 
|x1= <sqf>_map ctrlMapAnimAdd [1, 0.1, getMarkerPos "anim1"];
ctrlMapAnimCommit _map;</sqf>
 
|x2= Center map on player:
<sqf>
_ctrl ctrlMapAnimAdd [0, 0.05, player];
ctrlMapAnimCommit _ctrl;
</sqf>


<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]]
{{GameCategory|arma1|Scripting Commands}}
}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Latest 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