BIS_fnc_animatedBriefing

Description

Plays the Animated Briefings. Basically, it is a wrap function for the BIS_fnc_eventTimeline function.

Syntax

[timeline, indexEvent, music, markersHide, markersShow, endPosition] call BIS_fnc_animatedBriefing

Parameters:

• timeline: Array - array in format [time, code]:
  • time: Number - time the code is executed
  • code: Code - code executed when time is reached
• indexEvent: Number - index of the event to play
• music: String - (Optional, default "") CfgMusic class
• markersHide: Array - (Optional, default []) array of markers which should be hidden when briefing starts
• markersShow: Array - (Optional, default []) array of markers which should be shown when the briefing is done
• endPosition: String - (Optional, default "") marker to focus when the briefing is done
• codeEnd: Code - (Optional, default {}) code executed when briefing is done

Returns: Nothing

Examples

Example 1

// timeline of events
_timeline = [
    [0.0, { hint "Start of the Timeline" }],
    [1.0, { hint "Event 1" }],
    [3.0, { hint "End of the timeline" }]
];

// get markers to be shown at end by using the layer's name
private _showMarkers = (getMissionLayerEntities "showAtEnd") select 1;

// start the Animated Briefing at index 0
// hide all markers and show the markers from the "showAtEnd" layer after the briefing is done
// zoom on marker_rect_1 at the end of the briefing
[_timeline, 0, "", nil, allMapMarkers, _showMarkers, "marker_rect_1"] spawn BIS_fnc_animatedBriefing;

// Wait until timeline is over
waitUntil { !(missionNamespace getVariable "BIS_fnc_eventTimeline_playing"); };

See also

Arma 3: Animated Briefing · BIS_fnc_eventTimeline