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

Script language

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

ControlPlayableAsset

class in UnityEngine.Timeline

/

Inherits from:Playables.PlayableAsset


Implements interfaces:IPlayableAsset, IPropertyPreview, ITimelineClipAsset

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

Asset that generates playables for controlling time-related elements on a GameObject.

This playable optionally controls ParticleSystem, PlayableDirectors and Activation from a GameObject. Users can also specify a Prefab that will be instantiated, and parented to the the sourceObject if specified.

Properties

activeIndicate if the playable will use Activation.
particleRandomSeedLet the particle systems behave the same way on each execution.
postPlaybackIndicates the active state of the gameObject when the Timeline is stopped.
prefabGameObjectPrefab object that will be instantiated.
searchHierarchyIndicate whether to search the entire hierachy for controlable components.
sourceGameObjectGameObject in the scene to control, or the parent of the instantiated prefab.
updateDirectorIndicate if user wants to control PlayableDirectors.
updateITimeControlIndicates that whether Monobehaviours implementing ITimeControl on the gameObject will be controlled.
updateParticleIndicates if user wants to control ParticleSystems.

Inherited Members

Properties

hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.
durationThe playback duration in seconds of the instantiated Playable.
outputsA description of the outputs of the instantiated Playable.

Public Methods

GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the game object.
CreatePlayableImplement this method to have your asset inject playables into the given graph.

Static Methods

DestroyRemoves a gameobject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.
CreateInstanceCreates an instance of a scriptable object.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.

Messages

AwakeThis function is called when the ScriptableObject script is started.
OnDestroyThis function is called when the scriptable object will be destroyed.
OnDisableThis function is called when the scriptable object goes out of scope.
OnEnableThis function is called when the object is loaded.
对文档有任何疑问,请移步至开发者社区提问,我们将尽快为您解答