Creating Timelines

Creating Timelines

You can create and instantiate your own Timeline Component in an Actor class by following the steps below.

1. Navigate to your C++ Classes folder and right-click on the content browser window . From the drop down menu select New C++ class .

2. Create a new Actor class named Timeline Actor .

Navigate to your TimelineActor.h file. You will need to include the following Timeline Component library to utillize its functionality.

include "Components/TimelineComponent.h

Inside the TimelineActor class defintion, implement the following class declaration:

protected:
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    UTimelineComponent* ExampleTimelineComp;

1. Instantiate your Timeline Component using the default suboject template, then add the following code to your TimelineActor constructor ATimelineActor::ATimelineActor:

   ExampleTimelineComp = CreateDefaultSubobject<UTimelineComponent>(TEXT("TimelineComponent"));

2. From the Unreal Editor , select Compile to hot reload your code.

3. From the C++ classes folder, right-click on your TimelineActor and create a Blueprint based on your TimelineActor class. Give it the name Bp_TimelineActor .

Once you have created your TimelineActor Blueprint, You can view the Class Defaults . From the Components tab, you should see your example Timeline Component.

Timeline Variables

When you create a Timeline Component in C++ using UProperty Specifiers, it will become available as a variable in your Components tab. This may be useful for designers who would like to continue to make iterations to your TimelineComponent via Blueprint Scripting.

For a complete list of the available Blueprint Timeline nodes and their functionality please see the Timeline nodes page.

Creating a FTimeLineEvent

Timeline Events ( FOnTimelineEvent ) are Dynamic Delegates that provide functionality to a Timeline Component to handle an Event. Follow the steps below to create your own FTimeLineEvent to be bound to your Timeline Component's finished functionality.

1. Begin by navigating to your TimelineActor.h file , and declaring the following code in your class definition :

   protected:
       //Delegate signature for the function which will handle our Finished event.
       FOnTimelineEvent TimelineFinishedEvent;
   
   UFUNCTION()
   void TimelineFinishedFunction();

2. Next, implement the following code for your TimelineFinishedFunction in your TimelineActor.cpp :

   UE_LOG(LogTemp, Warning, TEXT("Finished Event Called."));

3. Navigate to your void ATimelineActor::BeginPlay() method, and implement the following code:

   Super::BeginPlay();

   You have now successfully bound your TimelineFinished Event to your custom TimelineFinished function.

4. Finally, compile your code in the editor, and drag an instance of your Bp_TimelineActor into the Level. Press Play In Editor (PIE). You should see the following message in the Output log window: