1. Epic GamesDeveloper
  3. FTimeline

FTimeline

Unreal Engine C++ API Reference > Runtime > Engine > Components

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Components/TimelineComponent.h
Include #include "Components/TimelineComponent.h"

Syntax

struct FTimeline

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddEvent ( float Time,
FOnTimelineEvent EventFunc
)

 Add a callback event to the timeline
Public function void

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

 Add a float interpolation to the timeline
Public function void

AddInterpFloat ( UCurveFloat* FloatCurve,
FOnTimelineFloatStatic InterpFunc
)

 Add a float interpolation to the timeline. Use a non-serializeable delegate.
Public function void

AddInterpLinearColor ( UCurveLinearColor* LinearColorCurve,
FOnTimelineLinearColorStatic InterpFunc
)

 Add a linear color interpolation to the timeline. Use a non-serializeable delegate.
Public function void

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

 Add a linear color interpolation to the timeline
Public function void

AddInterpVector ( UCurveVector* VectorCurve,
FOnTimelineVectorStatic InterpFunc
)

 Add a vector interpolation to the timeline. Use a non-serializeable delegate.
Public function void

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

 Add a vector interpolation to the timeline
Public function Const void

GetAllCurves ( TSet< class UCurveBase* >& InOutCurves
)

 Get all curves used by the Timeline
Public function Const float Get the current playback position of the Timeline
Public function Const float Get the current play rate for this timeline
Public function Const float Get length of the timeline divided by the play rate
Public function Static UEnum * Helper function to get to the timeline direction enum
Public function Const float Get length of the timeline
Public function Const bool Get whether we are looping or not
Public function Const bool Get whether this timeline is playing or not.
Public function Const bool Get whether we are reversing or not
Public function void

Play ()

 Start playback of timeline
Public function void Start playback of timeline from the start
Public function void

Reverse ()

 Start playback of timeline in reverse
Public function void Start playback of timeline in reverse from the end
Public function void

SetDirectionPropertyName ( FName InDirectionPropertyName
)

 Set the delegate to call when timeline is finished
Public function void

SetFloatCurve ( UCurveFloat* NewFloatCurve,
FName FloatTrackName
)

 Update a certain float track's curve
Public function void

SetLinearColorCurve ( UCurveLinearColor* NewLinearColorCurve,
FName LinearColorTrackName
)

 Update a certain linear color track's curve
Public function void

SetLooping ( bool bNewLooping
)

 True means we whould loop, false means we should not.
Public function void

SetNewTime ( float NewTime
)

 Set the new playback position time to use
Public function void

SetPlaybackPosition ( float NewPosition,
bool bFireEvents,
bool bFireUpdate
)

 Jump to a position in the timeline.
Public function void

SetPlayRate ( float NewRate
)

 Sets the new play rate for this timeline
Public function void

SetPropertySetObject ( UObject* NewPropertySetObject
)

 Optionally provide an object to automatically update properties on
Public function void

SetTimelineFinishedFunc ( FOnTimelineEvent NewTimelineFinishedFunc
)

 Set the delegate to call when timeline is finished
Public function void

SetTimelineFinishedFunc ( FOnTimelineEventStatic NewTimelineFinishedFunc
)

 Set the static delegate to call when timeline is finished
Public function void

SetTimelineLength ( float NewLength
)

 Set the length of the timeline
Public function void

SetTimelineLengthMode ( ETimelineLengthMode NewMode
)

 Sets the timeline length mode
Public function void

SetTimelinePostUpdateFunc ( FOnTimelineEvent NewTimelinePostUpdateFunc
)

 Set the delegate to call after each timeline tick
Public function void

SetVectorCurve ( UCurveVector* NewVectorCurve,
FName VectorTrackName
)

 Update a certain vector track's curve
Public function void

Stop ()

 Stop playback of timeline
Public function void

TickTimeline ( float DeltaTime
)

 Advance the timeline, if playing, firing delegates

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page