BIS fnc animatedBriefing: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *I([a-z ])" to "$1 - i$2") |
Lou Montana (talk | contribs) m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)") |
||
Line 20: | Line 20: | ||
|p2= indexEvent: [[Number]] - index of the event to play | |p2= indexEvent: [[Number]] - index of the event to play | ||
|p3= markersHide: [[Array]] - (Optional, default | |p3= markersHide: [[Array]] - (Optional, default <sqf inline>[]</sqf>) array of markers which should be hidden when briefing starts | ||
|p4= markersShow: [[Array]] - (Optional, default | |p4= markersShow: [[Array]] - (Optional, default <sqf inline>[]</sqf>) array of markers which should be shown when the briefing is done | ||
|p5= endPosition: [[String]] - (Optional, default "") marker to focus when the briefing is done | |p5= endPosition: [[String]] - (Optional, default "") marker to focus when the briefing is done |
Revision as of 18:09, 8 November 2023
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:
- 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
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