Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

PlayableExtensions.GetPlayState

Other Versions
Leave feedback
Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static method GetPlayState(playable: U): Playables.PlayState;
public static Playables.PlayState GetPlayState(U playable);

Parameters

playableThe Playable used by this operation.

Returns

PlayState The current PlayState of the Playable.

Description

Returns the current PlayState of the Playable.

PlayState.Playing: The local time of this Playable will be updated during the evaluation of the PlayableGraph.
PlayState.Paused: The local time of this Playable will not be updated during the evaluation of the PlayableGraph.
PlayState.Delayed: The delay is elapsed during the evaluation of the PlayableGraph, the Playable will not start as long as there is still a delay.

NOTE: This is a templated extension method that can be used on any type that inherits from IPlayable.

Did you find this page useful? Please give it a rating:

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2018 Unity Technologies. Publication: 2018.1-002N. Built: 2018-12-04.
TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information