Navigation
API > API/Plugins > API/Plugins/UAFAnimGraph
Timeline State
Encapsulates the state of a timeline.
| Name | FTimelineState |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/UAF/UAFAnimGraph/Source/UAFAnimGraph/Public/TraitInterfaces/ITimeline.h |
| Include Path | #include "TraitInterfaces/ITimeline.h" |
Syntax
struct FTimelineState
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Default construct with no state. | TraitInterfaces/ITimeline.h | ||
FTimelineState
(
float InPosition, |
Construct with a specific state. | TraitInterfaces/ITimeline.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsLooping | bool | Timeline looping status. | TraitInterfaces/ITimeline.h | |
| DebugName | FName | A debug name associated with this timeline. | TraitInterfaces/ITimeline.h | |
| Duration | float | Timeline duration in seconds. | TraitInterfaces/ITimeline.h | |
| PlayRate | float | Timeline play rate. | TraitInterfaces/ITimeline.h | |
| Position | float | Timeline position in seconds. | TraitInterfaces/ITimeline.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FTimelineState AsLooping
(
bool InAsLooping |
Creates a new instance of the timeline state with the supplied looping flag. | TraitInterfaces/ITimeline.h | |
FName GetDebugName() |
Returns the timeline name. | TraitInterfaces/ITimeline.h | |
float GetDuration() |
Returns the timeline duration in seconds For infinite timelines this will return infinity | TraitInterfaces/ITimeline.h | |
float GetPlayRate() |
Returns the play rate of the timeline. | TraitInterfaces/ITimeline.h | |
float GetPosition() |
Returns the timeline position in seconds. | TraitInterfaces/ITimeline.h | |
float GetPositionRatio() |
Returns the timeline position as a ratio (0.0 = start of timeline, 1.0 = end of timeline) For infinite timelines, this will return infinity | TraitInterfaces/ITimeline.h | |
float GetTimeLeft() |
Returns the time left to play in the timeline For infinite timelines this will return infinity | TraitInterfaces/ITimeline.h | |
bool IsFinite() |
Returns whether or not this timeline is finite. | TraitInterfaces/ITimeline.h | |
bool IsLooping() |
Returns whether or not the timeline is looping. | TraitInterfaces/ITimeline.h | |
void Reset() |
Resets the timeline state to its default state. | TraitInterfaces/ITimeline.h | |
FTimelineState WithDebugName
(
FName InDebugName |
Creates a new instance of the timeline state with the supplied debug name. | TraitInterfaces/ITimeline.h | |
FTimelineState WithDuration
(
float InDuration |
Creates a new instance of the timeline state with the supplied duration. | TraitInterfaces/ITimeline.h | |
FTimelineState WithPlayRate
(
float InPlayRate |
Creates a new instance of the timeline state with the supplied play rate. | TraitInterfaces/ITimeline.h | |
FTimelineState WithPosition
(
float InPosition |
Creates a new instance of the timeline state with the supplied position. | TraitInterfaces/ITimeline.h |