BIS fnc timeline getPlayRate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (infobox to template)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *R([a-z ])" to "$1 - r$2")
 
(22 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= Returns the play rate of this timeline.


<!---|eff= local |Multiplayer Effects=--->
|s1= [timeline] call [[BIS_fnc_timeline_getPlayRate]]


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


Description:
|r1= [[Number]] - returns play rate
Returns the play rate of this timeline


Parameter(s):
|x1= <sqf>private _playRate = [timeline] call BIS_fnc_timeline_getPlayRate;</sqf>
_this select 0: Object - The timeline


Returns:
|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_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]]
The play rate of the timeline
*/</pre>{{placeholder}}<!-- Remove this after fill-in --> |Description=
 
|[] call [[BIS_fnc_timeline_getPlayRate]]|Syntax=
 
|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
 
|Datatype - description|Return value=
 
|x1= <code></code>|Example 1=
 
|exec= call |Execution=
 
| |See also=
}}
}}
[[Category:Function Group: Timeline|{{uc:timeline_getPlayRate}}]]
[[Category:Functions|{{uc:timeline_getPlayRate}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:timeline_getPlayRate}}]]

Latest revision as of 15:47, 8 November 2023

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

Description

Description:
Returns the play rate of this timeline.
Execution:
call
Groups:
Timeline

Syntax

Syntax:
[timeline] call BIS_fnc_timeline_getPlayRate
Parameters:
timeline: Object - the timeline object
Return Value:
Number - returns play rate

Examples

Example 1:
private _playRate = [timeline] call BIS_fnc_timeline_getPlayRate;

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_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_getPlayRate&oldid=349036"