BIS fnc timeline init: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )P([a-z])" to "$1p$3")
 
(3 intermediate revisions by the same user not shown)
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


|p4= playRate: [[Number]] - (Optional, default <sqf inline>timeline getVariable ["PlayRate", 1.0]</sqf>) Play rate
|p4= playRate: [[Number]] - (Optional, default <sqf inline>_timeline getVariable ["PlayRate", 1.0]</sqf>) play rate


|p5= loop: [[Boolean]] - (Optional, default <sqf inline>timeline getVariable ["Loop", false]</sqf>) [[true]] - loop enabled, [[false]] - loop disabled
|p5= loop: [[Boolean]] - (Optional, default <sqf inline>_timeline getVariable ["Loop", false]</sqf>) [[true]] - loop enabled, [[false]] - loop disabled


|p6= reverse: [[Boolean]] - (Optional, default <sqf inline>timeline getVariable ["Reverse", false]</sqf>) [[true]] - reverse, [[false]] - Do not reverse
|p6= reverse: [[Boolean]] - (Optional, default <sqf inline>_timeline getVariable ["Reverse", false]</sqf>) [[true]] - reverse, [[false]] - Do not reverse


|p7= playOnStart: [[Boolean]] - (Optional, default <sqf inline>timeline getVariable ["PlayFromStart", false]</sqf>) [[true]] - play at scenario start, [[false]] - Do not play at scenario start
|p7= playOnStart: [[Boolean]] - (Optional, default <sqf inline>_timeline getVariable ["PlayFromStart", false]</sqf>) [[true]] - play at scenario start, [[false]] - Do not play at scenario start


|p8= destroyWhenFinished: [[Boolean]] - (Optional, default <sqf inline>timeline getVariable ["DestroyWhenFinished", false]</sqf>) [[true]] - Destroy when done, [[false]] - Do not destroy when done
|p8= destroyWhenFinished: [[Boolean]] - (Optional, default <sqf inline>_timeline getVariable ["DestroyWhenFinished", false]</sqf>) [[true]] - Destroy when done, [[false]] - Do not destroy when done


|r1= [[Nothing]]
|r1= [[Nothing]]

Latest revision as of 13:31, 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