BIS fnc timeline init: Difference between revisions

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


| arma3 |Game name=
|game1= arma3
|version1= 1.76


|1.76|Game version=
|gr1= Timeline


<!---|arg= local |Multiplayer Arguments=--->
|descr= Initialized a timeline.


<!---|eff= local |Multiplayer Effects=--->
|s1= [timeline, initPosition, length, playRate, loop] call [[BIS_fnc_timeline_init]]


| <pre>/*
|p1= timeline: [[Object]] - the timeline object
Author: Nelson Duarte <@Nelson_G_Duarte>


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


Parameter(s):
|p3= length: [[Number]] - (Optional, default <sqf inline>_timeline getVariable ["Length", 10.0]</sqf>) length
_this select 0: Object - The timeline
_this select 1: Number - The initial position
_this select 2: Number - The length in seconds
_this select 3: Number - The play rate
_this select 4: Bool - Whether loop is enabled
_this select 5: Bool - Whether we should play backwards
_this select 6: Bool - Whether to start playing at scenario start
_this select 7: Bool - Whether to be destroyed when finishing playing


Returns:
|p4= playRate: [[Number]] - (Optional, default <sqf inline>_timeline getVariable ["PlayRate", 1.0]</sqf>) play rate
Nothing
*/</pre>{{placeholder}}<!-- Remove this after fill-in --> |Description=


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


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|p6= reverse: [[Boolean]] - (Optional, default <sqf inline>_timeline getVariable ["Reverse", false]</sqf>) [[true]] - reverse, [[false]] - Do not reverse


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


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


|exec= call |Execution=
|r1= [[Nothing]]


| |See also=
|x1= <sqf>[timeline] call BIS_fnc_timeline_init;</sqf>
 
|seealso= [[BIS_fnc_timeline_deleted]] [[BIS_fnc_timeline_cleanup]] [[BIS_fnc_timeline_finish]] [[:Category:Function Group: Timeline]]
}}
}}
[[Category:Function Group: Timeline|{{uc:timeline_init}}]]
[[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"