BIS fnc ORBATAnimate: Difference between revisions

Latest revision as of 18:27, 8 November 2023

1.00

Hover & click on the images for description

Description

Description:: Animates an ORBAT viewer.
Execution:: call
Groups:: Strategic

Syntax

Syntax:

[target, zoom, duration] spawn BIS_fnc_ORBATAnimate

Parameters:

target: Config or Array - path to group in CfgORBAT or offset position from structure center in format [X, Y].

When empty, view is reset to original level where whole structure is visible

zoom: Number - zoom in range from 0 (max. zoom) to 1 (min. zoom)

duration: Number - commit time in seconds

Return Value:

Boolean - true when animation is applied

Examples

Example 1:: [configFile >> "CfgORBAT" >> "BIS" >> "B_1_A_1", 0.5, 3] spawn BIS_fnc_ORBATAnimate;

Additional Information

See also:: ORBAT Viewer BIS_fnc_ORBATAddGroupOverlay BIS_fnc_ORBATConfigPreview BIS_fnc_ORBATGetGroupParams BIS_fnc_ORBATOpen BIS_fnc_ORBATRemoveGroupOverlay BIS_fnc_ORBATSetGroupFade BIS_fnc_ORBATSetGroupParams BIS_fnc_ORBATTooltip

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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= Strategic
-|1.00|= Game version
+|descr= Animates an ORBAT viewer.
-____________________________________________________________________________________________
-| <pre>/*
+|s1= [target, zoom, duration] spawn [[BIS_fnc_ORBATAnimate]]
-	Description:
+|p1= target: [[Config]] or [[Array]] - path to group in CfgORBAT or offset position from structure center in format '''[X, Y]'''.
-	Animate an ORBAT viewer.
+* When empty, view is reset to original level where whole structure is visible
+|p2= zoom: [[Number]] - zoom in range from 0 (max. zoom) to 1 (min. zoom)
+|p3= duration: [[Number]] - commit time in seconds
-	Parameter(s):
+|r1= [[Boolean]] - [[true]] when animation is applied
-: (Optional) CONFIG or ARRAY - either config path to target group, or offset position [X,Y] from structure center.
-						When empty, view is reset to original level where whole structure is visible.
-: (Optional): NUMBER - zoom in range 0 (maximum zoom) to 1 (minimum zoom).
-: (Optional): NUMBER - commit time in seconds
-	Returns:
+|x1= <sqf>[configFile >> "CfgORBAT" >> "BIS" >> "B_1_A_1", 0.5, 3] spawn BIS_fnc_ORBATAnimate;</sqf>
-	BOOL - true when animation is applied
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_ORBATAnimate]]; --> |= Syntax
-|p1= |= Parameter 1
-| |= Return value
-____________________________________________________________________________________________
-|x1= <code></code> |=
-____________________________________________________________________________________________
-| |= See also
+|seealso= [[ORBAT Viewer]] [[BIS_fnc_ORBATAddGroupOverlay]] [[BIS_fnc_ORBATConfigPreview]] [[BIS_fnc_ORBATGetGroupParams]] [[BIS_fnc_ORBATOpen]] [[BIS_fnc_ORBATRemoveGroupOverlay]] [[BIS_fnc_ORBATSetGroupFade]] [[BIS_fnc_ORBATSetGroupParams]] [[BIS_fnc_ORBATTooltip]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Strategic|{{uc:ORBATAnimate}}]]
-[[Category:Functions|{{uc:ORBATAnimate}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:ORBATAnimate}}]]