BIS fnc animatedBriefing: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|game([0-9])=([^ ]+) * \|version([0-9])=([^ ]+) * " to "|game$1=$2 |version$3=$4 ")
m (Text replacement - "\|s([0-9])= ([^ ]+) (\[\[call\]\]) ([^ ]+) " to "|s$1= $2 call $4 ")
Line 12: Line 12:
|descr= Plays the Animated Briefings. Basically, it is a wrap function for the eventTimeline function.
|descr= Plays the Animated Briefings. Basically, it is a wrap function for the eventTimeline function.


|s1= [timeline, indexEvent, markersHide, markersShow, endPosition] [[call]] [[BIS_fnc_animatedBriefing]]
|s1= [timeline, indexEvent, markersHide, markersShow, endPosition] call [[BIS_fnc_animatedBriefing]]


|p1= timeline: [[Array]] - Array in format:  
|p1= timeline: [[Array]] - Array in format:  

Revision as of 18:18, 20 June 2021

Hover & click on the images for description

Description

Description:
Plays the Animated Briefings. Basically, it is a wrap function for the eventTimeline function.
Execution:
spawn
Groups:
SystemsBriefing

Syntax

Syntax:
[timeline, indexEvent, markersHide, markersShow, endPosition] call BIS_fnc_animatedBriefing
Parameters:
timeline: Array - Array in format:
  • time: Number - Time the code is executed
  • code: Code - Coded which is executed when time is reached
indexEvent: Number - Index of the event to play
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
Return Value:
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"); };

Additional Information

See also:
Arma 3 Animated Briefing BIS_fnc_eventTimeline

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