---
name: "BIS_fnc_animatedBriefing"
type: function
status: ok
groups: ["Systems", "Briefing"]
arma3_since: "1.78"
locality: {"argument": null, "effect": "local", "server_exec": false}
source: https://community.bistudio.com/wiki/BIS_fnc_animatedBriefing
revid: 363759
updated: 2024-04-17T21:17:53Z
---

# BIS_fnc_animatedBriefing

*Function · Systems, Briefing · Arma 3 v1.78*

Locality: effect **local** · executed with **spawn**

## Description

Plays the Animated Briefings. Basically, it is a wrap function for the [BIS_fnc_eventTimeline](../functions/BIS_fnc_eventTimeline.md) function.

## Syntax

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

**Parameters:**

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

**Returns:** [Nothing](../topics/Nothing.md)

## Examples

### Example 1

```sqf
// 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](../functions/BIS_fnc_eventTimeline.md)

<sub>Source: [BI Community Wiki — BIS fnc animatedBriefing](https://community.bistudio.com/wiki/BIS_fnc_animatedBriefing) (revision 363759).</sub>