1. Epic GamesDeveloper
  3. FTimeline

FTimeline

API > API/Runtime > API/Runtime/Engine

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

Syntax

USTRUCT ()  
struct FTimeline

Constructors

Name Remarks Include Path Unreal Specifiers

PRAGMA_DISABLE_DEPRECATION_WARNINGS FTimeline ()

   Components/TimelineComponent.h  
  Components/TimelineComponent.h  

FTimeline ( const FTimeline&
)

   Components/TimelineComponent.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FTimeline()

 Note: We need to explicitly disable warnings on these constructors/operators for clang to be happy with deprecated variables. Components/TimelineComponent.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bLooping uint8 Whether timeline should loop when it reaches the end, or stop Components/TimelineComponent.h  
bReversePlayback uint8 If playback should move the current position backwards instead of forwards Components/TimelineComponent.h  
DirectionProperty FProperty * Cached property pointer for setting timeline direction Components/TimelineComponent.h  
DirectionPropertyName FName Optional. Components/TimelineComponent.h
  • NotReplicated
Events TArray< struct FTimelineEventEntry > Array of events that are fired at various times during the timeline Components/TimelineComponent.h
  • NotReplicated
InterpFloats TArray< struct FTimelineFloatTrack > Array of float interpolations performed during the timeline Components/TimelineComponent.h
  • NotReplicated
InterpLinearColors TArray< struct FTimelineLinearColorTrack > Array of linear color interpolations performed during the timeline Components/TimelineComponent.h
  • NotReplicated
InterpVectors TArray< struct FTimelineVectorTrack > Array of vector interpolations performed during the timeline Components/TimelineComponent.h
  • NotReplicated
Length float How long the timeline is, will stop or loop at the end Components/TimelineComponent.h
  • NotReplicated
LengthMode TEnumAsByte< ETimelineLengthMode > Specified how the timeline determines its own length (e.g. specified length, last keyframe) Components/TimelineComponent.h
  • NotReplicated
PlayingStateTracker uint8 If the first bit is set to 1 (PlayingStateTracker & 0x01 == 1), then we are playing Components/TimelineComponent.h  
PlayRate float How fast we should play through the timeline Components/TimelineComponent.h  
Position float Current position in the timeline Components/TimelineComponent.h  
PropertySetObject TWeakObjectPtr< UObject > Optional. Components/TimelineComponent.h
  • NotReplicated
TimelineFinishedFunc FOnTimelineEvent Called whenever this timeline is finished. Components/TimelineComponent.h
  • NotReplicated
TimelineFinishFuncStatic FOnTimelineEventStatic Called whenever this timeline is finished. Components/TimelineComponent.h  
TimelinePostUpdateFunc FOnTimelineEvent Called whenever this timeline is playing and updates - done after all delegates are executed and variables updated Components/TimelineComponent.h
  • NotReplicated

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddEvent ( float Time,
FOnTimelineEvent EventFunc
)

 Add a callback event to the timeline Components/TimelineComponent.h  

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

 Add a float interpolation to the timeline Components/TimelineComponent.h  

void AddInterpFloat ( UCurveFloat* FloatCurve,
FOnTimelineFloatStatic InterpFunc
)

 Add a float interpolation to the timeline. Use a non-serializeable delegate. Components/TimelineComponent.h  

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

 Add a linear color interpolation to the timeline Components/TimelineComponent.h  

void AddInterpLinearColor ( UCurveLinearColor* LinearColorCurve,
FOnTimelineLinearColorStatic InterpFunc
)

 Add a linear color interpolation to the timeline. Use a non-serializeable delegate. Components/TimelineComponent.h  

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

 Add a vector interpolation to the timeline Components/TimelineComponent.h  

void AddInterpVector ( UCurveVector* VectorCurve,
FOnTimelineVectorStatic InterpFunc
)

 Add a vector interpolation to the timeline. Use a non-serializeable delegate. Components/TimelineComponent.h  

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

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

float GetPlaybackPosition()

 Get the current playback position of the Timeline Components/TimelineComponent.h  

float GetPlayRate()

 Get the current play rate for this timeline Components/TimelineComponent.h  

float GetScaledTimelineLength()

 Get length of the timeline divided by the play rate Components/TimelineComponent.h  

float GetTimelineLength()

 Get length of the timeline Components/TimelineComponent.h  

bool IsLooping()

 Get whether we are looping or not Components/TimelineComponent.h  

bool IsPlaying()

 Get whether this timeline is playing or not. Components/TimelineComponent.h  

bool IsReversing()

 Get whether we are reversing or not Components/TimelineComponent.h  

void Play()

 Start playback of timeline Components/TimelineComponent.h  

void PlayFromStart()

 Start playback of timeline from the start Components/TimelineComponent.h  

void PostSerialize ( const FArchive& Ar
)

   Components/TimelineComponent.h  

void Reverse()

 Start playback of timeline in reverse Components/TimelineComponent.h  

void ReverseFromEnd()

 Start playback of timeline in reverse from the end Components/TimelineComponent.h  

bool Serialize ( FArchive& Ar
)

   Components/TimelineComponent.h  

void SetDirectionPropertyName ( FName InDirectionPropertyName
)

 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  

void SetLinearColorCurve ( UCurveLinearColor* NewLinearColorCurve,
FName LinearColorTrackName
)

 Update a certain linear color track's curve Components/TimelineComponent.h  

void SetLooping ( bool bNewLooping
)

 True means we whould loop, false means we should not. Components/TimelineComponent.h  

void SetNewTime ( float NewTime
)

 Set the new playback position time to use Components/TimelineComponent.h  

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

 Jump to a position in the timeline. Components/TimelineComponent.h  

void SetPlayRate ( float NewRate
)

 Sets the new play rate for this timeline Components/TimelineComponent.h  

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  

void SetTimelineFinishedFunc ( FOnTimelineEventStatic NewTimelineFinishedFunc
)

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

void SetTimelineLength ( float NewLength
)

 Set the length of the timeline Components/TimelineComponent.h  

void SetTimelineLengthMode ( ETimelineLengthMode NewMode
)

 Sets the timeline length mode Components/TimelineComponent.h  

void SetTimelinePostUpdateFunc ( FOnTimelineEvent NewTimelinePostUpdateFunc
)

 Set the delegate to call after each timeline tick Components/TimelineComponent.h  

void SetVectorCurve ( UCurveVector* NewVectorCurve,
FName VectorTrackName
)

 Update a certain vector track's curve Components/TimelineComponent.h  

void Stop()

 Stop playback of timeline Components/TimelineComponent.h  

void TickTimeline ( float DeltaTime
)

 Advance the timeline, if playing, firing delegates Components/TimelineComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static UEnum * GetTimelineDirectionEnum()

 Helper function to get to the timeline direction enum Components/TimelineComponent.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Components/TimelineComponent.h  
  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