BIS_fnc_eventTimeline

From Bohemia Interactive Community
Jump to navigation Jump to search
Introduced with Arma 3 version 1.78
  

Click on the images for descriptions

Introduced in

Game:
Arma 3
Version:
1.78

Description

Description:
/*
	Author: ZoZo, modified by Riccardo Argiolas

	Description:
    	Universal system for playing sequential events defined by time. Timeline (ARRAY) consists from events (ARRAY).
	timeline = [event1, event2, ..., eventX];
	event1 = [ time,1 code1 ];

	Example: timeline1 = [ [1.0, {do something here} ], [1.5, {do something here} ], [3.2, {do something here} ] ];
 	1st code is executed at 1.0sec after the start of the function, 2nd code is executed at 1.5sec after the start of the function and 3rd code is executed at 3.2sec after the start of the function

	Parameters:
	Select 0 - 2D ARRAY : timeline in format [ [1.0, {code} ], [2.0, {code} ], [2.3, {code} ], [4.7, {code} ] ]
	Select 1 - NUMBER: index of the event to play
	Select 2 - STRING: music to be played which will provide the sync time for the timeline
	Select 3 - (OPTIONAL) - CODE: code to be executed if the timeline is interrupted (missionNamespace setVariable ["BIS_fnc_eventTimeline_playing", FALSE])
	Select 4 - (OPTIONAL) - CODE or ARRAY: code or array of codes to be executed once the timeline is finshed. The codes are CALLed one after the other.

	Returns:

	Examples:
*/
(Placeholder description extracted from the function header by BIS_fnc_exportFunctionsToWiki)

Syntax

Syntax:
[] call BIS_fnc_eventTimeline
Parameters:
parameter: Datatype - (Optional, default defValue) description
Return Value:
Datatype - description

Examples

Example 1:
Example needed

Additional Information

Execution:
call
Multiplayer:
-
See also:
See also needed

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To