class in UnityEngine.Playables
/
Implemented in:UnityEngine.CoreModule
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.
CloseFor 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.
CloseExtensions for all the types that implements IPlayableOutput.
Extension methods are static methods that can be called as if they were instance methods on the extended type.
using UnityEngine; using UnityEngine.Playables;
public class ExamplePlayableBehaviour : PlayableBehaviour { void Start() { PlayableGraph graph = PlayableGraph.Create(); ScriptPlayableOutput scriptOutput = ScriptPlayableOutput.Create(graph, "MyOutput");
// Calling method PlayableExtensions.SetWeight on ScriptPlayableOutput as if it was an instance method. scriptOutput.SetWeight(10);
// The line above is the same as calling directly PlayableExtensions.SetDuration, but it is more compact and readable. PlayableOutputExtensions.SetWeight(scriptOutput, 10); } }
AddNotificationReceiver | Registers a new receiver that listens for notifications. |
GetNotificationReceivers | Retrieves the list of notification receivers currently registered on the output. |
GetSourceOutputPort | Returns the source playable's output connection index. |
GetSourcePlayable | Returns the source playable. |
GetUserData | Returns the opaque user data. This is the same value as the last last argument of ProcessFrame. |
GetWeight | Returns the weight of the connection from the PlayableOutput to the source playable. |
IsOutputNull | Returns true if the PlayableOutput is null, false otherwise. |
IsOutputValid | |
PushNotification | Queues a notification to be sent through the Playable system. |
RemoveNotificationReceiver | Unregisters a receiver on the output. |
SetReferenceObject | Sets the bound object to a new value. Used to associate an output to an object (Track asset in case of Timeline). |
SetSourcePlayable | Sets which playable that computes the output and which sub-tree index. |
SetUserData | Sets the opaque user data. This same data is passed as the last argument to ProcessFrame. |
SetWeight | Sets the weight of the connection from the PlayableOutput to the source playable. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.