FTimeline Struct Reference

#include <TimelineComponent.h>

Public Member Functions
PRAGMA_DISABLE_DEPRECATION_WARNINGS	FTimeline ()
	~FTimeline ()=default
	FTimeline (const FTimeline &)=default
	FTimeline (FTimeline &&)=default
FTimeline &	operator= (const FTimeline &)=default
FTimeline &	operator= (FTimeline &&)=default
ENGINE_API void	Play ()
ENGINE_API void	PlayFromStart ()
ENGINE_API void	Reverse ()
ENGINE_API void	ReverseFromEnd ()
ENGINE_API void	Stop ()
ENGINE_API bool	IsPlaying () const
ENGINE_API bool	IsReversing () const
ENGINE_API void	SetPlaybackPosition (float NewPosition, bool bFireEvents, bool bFireUpdate=true)
ENGINE_API float	GetPlaybackPosition () const
ENGINE_API void	SetLooping (bool bNewLooping)
ENGINE_API bool	IsLooping () const
ENGINE_API void	SetPlayRate (float NewRate)
ENGINE_API float	GetPlayRate () const
ENGINE_API void	SetNewTime (float NewTime)
ENGINE_API float	GetTimelineLength () const
ENGINE_API float	GetScaledTimelineLength () const
ENGINE_API void	SetTimelineLengthMode (ETimelineLengthMode NewMode)
ENGINE_API void	SetTimelineLength (float NewLength)
ENGINE_API void	SetFloatCurve (UCurveFloat *NewFloatCurve, FName FloatTrackName)
ENGINE_API void	SetVectorCurve (UCurveVector *NewVectorCurve, FName VectorTrackName)
ENGINE_API void	SetLinearColorCurve (UCurveLinearColor *NewLinearColorCurve, FName LinearColorTrackName)
ENGINE_API void	SetPropertySetObject (UObject *NewPropertySetObject)
ENGINE_API void	SetTimelinePostUpdateFunc (FOnTimelineEvent NewTimelinePostUpdateFunc)
ENGINE_API void	SetTimelineFinishedFunc (FOnTimelineEvent NewTimelineFinishedFunc)
ENGINE_API void	SetTimelineFinishedFunc (FOnTimelineEventStatic NewTimelineFinishedFunc)
ENGINE_API void	AddEvent (float Time, FOnTimelineEvent EventFunc)
ENGINE_API void	AddInterpVector (UCurveVector *VectorCurve, FOnTimelineVector InterpFunc, FName PropertyName=NAME_None, FName TrackName=NAME_None)
ENGINE_API void	AddInterpVector (UCurveVector *VectorCurve, FOnTimelineVectorStatic InterpFunc)
ENGINE_API void	AddInterpFloat (UCurveFloat *FloatCurve, FOnTimelineFloat InterpFunc, FName PropertyName=NAME_None, FName TrackName=NAME_None)
ENGINE_API void	AddInterpFloat (UCurveFloat *FloatCurve, FOnTimelineFloatStatic InterpFunc)
ENGINE_API void	AddInterpLinearColor (UCurveLinearColor *LinearColorCurve, FOnTimelineLinearColor InterpFunc, FName PropertyName=NAME_None, FName TrackName=NAME_None)
ENGINE_API void	AddInterpLinearColor (UCurveLinearColor *LinearColorCurve, FOnTimelineLinearColorStatic InterpFunc)
ENGINE_API void	TickTimeline (float DeltaTime)
ENGINE_API void	SetDirectionPropertyName (FName InDirectionPropertyName)
void	GetAllCurves (TSet< class UCurveBase * > &InOutCurves) const
ENGINE_API bool	Serialize (FArchive &Ar)
ENGINE_API void	PostSerialize (const FArchive &Ar)

Static Public Member Functions
PRAGMA_ENABLE_DEPRECATION_WARNINGS static ENGINE_API UEnum *	GetTimelineDirectionEnum ()

Constructor & Destructor Documentation

FTimeline() [1/3]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FTimeline::FTimeline ( )

inline

~FTimeline()

FTimeline::~FTimeline ( )

default

FTimeline() [2/3]

FTimeline::FTimeline ( const FTimeline &  )

default

FTimeline() [3/3]

FTimeline::FTimeline ( FTimeline &&  )

default

Member Function Documentation

AddEvent()

void FTimeline::AddEvent	(	float	Time,
		FOnTimelineEvent	EventFunc
	)

Add a callback event to the timeline

AddInterpFloat() [1/2]

void FTimeline::AddInterpFloat	(	UCurveFloat *	FloatCurve,
		FOnTimelineFloat	InterpFunc,
		FName	PropertyName = NAME_None,
		FName	TrackName = NAME_None
	)

Add a float interpolation to the timeline

AddInterpFloat() [2/2]

void FTimeline::AddInterpFloat	(	UCurveFloat *	FloatCurve,
		FOnTimelineFloatStatic	InterpFunc
	)

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

AddInterpLinearColor() [1/2]

void FTimeline::AddInterpLinearColor	(	UCurveLinearColor *	LinearColorCurve,
		FOnTimelineLinearColor	InterpFunc,
		FName	PropertyName = NAME_None,
		FName	TrackName = NAME_None
	)

Add a linear color interpolation to the timeline

AddInterpLinearColor() [2/2]

