ctrlMapAnimAdd: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (add note date)
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(67 intermediate revisions by 7 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


|arg= local |= Arguments in MP
|game3= arma2oa
|version3= 1.50


|eff= local |= Effects in MP
|game4= tkoh
____________________________________________________________________________________________
|version4= 1.00


| Adds the next frame to the map animation. |= Description
|game5= arma3
____________________________________________________________________________________________
|version5= 0.50


| map '''ctrlMapAnimAdd''' [time, zoom, position] |= Syntax
|arg= local


|p1= map: [[Control]] |= Parameter 1
|eff= local
|p2= [time, zoom, position]: [[Array]] |= Parameter 2
|p3= time: [[Number]] |= Parameter 3
|p4= zoom: [[Number]] |= Parameter 4
|p5= position: [[Array]] or [[Object]] - formats: [[Position2D]], [[Position3D]], [[Object]] |= Parameter 5


| [[Nothing]] |= Return value
|gr1= GUI Control - Map
____________________________________________________________________________________________
 
|x1= <code>_map [[ctrlMapAnimAdd]] [1, 0.1, [[getMarkerPos]] "anim1"];
[[ctrlMapAnimCommit]] _map;</code> |= Example 1


|x2= Centre map on player: <code>_ctrl [[ctrlMapAnimAdd]] [0, 0.05, [[player]]];
|descr= Adds the next frame to the map animation.
[[ctrlMapAnimCommit]] _ctrl;</code> |= Example 2
____________________________________________________________________________________________


| [[mapAnimAdd]], [[mapAnimClear]], [[mapAnimCommit]], [[mapAnimDone]], [[ctrlMapAnimClear]], [[ctrlMapAnimCommit]],  [[ctrlMapAnimDone]] |= See also
|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];
<dd class="notedate">Posted on 17:11, 9 March 2010</dd>
ctrlMapAnimCommit _ctrl;
<dt class="note">'''[[User:Besselinksjm|besselinksjm]]'''
</sqf>
<dd class="note">Besides [[Position2D]], both [[Object]]s and [[Position3D]] work.
<!-- 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 Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:35, 3 September 2024

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