[unity] timeline learning notes (VII): Custom clip

One // Inherit PlayableAsset class , Realization ITimelineClipAsset Interface

just as Custom track （Track） Need to inherit TrackAsset Class like that , Custom clips （Clip） Also follow certain templates ： Inherit PlayableAsset class , And realize ITimelineClipAsset Interface .

using UnityEngine;
using UnityEngine.Playables;
using UnityEngine.Timeline;

public class LearnClip : PlayableAsset, ITimelineClipAsset
{

}

After writing the head of the class , There will be Red corrugated line Prompt us to make mistakes .

Shortcut key Alt + Enter After fixing the error , There will be one more attribute in the code （Property） And methods （Function）.

using UnityEngine;
using UnityEngine.Playables;
using UnityEngine.Timeline;

public class LearnClip : PlayableAsset, ITimelineClipAsset
{
    public ClipCaps clipCaps
    {// ITimelineClipAsset Implementation requirements of the interface 
        get
        {
            throw new System.NotImplementedException();
        }
    }

    public override Playable CreatePlayable(PlayableGraph graph, GameObject owner)
    {// PlayableAsset Class inheritance requirements 
        throw new System.NotImplementedException();
    }
}

---

Two // ClipsCaps attribute

Don't panic when you meet a strange name , To look at first ClipCaps Of file .

You can see ,ClipCaps The content in is And Clip Related operations , Friends who are not impressed can see This article .

When we write     when ,

The content of the clip in the inspector is like this ——

【 Add a very important point , Because these parameters need to be adjustable in the inspection window , So it should be Add... To this class Serializable attribute 】

And when we write        when ,

The content of the inspection window is much less ——

therefore ClipCaps Is that ： The allowed functions will be available in Inspector Edited , These functions are related to Clip Related operations .

---

3、 ... and // CreatPlayable Method

\

CreatePlayable  Methods cannot be seen alone , But its general meaning is Create a Playable, Then insert into PlayableGraph.

It has two parameters ：graph Indicates what to insert Graph;owner Is created Playable The source of the .

Four // PlayableBehaviour And ScriptPlayable

All user-defined Playable Must inherit from PlayableBehaviour class , In the script of the custom fragment , It needs to go with ScriptPlayable Use .

So a custom Clip The framework of the script is basically like the following code ：

using System;
using UnityEngine;
using UnityEngine.Playables;
using UnityEngine.Timeline;

[Serializable]    //  serialize 
public class DialogueClip : PlayableAsset, ITimelineClipAsset
{
    public DialogueBehaviour template = new DialogueBehaviour ();    //  Generally, variables are named template

    public ClipCaps clipCaps
    {//  The adjustable function of the inspection window 
        get { return ClipCaps.None; }
    }

    public override Playable CreatePlayable (PlayableGraph graph, GameObject owner)
    {//  establish Playable
        var playable = ScriptPlayable<DialogueBehaviour>.Create (graph, template);    //  Really used to create Playable The sentence of 
        
        //... There can also be some assignment operations ...//
        
        return playable;    //  Return to the created Playable,Clip Script task completed 
    }
}