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

Script language

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

Experimental: this API is experimental and might be changed or removed in the future.

ScriptPlayable

class in UnityEngine.Experimental.Director

/

Inherits from:Experimental.Director.Playable

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

Description

Base class for all user-defined playables.

Public Functions

OnDestroyCalled when the Playable is destroyed.
OnGraphStartCalled when the PlayableGraph this Playable is owned by starts playing.
OnGraphStopCalled when the PlayableGraph this Playable is owned by is stopped.
OnPlayStateChangedOverride this method to perform custom operations when the PlayState changes.
PrepareFrameCalled during evaluation of the PlayableGraph.
ProcessFrameThe ProcessFrame is the stage at which your Playable should do its work.

Inherited members

Variables

handleReturns the PlayableHandle for this playable.

Public Functions

IsValidReturns true if the Playable is valid. A playable can be invalid if it was disposed. This is different from a Null playable.

Messages

OnSetPlayStateCallback called when the PlayState has changed
OnSetTimeCallback called when the current time has changed