BIS fnc timeline init: Difference between revisions

Revision as of 12:09, 11 January 2020

1.76

Hover & click on the images for description

Description

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

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 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

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

@@ Line 1: / Line 1: @@
-{{Function|= Comments
+{{Function
-| arma3 |Game name=
+|game1= arma3
-|1.76|Game version=
+|version1= 1.76
-<!---|arg= local |Multiplayer Arguments=--->
+<!--|exec= server|=-->
-<!---|eff= local |Multiplayer Effects=--->
+<!--|arg= local-->
-| <pre>/*
+<!--|eff= local-->
-	Author: Nelson Duarte <@Nelson_G_Duarte>
-	Description:
+|descr= Initialized a timeline.
-	Initialized a timeline
-	Parameter(s):
+|s1= [timeline, initPosition, length, playRate, loop] [[call]] [[BIS_fnc_timeline_init]]
-	_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:
+|p1= timeline: [[Object]] - The timeline object
-	Nothing
-*/</pre>{{placeholder}}<!-- Remove this after fill-in --> |Description=
-|[] call [[BIS_fnc_timeline_init]]|Syntax=
+|p2= initPosition: [[Number]] - (Optional, default {{Inline code|timeline [[getVariable]] ["Pos", 0.0]}}) Initial position
-|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
+|p3= length: [[Number]] - (Optional, default 	{{Inline code|timeline [[getVariable]] ["Length", 10.0]}}) Length
-|Datatype - description|Return value=
+|p4= playRate: [[Number]] - (Optional, default {{Inline code|timeline [[getVariable]] ["PlayRate", 1.0]}}) Play rate
-|x1= <code></code>|Example 1=
+|p5= loop: [[Boolean]] - (Optional, default {{Inline code|timeline [[getVariable]] ["Loop", false]}}) [[True]] - loop enabled, [[false]] - loop disabled
-|exec= call |Execution=
+|p6= reverse: [[Boolean]] - (Optional, default {{Inline code|timeline [[getVariable]] ["Reverse", false]}}) [[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
+|p8= destroyWhenFinished: [[Boolean]] - (Optional, default {{Inline code|timeline [[getVariable]] ["DestroyWhenFinished", false]}}) [[True]] - Destroy when done , [[false]] - Do not destroy when done
+|r1= [[Nothing]]
+|x1= <code>[timeline] [[call]] [[BIS_fnc_timeline_init]];</code>
+|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]]
-| |See also=
 }}