BIS fnc timeline getPlayFromStart: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (infobox to template)
m (page filled)
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= Whether timeline is flagged as play from start on scenario begin.
Whether timeline is flagged as play from start on scenario begin


Parameter(s):
||s1= [timeline] call [[BIS_fnc_timeline_getPlayFromStart]]|=Syntax
_this select 0: Object - The timeline


Returns:
|p1= timeline: [[Object]] - The timeline object
Bool - True if should play from start
*/</pre>{{placeholder}}<!-- Remove this after fill-in --> |Description=


|[] call [[BIS_fnc_timeline_getPlayFromStart]]|Syntax=
|r1= [[Boolean]] - Returns [[true]] if timeline should play from start, otherwise [[false]]


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|x1= <code>_playFromStart= [timeline] [[call]] [[BIS_fnc_timeline_getPlayFromStart]];</code>


|Datatype - description|Return value=
|exec= call


|x1= <code></code>|Example 1=
|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_getPlayRate]] [[BIS_fnc_timeline_getPlayTime]] [[BIS_fnc_timeline_getPosition]] [[BIS_fnc_timeline_getSimulatedCurves]] [[BIS_fnc_timeline_getStopTime]] [[BIS_fnc_timeline_getTimeLeft]] [[BIS_fnc_timeline_init]] [[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]]


|exec= call |Execution=
| |See also=
}}
}}
[[Category:Function Group: Timeline|{{uc:timeline_getPlayFromStart}}]]
[[Category:Function Group: Timeline|{{uc:timeline_getPlayFromStart}}]]
[[Category:Functions|{{uc:timeline_getPlayFromStart}}]]
[[Category:Functions|{{uc:timeline_getPlayFromStart}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:timeline_getPlayFromStart}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:timeline_getPlayFromStart}}]]

Revision as of 11:31, 11 January 2020

Arma 3 logo black.png1.76
Hover & click on the images for description

Description

Description:
Whether timeline is flagged as play from start on scenario begin.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[timeline] call BIS_fnc_timeline_getPlayFromStart
Parameters:
timeline: Object - The timeline object
Return Value:
Boolean - Returns true if timeline should play from start, otherwise false

Examples

Example 1:
_playFromStart= [timeline] call BIS_fnc_timeline_getPlayFromStart;

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_getPlayRate BIS_fnc_timeline_getPlayTime BIS_fnc_timeline_getPosition BIS_fnc_timeline_getSimulatedCurves BIS_fnc_timeline_getStopTime BIS_fnc_timeline_getTimeLeft BIS_fnc_timeline_init 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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_timeline_getPlayFromStart&oldid=147730"