BIS fnc ORBATAnimate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (page filling)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Animates an ORBAT viewer.|= Description
 
Description:
Animate an ORBAT viewer.
 
Parameter(s):
0: (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.
1: (Optional): NUMBER - zoom in range 0 (maximum zoom) to 1 (minimum zoom).
2: (Optional): NUMBER - commit time in seconds
 
Returns:
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
| [target, zoom, duration] spawn [[BIS_fnc_ORBATAnimate]] |= Syntax


|p1= |= Parameter 1
|p1= 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|= Parameter 1
| |= Return value
|p2= zoom: [[Number]] - Zoom in range from 0 (max. zoom) to 1 (min. zoom)|= Parameter 2
____________________________________________________________________________________________
|p3= duration: [[Number]] - Commit time in seconds|= Parameter 3


|x1= <code></code> |=  
| [[Boolean]] - [[true|True]] when animation is applied|= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
|x1= <code>[ [[configFile]] >> "CfgORBAT" >> "BIS" >> "B_1_A_1", 0.5, 3 ] [[spawn]] [[BIS_fnc_ORBATAnimate]];</code> |=
______________


| [[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]] |= See also
}}
}}


Revision as of 02:13, 27 May 2018

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

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

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 ViewerBIS_fnc_ORBATAddGroupOverlayBIS_fnc_ORBATConfigPreviewBIS_fnc_ORBATGetGroupParamsBIS_fnc_ORBATOpenBIS_fnc_ORBATRemoveGroupOverlayBIS_fnc_ORBATSetGroupFadeBIS_fnc_ORBATSetGroupParamsBIS_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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_ORBATAnimate&oldid=107552"