BIS fnc ORBATAnimate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (page filling)
m (template:command argument fix)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Animates an ORBAT viewer.|= Description
| Animates an ORBAT viewer.|DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [target, zoom, duration] spawn [[BIS_fnc_ORBATAnimate]] |= Syntax
| [target, zoom, duration] spawn [[BIS_fnc_ORBATAnimate]] |SYNTAX=


|p1= target: [[Config]] or [[Array]] - Path to group in CfgORBAT or offset position from structure center in format '''[X, Y]'''.
|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
* When empty, view is reset to original level where whole structure is visible|PARAMETER1=
|p2= zoom: [[Number]] - Zoom in range from 0 (max. zoom) to 1 (min. zoom)|= Parameter 2
|p2= zoom: [[Number]] - Zoom in range from 0 (max. zoom) to 1 (min. zoom)|PARAMETER2=
|p3= duration: [[Number]] - Commit time in seconds|= Parameter 3
|p3= duration: [[Number]] - Commit time in seconds|PARAMETER3=


| [[Boolean]] - [[true|True]] when animation is applied|= Return value
| [[Boolean]] - [[true|True]] when animation is applied|RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 23: Line 23:
______________
______________


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



Revision as of 15:32, 7 April 2019

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