BIS fnc animatedBriefing: Difference between revisions

Latest revision as of 22:17, 17 April 2024

1.78

LELocal

Hover & click on the images for description

Description

Description:: Plays the Animated Briefings. Basically, it is a wrap function for the BIS_fnc_eventTimeline function.
Execution:: spawn
Groups:: Systems Briefing

Syntax

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

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

@@ Line 1: / Line 1: @@
-{{Function|= Comments
+{{RV|type=function
-| arma3 |Game name=
+|game1= arma3
+|version1= 1.78
-|1.78|Game version=
+|gr1= Systems
-<!---|arg= local |Multiplayer Arguments=--->
+|gr2= Briefing
-<!---|eff= local |Multiplayer Effects=--->
+|eff= local
-| <pre>/*
+|descr= Plays the Animated Briefings. Basically, it is a wrap function for the [[BIS_fnc_eventTimeline]] function.
-	Author: Zozo, modified by Riccardo Argiolas
-	Description:
+|s1= [timeline, indexEvent, music, markersHide, markersShow, endPosition] call [[BIS_fnc_animatedBriefing]]
-	Plays the Animated Briefings. Basically, it is a wrap function for the eventTimeline function.
- 	Parameters:
+|p1= timeline: [[Array]] - array in format [time, code]:
- 	Select 0 - 2D ARRAY : timeline in format [ [1.0, {code} ], [2.0, {code} ], [2.3, {code} ], [4.7, {code} ] ]
+* time: [[Number]] - time the code is executed
-	Select 1 - NUMBER: index of the event to play
+* code: [[Code]] - code executed when ''time'' is reached
-	Select 2 (OPTIONAL)- ARRAY: markers to hide before the briefing starts and when the briefing has been completed
-	Select 3 (OPTIONAL)- ARRAY: markers to show after the briefing has been completed
-	Select 4 (OPTIONAL)- STRING: marker to zoom to instantly when the briefing is over
-	Select 5 (OPTIONAL)- BOOL: will the player have the ability to close the map at the end of the briefing?
-	Select 6 (OPTIONAL)- CODE: code that will be executed when the briefing is over or is skipped
-	Returns:
+|p2= indexEvent: [[Number]] - index of the event to play
-	none
-*/</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=
-|[] call [[BIS_fnc_animatedBriefing]]|Syntax=
+|p3= music: [[String]] - (Optional, default "") CfgMusic class
-|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
+|p4= markersHide: [[Array]] - (Optional, default {{hl|[]}}) array of markers which should be hidden when briefing starts
-|Datatype - description|Return value=
+|p5= markersShow: [[Array]] - (Optional, default {{hl|[]}}) array of markers which should be shown when the briefing is done
-|x1= <code></code>|Example 1=
+|p6= endPosition: [[String]] - (Optional, default "") marker to focus when the briefing is done
-|exec= call |Execution=
+|p7= codeEnd: [[Code]] - (Optional, default {{hl|{}<nowiki/>}}) code executed when briefing is done
-| |See also=
+|r1= [[Nothing]]
+|x1= <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"); };
+</sqf>
+|exec= spawn
+|seealso= [[Arma 3: Animated Briefing]] [[BIS_fnc_eventTimeline]]
 }}
-[[Category:Function Group: Systems|{{uc:animatedBriefing}}]]
-[[Category:Functions|{{uc:animatedBriefing}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:animatedBriefing}}]]
-[[Category:Placeholder function]]