Class TimelineComponent

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

Inheritance
System.Object
UObject
ActorComponent
TimelineComponent
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class TimelineComponent : ActorComponent
Remarks

Events can be triggered at keyframes along the timeline. Floats, vectors, and colors are interpolated between keyframes along the timeline.

Properties

| Improve this Doc View Source

bIgnoreTimeDilation

Declaration
public bool bIgnoreTimeDilation { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static TimelineComponent DefaultObject { get; }
Property Value
Type Description
TimelineComponent
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class
| Improve this Doc View Source

TheTimeline

The actual timeline structure

Declaration
public Timeline TheTimeline { get; set; }
Property Value
Type Description
Timeline

Methods

| Improve this Doc View Source

GetIgnoreTimeDilation()

Get whether to ignore time dilation.

Declaration
public bool GetIgnoreTimeDilation()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GetPlaybackPosition()

Get the current playback position of the Timeline

Declaration
public float GetPlaybackPosition()
Returns
Type Description
System.Single
| Improve this Doc View Source

GetPlayRate()

Get the current play rate for this timeline

Declaration
public float GetPlayRate()
Returns
Type Description
System.Single
| Improve this Doc View Source

GetTimelineLength()

Get length of the timeline

Declaration
public float GetTimelineLength()
Returns
Type Description
System.Single
| Improve this Doc View Source

IsLooping()

Get whether we are looping or not

Declaration
public bool IsLooping()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsPlaying()

Get whether this timeline is playing or not.

Declaration
public bool IsPlaying()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsReversing()

Get whether we are reversing or not

Declaration
public bool IsReversing()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static TimelineComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
TimelineComponent
| Improve this Doc View Source

Play()

Start playback of timeline

Declaration
public void Play()
| Improve this Doc View Source

PlayFromStart()

Start playback of timeline from the start

Declaration
public void PlayFromStart()
| Improve this Doc View Source

Reverse()

Start playback of timeline in reverse

Declaration
public void Reverse()
| Improve this Doc View Source

ReverseFromEnd()

Start playback of timeline in reverse from the end

Declaration
public void ReverseFromEnd()
| Improve this Doc View Source

SetFloatCurve(CurveFloat, Name)

Update a certain float track's curve

Declaration
public void SetFloatCurve(CurveFloat NewFloatCurve, Name FloatTrackName)
Parameters
Type Name Description
CurveFloat NewFloatCurve
Name FloatTrackName
| Improve this Doc View Source

SetIgnoreTimeDilation(Boolean)

Set whether to ignore time dilation.

Declaration
public void SetIgnoreTimeDilation(bool bNewIgnoreTimeDilation)
Parameters
Type Name Description
System.Boolean bNewIgnoreTimeDilation
| Improve this Doc View Source

SetLinearColorCurve(CurveLinearColor, Name)

Update a certain linear color track's curve

Declaration
public void SetLinearColorCurve(CurveLinearColor NewLinearColorCurve, Name LinearColorTrackName)
Parameters
Type Name Description
CurveLinearColor NewLinearColorCurve
Name LinearColorTrackName
| Improve this Doc View Source

SetLooping(Boolean)

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

Declaration
public void SetLooping(bool bNewLooping)
Parameters
Type Name Description
System.Boolean bNewLooping
| Improve this Doc View Source

SetNewTime(Single)

Set the new playback position time to use

Declaration
public void SetNewTime(float NewTime)
Parameters
Type Name Description
System.Single NewTime
| Improve this Doc View Source

SetPlaybackPosition(Single, Boolean, Boolean)

Jump to a position in the timeline.

Declaration
public void SetPlaybackPosition(float NewPosition, bool bFireEvents, bool bFireUpdate)
Parameters
Type Name Description
System.Single NewPosition
System.Boolean bFireEvents
System.Boolean bFireUpdate
Remarks

@param bFireEvents If true, event functions that are between current position and new playback position will fire. @param bFireUpdate If true, the update output exec will fire after setting the new playback position.

| Improve this Doc View Source

SetPlayRate(Single)

Sets the new play rate for this timeline

Declaration
public void SetPlayRate(float NewRate)
Parameters
Type Name Description
System.Single NewRate
| Improve this Doc View Source

SetTimelineLength(Single)

Set length of the timeline

Declaration
public void SetTimelineLength(float NewLength)
Parameters
Type Name Description
System.Single NewLength
| Improve this Doc View Source

SetTimelineLengthMode(Byte)

Sets the length mode of the timeline

Declaration
public void SetTimelineLengthMode(byte NewLengthMode)
Parameters
Type Name Description
System.Byte NewLengthMode
| Improve this Doc View Source

SetVectorCurve(CurveVector, Name)

Update a certain vector track's curve

Declaration
public void SetVectorCurve(CurveVector NewVectorCurve, Name VectorTrackName)
Parameters
Type Name Description
CurveVector NewVectorCurve
Name VectorTrackName
| Improve this Doc View Source

Stop()

Stop playback of timeline

Declaration
public void Stop()

Operators

| Improve this Doc View Source

Implicit(IntPtr to TimelineComponent)

Convert from IntPtr to UObject

Declaration
public static implicit operator TimelineComponent(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
TimelineComponent