BIS fnc ORBATAnimate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "- True" to "- true")
m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2")
 
(16 intermediate revisions by the same user not shown)
Line 8: Line 8:
|descr= Animates an ORBAT viewer.
|descr= Animates an ORBAT viewer.


|s1=[target, zoom, duration] spawn [[BIS_fnc_ORBATAnimate]]
|s1= [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
* 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)
|p2= zoom: [[Number]] - zoom in range from 0 (max. zoom) to 1 (min. zoom)
|p3= duration: [[Number]] - Commit time in seconds
|p3= duration: [[Number]] - commit time in seconds


|r1= [[Boolean]] - [[true]] when animation is applied
|r1= [[Boolean]] - [[true]] when animation is applied


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


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

Latest revision as of 17:27, 8 November 2023

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