BIS fnc timeline getInterpMode: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "{{Function|= Comments | arma3 |Game name= |1.76|Game version= <!---|arg= local |Multiplayer Arguments=---> <!---|eff= local |Multiplayer Effects=---> | <pre>/* Author: N...")
 
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
 
(22 intermediate revisions by 3 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 timeline interp mode index.


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


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


Description:
|r1= [[Number]] - can return:
Returns the timeline interp mode index
{{Columns|4|
* 0  - Linear
* 0  - Linear
* 1  - Cubic
* 1  - Cubic
* 2  - EaseIn
* 2  - EaseIn
* 3  - EaseOut
* 3  - EaseOut
* 4  - EaseInOut
* 4  - EaseInOut
* 5  - Hermite
* 5  - Hermite
* 6  - Berp
* 6  - Berp
* 7  - BounceIn
* 7  - BounceIn
* 8  - BounceOut
* 8  - BounceOut
* 9  - BounceInOut
* 9  - BounceInOut
* 10 - QuinticIn
* 10 - QuinticIn
* 11 - QuinticOut
* 11 - QuinticOut
* 12 - QuinticInOut
* 12 - QuinticInOut
* 13 - ElasticIn
* 13 - ElasticIn
* 14 - ElasticOut
* 14 - ElasticOut
* 15 - ElasticInOut
* 15 - ElasticInOut
 
}}
Parameter(s):
_this select 0: Object - The Timeline
 
Returns:
Integer - The mode as integer
*/</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=
 
|[] call [[BIS_fnc_timeline_getInterpMode]]|Syntax=
 
|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
 
|Datatype - description|Return value=
 
|x1= <code></code>|Example 1=


|exec= call |Execution=
|x1= <sqf>private _interpolationMode = [timeline] call BIS_fnc_timeline_getInterpMode;</sqf>


| |See also=
|seealso= [[BIS_fnc_timeline_deleted]] [[BIS_fnc_timeline_cleanup]] [[BIS_fnc_timeline_finish]] [[BIS_fnc_timeline_getAlpha]] [[BIS_fnc_timeline_getCurrentTime]] [[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_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]]
}}
}}
[[Category:Function Group: Timeline|{{uc:timeline_getInterpMode}}]]
[[Category:Functions|{{uc:timeline_getInterpMode}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:timeline_getInterpMode}}]]

Latest revision as of 14:00, 8 November 2023

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

Description

Description:
Returns the timeline interp mode index.
Execution:
call
Groups:
Timeline

Syntax

Syntax:
[timeline] call BIS_fnc_timeline_getInterpMode
Parameters:
timeline: Object - the timeline object
Return Value:
Number - can return:
  • 0 - Linear
  • 1 - Cubic
  • 2 - EaseIn
  • 3 - EaseOut
  • 4 - EaseInOut
  • 5 - Hermite
  • 6 - Berp
  • 7 - BounceIn
  • 8 - BounceOut
  • 9 - BounceInOut
  • 10 - QuinticIn
  • 11 - QuinticOut
  • 12 - QuinticInOut
  • 13 - ElasticIn
  • 14 - ElasticOut
  • 15 - ElasticInOut

Examples

Example 1:
private _interpolationMode = [timeline] call BIS_fnc_timeline_getInterpMode;

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_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_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_getInterpMode&oldid=348440"