BIS fnc animatedBriefing: Difference between revisions
Jump to navigation
Jump to search
Hypoxic125 (talk | contribs) (Missing actual 2nd parameter - Music (string). Documentation at beginning of file does not match the params afterward. Updates parameters documentation and example) |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 12: | Line 12: | ||
|descr= Plays the Animated Briefings. Basically, it is a wrap function for the [[BIS_fnc_eventTimeline]] function. | |descr= Plays the Animated Briefings. Basically, it is a wrap function for the [[BIS_fnc_eventTimeline]] function. | ||
|s1= [timeline, indexEvent, markersHide, markersShow, endPosition] call [[BIS_fnc_animatedBriefing]] | |s1= [timeline, indexEvent, music, markersHide, markersShow, endPosition] call [[BIS_fnc_animatedBriefing]] | ||
|p1= timeline: [[Array]] - array in format [time, code]: | |p1= timeline: [[Array]] - array in format [time, code]: | ||
| Line 24: | Line 24: | ||
|p4= markersHide: [[Array]] - (Optional, default {{hl|[]}}) array of markers which should be hidden when briefing starts | |p4= markersHide: [[Array]] - (Optional, default {{hl|[]}}) array of markers which should be hidden when briefing starts | ||
|p5= markersShow: [[Array]] - (Optional, default | |p5= markersShow: [[Array]] - (Optional, default {{hl|[]}}) array of markers which should be shown when the briefing is done | ||
|p6= endPosition: [[String]] - (Optional, default "") marker to focus when the briefing is done | |p6= endPosition: [[String]] - (Optional, default "") marker to focus when the briefing is done | ||
|p7= codeEnd: [[Code]] - (Optional, default {}) code executed when briefing is done | |p7= codeEnd: [[Code]] - (Optional, default {{hl|{}<nowiki/>}}) code executed when briefing is done | ||
|r1= [[Nothing]] | |r1= [[Nothing]] | ||
| Line 54: | Line 54: | ||
|exec= spawn | |exec= spawn | ||
|seealso= [[Arma 3 Animated Briefing]] [[BIS_fnc_eventTimeline]] | |seealso= [[Arma 3: Animated Briefing]] [[BIS_fnc_eventTimeline]] | ||
}} | }} | ||
Latest revision as of 22:17, 17 April 2024
Description
- Description:
- Plays the Animated Briefings. Basically, it is a wrap function for the BIS_fnc_eventTimeline function.
- Execution:
- spawn
- Groups:
- SystemsBriefing
Syntax
- Syntax:
- [timeline, indexEvent, music, markersHide, markersShow, endPosition] call BIS_fnc_animatedBriefing
- Parameters:
- timeline: Array - array in format [time, code]:
- 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
- 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