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.

TimelineAsset

class in UnityEngine.Timeline

/

Inherits from:Playables.PlayableAsset


Implements interfaces:IPlayableAsset, IPropertyPreview, ISerializationCallbackReceiver, 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

A PlayableAsset that represents a timeline.

Properties

durationThe length in seconds of the timeline.
durationModeHow the duration of a timeline is calculated.
fixedDurationThe length of the timeline when the durationMode is set to fixed length.
outputTrackCountReturns the the number of output tracks in the Timeline.
rootTrackCountReturns the number of tracks at the root level of the timeline.

Public Methods

CreateTrackAllows you to create a track and add it to the Timeline.
DeleteClipDelete a clip from this timeline.
DeleteTrackDeletes a track from a timeline, including all clips and subtracks.
GetOutputTrackRetrives the output track from the given index.
GetOutputTracksGets a list of all output tracks in the Timeline.
GetRootTrackRetrieves at root track at the specified index.
GetRootTracksGet an enumerable list of all root tracks.

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.

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