BIS fnc ORBATAnimate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\|= " to " ")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1 = Strategic |GROUP1=
|gr1 = Strategic


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


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


|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|PARAMETER1=
* 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)|PARAMETER2=
|p2= zoom: [[Number]] - Zoom in range from 0 (max. zoom) to 1 (min. zoom)
|p3= duration: [[Number]] - Commit time in seconds|PARAMETER3=
|p3= duration: [[Number]] - Commit time in seconds


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


|x1= <code>[ [[configFile]] >> "CfgORBAT" >> "BIS" >> "B_1_A_1", 0.5, 3 ] [[spawn]] [[BIS_fnc_ORBATAnimate]];</code>
|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]] |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]]
}}
}}



Revision as of 23:19, 17 January 2021

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


Bottom Section