void FTimeline::AddInterpLinearColor	(	UCurveLinearColor *	LinearColorCurve,
		FOnTimelineLinearColorStatic	InterpFunc
	)

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

AddInterpVector() [1/2]

void FTimeline::AddInterpVector	(	UCurveVector *	VectorCurve,
		FOnTimelineVector	InterpFunc,
		FName	PropertyName = NAME_None,
		FName	TrackName = NAME_None
	)

Add a vector interpolation to the timeline

AddInterpVector() [2/2]

void FTimeline::AddInterpVector	(	UCurveVector *	VectorCurve,
		FOnTimelineVectorStatic	InterpFunc
	)

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

GetAllCurves()

void FTimeline::GetAllCurves

(

TSet< class UCurveBase * > &

InOutCurves

)

const

Get all curves used by the Timeline

GetPlaybackPosition()

float FTimeline::GetPlaybackPosition

(

)

const

Get the current playback position of the Timeline

GetPlayRate()

float FTimeline::GetPlayRate

(

)

const

Get the current play rate for this timeline

GetScaledTimelineLength()

float FTimeline::GetScaledTimelineLength

(

)

const

Get length of the timeline divided by the play rate

GetTimelineDirectionEnum()

UEnum * FTimeline::GetTimelineDirectionEnum ( )

static

Helper function to get to the timeline direction enum

GetTimelineLength()

float FTimeline::GetTimelineLength

(

)

const

Get length of the timeline

IsLooping()

bool FTimeline::IsLooping

(

)

const

Get whether we are looping or not

IsPlaying()

bool FTimeline::IsPlaying

(

)

const

Get whether this timeline is playing or not.

IsReversing()

bool FTimeline::IsReversing

(

)

const

Get whether we are reversing or not

operator=() [1/2]

FTimeline & FTimeline::operator= ( const FTimeline &  )

default

operator=() [2/2]

FTimeline & FTimeline::operator= ( FTimeline &&  )

default

Play()

void FTimeline::Play

(

)

Start playback of timeline

PlayFromStart()

void FTimeline::PlayFromStart

(

)

Start playback of timeline from the start

PostSerialize()

void FTimeline::PostSerialize

(

const FArchive &

Ar

)

Reverse()

void FTimeline::Reverse

(

)

Start playback of timeline in reverse

ReverseFromEnd()

void FTimeline::ReverseFromEnd

(

)

Start playback of timeline in reverse from the end

Serialize()

bool FTimeline::Serialize

(

FArchive &

Ar

)

SetDirectionPropertyName()

void FTimeline::SetDirectionPropertyName

(

FName

InDirectionPropertyName

)

Set the delegate to call when timeline is finished

SetFloatCurve()

void FTimeline::SetFloatCurve	(	UCurveFloat *	NewFloatCurve,
		FName	FloatTrackName
	)

Update a certain float track's curve

SetLinearColorCurve()

void FTimeline::SetLinearColorCurve	(	UCurveLinearColor *	NewLinearColorCurve,
		FName	LinearColorTrackName
	)

Update a certain linear color track's curve

SetLooping()

void FTimeline::SetLooping

(

bool

bNewLooping

)

true means we whould loop, false means we should not.

SetNewTime()

void FTimeline::SetNewTime

(

float

NewTime

)

Set the new playback position time to use

SetPlaybackPosition()

void FTimeline::SetPlaybackPosition	(	float	NewPosition,
		bool	bFireEvents,
		bool	bFireUpdate = true
	)

Jump to a position in the timeline. If bFireEvents is true, event functions will fire, otherwise will not.

SetPlayRate()

void FTimeline::SetPlayRate

(

float

NewRate

)

Sets the new play rate for this timeline

SetPropertySetObject()

void FTimeline::SetPropertySetObject

(

UObject *

NewPropertySetObject

)

Optionally provide an object to automatically update properties on

SetTimelineFinishedFunc() [1/2]

void FTimeline::SetTimelineFinishedFunc

(

FOnTimelineEvent

NewTimelineFinishedFunc

)

Set the delegate to call when timeline is finished

SetTimelineFinishedFunc() [2/2]

void FTimeline::SetTimelineFinishedFunc

(

FOnTimelineEventStatic

NewTimelineFinishedFunc

)

Set the static delegate to call when timeline is finished

SetTimelineLength()

void FTimeline::SetTimelineLength

(

float

NewLength

)

Set the length of the timeline

SetTimelineLengthMode()

void FTimeline::SetTimelineLengthMode

(

ETimelineLengthMode

NewMode

)

Sets the timeline length mode

SetTimelinePostUpdateFunc()

void FTimeline::SetTimelinePostUpdateFunc

(

FOnTimelineEvent

NewTimelinePostUpdateFunc

)

Set the delegate to call after each timeline tick

SetVectorCurve()

void FTimeline::SetVectorCurve	(	UCurveVector *	NewVectorCurve,
		FName	VectorTrackName
	)

Update a certain vector track's curve

Stop()

void FTimeline::Stop

(

)

Stop playback of timeline

TickTimeline()

void FTimeline::TickTimeline

(

float

DeltaTime

)

Advance the timeline, if playing, firing delegates

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Engine/Classes/Components/TimelineComponent.h
• Engine/Source/Runtime/Engine/Private/Timeline.cpp