BIS fnc eventTimeline: Difference between revisions

Revision as of 18:12, 27 February 2021

Hover & click on the images for description

Description:: Universal system for playing sequential events defined by time.
ⓘ
codeInterrupt and codeEnd are called while the code in the timeline is spawned.
Execution:: spawn
Groups:: Timeline Systems

Syntax:: [timeline, index, music, codeInterrupt, codeEnd] call BIS_fnc_eventTimeline
Parameters:: timeline: Array - Timeline in format [ [1.0, {code} ], [2.0, {code} ], [2.3, {code} ], [4.7, {code} ] ]
: index: Number - (Optional, default 0) Index of the event to play
: music: String - (Optional, default "") Music to be played which will provide the sync time for the timeline
: codeInterrupt: Code - (Optional, default
params ["_pointer", "_baseTime", "_evenTime"];
["Timeline interrupted while playing event nr.: %1 (%2)", _pointer, _baseTime + _eventTime] call BIS_fnc_logFormat;)
Code to be executed if the timeline is interrupted with missionNamespace setVariable ["BIS_fnc_eventTimeline_playing", false]
: codeEnd: Array or Code - (Optional, default nil) Code or Array of codes to be executed once the timeline is finished. The codes are called one after the other.
Return Value:: Nothing

Example 1:: private _timeline = [ [0.0, { hint "Start of the Timeline" } ], [1.0, { hint "Event 1" } ], [3.0, { hint "End of the timeline" } ] ]; [_timeline, 0, "", {hint "Interrupted"}, {hint "Timeline done"}] spawn BIS_fnc_eventTimeline;

: 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 22: / Line 22: @@
 |p4= codeInterrupt: [[Code]] - (Optional, default<br>
-{{Inline code|[[params]] ["_pointer", "_baseTime", "_evenTime"];}}<br>
+{{ic|[[params]] ["_pointer", "_baseTime", "_evenTime"];}}<br>
-{{Inline code|["Timeline interrupted while playing event nr.: %1 (%2)", _pointer, _baseTime + _eventTime] [[call]] [[BIS_fnc_logFormat]];}})<br>Code to be executed if the timeline is interrupted with
+{{ic|["Timeline interrupted while playing event nr.: %1 (%2)", _pointer, _baseTime + _eventTime] [[call]] [[BIS_fnc_logFormat]];}})<br>Code to be executed if the timeline is interrupted with
-{{Inline code|[[missionNamespace]] [[setVariable]] ["BIS_fnc_eventTimeline_playing", [[false]]]}}
+{{ic|[[missionNamespace]] [[setVariable]] ["BIS_fnc_eventTimeline_playing", [[false]]]}}
 |p5= codeEnd: [[Array]] or [[Code]] - (Optional, default [[nil]]) [[Code]] or [[Array]] of codes to be executed once the timeline is finished. The codes are [[call]]ed one after the other.