BIS fnc timeline init: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix)
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )I([a-z])" to "$1i$3")
Line 12: Line 12:
|p1= timeline: [[Object]] - the timeline object
|p1= timeline: [[Object]] - the timeline object


|p2= initPosition: [[Number]] - (Optional, default <sqf inline>_timeline getVariable ["Pos", 0.0]</sqf>) Initial position
|p2= initPosition: [[Number]] - (Optional, default <sqf inline>_timeline getVariable ["Pos", 0.0]</sqf>) initial position


|p3= length: [[Number]] - (Optional, default <sqf inline>_timeline getVariable ["Length", 10.0]</sqf>) Length
|p3= length: [[Number]] - (Optional, default <sqf inline>_timeline getVariable ["Length", 10.0]</sqf>) Length

Revision as of 13:29, 8 November 2023

Hover & click on the images for description

Description

Description:
Initialized a timeline.
Execution:
call
Groups:
Timeline

Syntax

Syntax:
[timeline, initPosition, length, playRate, loop] call BIS_fnc_timeline_init
Parameters:
timeline: Object - the timeline object
initPosition: Number - (Optional, default _timeline getVariable ["Pos", 0.0]) initial position
length: Number - (Optional, default _timeline getVariable ["Length", 10.0]) Length
playRate: Number - (Optional, default _timeline getVariable ["PlayRate", 1.0]) Play rate
loop: Boolean - (Optional, default _timeline getVariable ["Loop", false]) true - loop enabled, false - loop disabled
reverse: Boolean - (Optional, default _timeline getVariable ["Reverse", false]) true - reverse, false - Do not reverse
playOnStart: Boolean - (Optional, default _timeline getVariable ["PlayFromStart", false]) true - play at scenario start, false - Do not play at scenario start
destroyWhenFinished: Boolean - (Optional, default _timeline getVariable ["DestroyWhenFinished", false]) true - Destroy when done, false - Do not destroy when done
Return Value:
Nothing

Examples

Example 1:
[timeline] call BIS_fnc_timeline_init;

Additional Information

See also:
BIS_fnc_timeline_deleted BIS_fnc_timeline_cleanup BIS_fnc_timeline_finish Category:Function Group: Timeline

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