BIS fnc timeline init: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " {2,}\}\}" to " }}")
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )P([a-z])" to "$1p$3")
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function
{{RV|type=function


|game1= arma3
|game1= arma3
|version1= 1.76
|version1= 1.76


Line 9: Line 8:
|descr= Initialized a timeline.
|descr= Initialized a timeline.


|s1= [timeline, initPosition, length, playRate, loop] [[call]] [[BIS_fnc_timeline_init]]
|s1= [timeline, initPosition, length, playRate, loop] call [[BIS_fnc_timeline_init]]


|p1= timeline: [[Object]] - The timeline object
|p1= timeline: [[Object]] - the timeline object


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


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


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


|p5= loop: [[Boolean]] - (Optional, default {{Inline code|timeline [[getVariable]] ["Loop", false]}}) [[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 {{Inline code|timeline [[getVariable]] ["Reverse", false]}}) [[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 {{Inline code|timeline [[getVariable]] ["PlayFromStart", false]}}) [[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 {{Inline code|timeline [[getVariable]] ["DestroyWhenFinished", false]}}) [[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]]


|x1= <code>[timeline] [[call]] [[BIS_fnc_timeline_init]];</code>
|x1= <sqf>[timeline] call BIS_fnc_timeline_init;</sqf>
 
|exec= call


|seealso= [[BIS_fnc_timeline_deleted]] [[BIS_fnc_timeline_cleanup]] [[BIS_fnc_timeline_finish]] [[BIS_fnc_timeline_getAlpha]] [[BIS_fnc_timeline_getCurrentTime]] [[BIS_fnc_timeline_getInterpMode]] [[BIS_fnc_timeline_getLength]] [[BIS_fnc_timeline_getPlayFromStart]] [[BIS_fnc_timeline_getPlayRate]] [[BIS_fnc_timeline_getPlayTime]] [[BIS_fnc_timeline_getPosition]] [[BIS_fnc_timeline_getSimulatedCurves]] [[BIS_fnc_timeline_getStopTime]] [[BIS_fnc_timeline_getTimeLeft]] [[BIS_fnc_timeline_isFinished]] [[BIS_fnc_timeline_isLooping]] [[BIS_fnc_timeline_isPaused]] [[BIS_fnc_timeline_isPlaying]] [[BIS_fnc_timeline_play]] [[BIS_fnc_timeline_setInterpMode]] [[BIS_fnc_timeline_setLength]] [[BIS_fnc_timeline_setLoop]] [[BIS_fnc_timeline_setPause]] [[BIS_fnc_timeline_setPlayRate]] [[BIS_fnc_timeline_setPosition]] [[BIS_fnc_timeline_simulateCurves]] [[BIS_fnc_timeline_stop]] [[BIS_fnc_timeline_tick]] [[BIS_fnc_timeline_setReverse]] [[BIS_fnc_timeline_isReverse]]
|seealso= [[BIS_fnc_timeline_deleted]] [[BIS_fnc_timeline_cleanup]] [[BIS_fnc_timeline_finish]] [[:Category:Function Group: Timeline]]
}}
}}
[[Category:Functions|{{uc:timeline_init}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:timeline_init}}]]

Latest revision as of 13:31, 8 November 2023

Arma 3 logo black.png1.76
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_timeline_init&oldid=348102"