1. Epic GamesDeveloper
  3. UTimelineComponent

UTimelineComponent

TimelineComponent holds a series of events, floats, vectors or colors with associated keyframes.

API > API/Runtime > API/Runtime/Engine

TimelineComponent holds a series of events, floats, vectors or colors with associated keyframes. Events can be triggered at keyframes along the timeline. Floats, vectors, and colors are interpolated between keyframes along the timeline.

   
Name UTimelineComponent
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Components/TimelineComponent.h
Include Path #include "Components/TimelineComponent.h"

Syntax

UCLASS (MinimalAPI)  
class UTimelineComponent : public UActorComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UTimelineComponent ( const FObjectInitializer& ObjectInitializer
)

   Components/TimelineComponent.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIgnoreTimeDilation uint32 True if global time dilation should be ignored by this timeline, false otherwise. Components/TimelineComponent.h  
TheTimeline FTimeline The actual timeline structure Components/TimelineComponent.h
  • ReplicatedUsing=OnRep_Timeline

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddEvent ( float Time,
FOnTimelineEvent EventFunc
)

 Add a callback event to the timeline Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void AddInterpFloat ( UCurveFloat* FloatCurve,
FOnTimelineFloat InterpFunc,
FName PropertyName,
FName TrackName
)

 Add a float interpolation to the timeline Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void AddInterpFloat ( UCurveFloat* FloatCurve,
FOnTimelineFloatStatic InterpFunc
)

   Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void AddInterpLinearColor ( UCurveLinearColor* LinearColorCurve,
FOnTimelineLinearColorStatic InterpFunc
)

   Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void AddInterpLinearColor ( UCurveLinearColor* LinearColorCurve,
FOnTimelineLinearColor InterpFunc,
FName PropertyName,
FName TrackName
)

 Add a linear color interpolation to the timeline Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void AddInterpVector ( UCurveVector* VectorCurve,
FOnTimelineVectorStatic InterpFunc
)

   Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void AddInterpVector ( UCurveVector* VectorCurve,
FOnTimelineVector InterpFunc,
FName PropertyName,
FName TrackName
)

 Add a vector interpolation to the timeline Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void GetAllCurves ( TSet< class UCurveBase* >& InOutCurves
) const

 Get all curves used by the Timeline Components/TimelineComponent.h  

bool GetIgnoreTimeDilation()

 Get whether to ignore time dilation. Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

float GetPlaybackPosition()

 Get the current playback position of the Timeline Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

float GetPlayRate()

 Get the current play rate for this timeline Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

float GetScaledTimelineLength()

 Get length of the timeline divided by the play rate Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

float GetTimelineLength()

 Get length of the timeline Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

bool IsLooping()

 Get whether we are looping or not Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

bool IsPlaying()

 Get whether this timeline is playing or not. Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

bool IsReversing()

 Get whether we are reversing or not Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void OnRep_Timeline ( FTimeline& OldTimeline
)

   Components/TimelineComponent.h  

void Play()

 Start playback of timeline Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void PlayFromStart()

 Start playback of timeline from the start Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void Reverse()

 Start playback of timeline in reverse Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void ReverseFromEnd()

 Start playback of timeline in reverse from the end Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void SetDirectionPropertyName ( FName DirectionPropertyName
)

 Set the delegate to call when timeline is finished Components/TimelineComponent.h  

void SetFloatCurve ( UCurveFloat* NewFloatCurve,
FName FloatTrackName
)

 Update a certain float track's curve Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void SetIgnoreTimeDilation ( bool bNewIgnoreTimeDilation
)

 Set whether to ignore time dilation. Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void SetLinearColorCurve ( UCurveLinearColor* NewLinearColorCurve,
FName LinearColorTrackName
)

 Update a certain linear color track's curve Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void SetLooping ( bool bNewLooping
)

 True means we would loop, false means we should not. Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void SetNewTime ( float NewTime
)

 Set the new playback position time to use Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void SetPlaybackPosition ( float NewPosition,
bool bFireEvents,
bool bFireUpdate
)

 Jump to a position in the timeline. Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"
  • Meta=(AdvancedDisplay="bFireUpdate")

void SetPlayRate ( float NewRate
)

 Sets the new play rate for this timeline Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void SetPropertySetObject ( UObject* NewPropertySetObject
)

 Optionally provide an object to automatically update properties on Components/TimelineComponent.h  

void SetTimelineFinishedFunc ( FOnTimelineEvent NewTimelineFinishedFunc
)

 Set the delegate to call when timeline is finished Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void SetTimelineFinishedFunc ( FOnTimelineEventStatic NewTimelineFinishedFunc
)

 Set the static delegate to call when timeline is finished Components/TimelineComponent.h  

void SetTimelineLength ( float NewLength
)

 Set length of the timeline Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void SetTimelineLengthMode ( ETimelineLengthMode NewLengthMode
)

 Sets the length mode of the timeline Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void SetTimelinePostUpdateFunc ( FOnTimelineEvent NewTimelinePostUpdateFunc
)

 Set the delegate to call after each timeline tick Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void SetVectorCurve ( UCurveVector* NewVectorCurve,
FName VectorTrackName
)

 Update a certain vector track's curve Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

void Stop()

 Stop playback of timeline Components/TimelineComponent.h
  • BlueprintCallable
  • Category="Components|Timeline"

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void Activate ( bool bReset
)

 Activates the SceneComponent, should be overridden by native child classes. Components/TimelineComponent.h  

virtual void Deactivate()

 Deactivates the SceneComponent. Components/TimelineComponent.h  

virtual bool IsReadyForOwnerToAutoDestroy()

 Overridable check for a component to indicate to its Owner that it should prevent the Actor from auto destroying when finished Components/TimelineComponent.h  

virtual void TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Function called every frame on this ActorComponent. Components/TimelineComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool IsPostLoadThreadSafe()

   Components/TimelineComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static UFunction * GetTimelineEventSignature()

 Get the signature function for Timeline event functions Components/TimelineComponent.h  

static UFunction * GetTimelineFloatSignature()

 Get the signature function for Timeline float functions Components/TimelineComponent.h  

static UFunction * GetTimelineLinearColorSignature()

 Get the signature function for Timeline linear color functions Components/TimelineComponent.h  

static ETimelineSigType GetTimelineSignatureForFunction ( const UFunction* InFunc
)

 Get the signature type for a specified function Components/TimelineComponent.h  

static UFunction * GetTimelineVectorSignature()

 Get the signature function for Timeline vector functions Components/TimelineComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page