1. Epic GamesDeveloper
  3. USequencePlayerLibrary

USequencePlayerLibrary

Exposes operations to be performed on a sequence player anim node Note: Experimental and subject to change!

Unreal Engine C++ API Reference > Runtime > AnimGraphRuntime

Inheritance Hierarchy

  • UBlueprintFunctionLibrary
  • USequencePlayerLibrary

References

   
Module AnimGraphRuntime
Header /Engine/Source/Runtime/AnimGraphRuntime/Public/SequencePlayerLibrary.h
Include #include "SequencePlayerLibrary.h"

Syntax

UCLASS (Experimental, MinimalAPI)  
class USequencePlayerLibrary : public UBlueprintFunctionLibrary

Remarks

Exposes operations to be performed on a sequence player anim node Note: Experimental and subject to change!

Functions

  Type Name Description
Public function Static UFunction BlueprintPure, Category, Meta float

ComputePlayRateFromDuration ( const FSequencePlayerReference& SequencePlayer,
float Duration
)

 Returns the Play Rate to provide when playing this animation if a specific animation duration is desired
Public function Static UFunction BlueprintCallable, Category, Meta FSequencePlayerReference

ConvertToSequencePlayer ( const FAnimNodeReference& Node,
EAnimNodeReferenceConversionResult& Result
)

 Get a sequence player context from an anim node context
Public function Static UFunction BlueprintPure, Category, Meta void

ConvertToSequencePlayerPure ( const FAnimNodeReference& Node,
FSequencePlayerReference& SequencePlayer,
bool& Result
)

 Get a sequence player context from an anim node context (pure)
Public function Static UFunction BlueprintPure, Category, Meta float

GetAccumulatedTime ( const FSequencePlayerReference& SequencePlayer
)

 Gets the current accumulated time of the sequence player
Public function Static UFunction BlueprintPure, Category, Meta bool

GetLoopAnimation ( const FSequencePlayerReference& SequencePlayer
)

 Get the looping state of the sequence player
Public function Static UFunction BlueprintPure, Category, Meta float

GetPlayRate ( const FSequencePlayerReference& SequencePlayer
)

 Get the play rate of the sequence player
Public function Static UFunction BlueprintCallable, Category, Meta FSequencePlayerReference

GetSequence ( const FSequencePlayerReference& SequencePlayer,
UPARAM(Ref) UAnimSequenceBase*& SequenceBase
)

 Get the current sequence of the sequence player - DEPRECATED, please use pure version
Public function Static UFunction BlueprintPure, Category, Meta UAnimSequenceBase *

GetSequencePure ( const FSequencePlayerReference& SequencePlayer
)

 Get the current sequence of the sequence player
Public function Static UFunction BlueprintPure, Category, Meta float

GetStartPosition ( const FSequencePlayerReference& SequencePlayer
)

 Get the start position of the sequence player
Public function Static UFunction BlueprintCallable, Category, Meta FSequencePlayerReference

SetAccumulatedTime ( const FSequencePlayerReference& SequencePlayer,
float Time
)

 Set the current accumulated time of the sequence player
Public function Static UFunction BlueprintCallable, Category, Meta FSequencePlayerReference

SetPlayRate ( const FSequencePlayerReference& SequencePlayer,
float PlayRate
)

 Set the play rate of the sequence player
Public function Static UFunction BlueprintCallable, Category, Meta FSequencePlayerReference

SetSequence ( const FSequencePlayerReference& SequencePlayer,
UAnimSequenceBase* Sequence
)

 Set the current sequence of the sequence player
Public function Static UFunction BlueprintCallable, Category, Meta FSequencePlayerReference

SetSequenceWithInertialBlending ( const FAnimUpdateContext& UpdateContext,
const FSequencePlayerReference& SequencePlayer,
UAnimSequenceBase* Sequence,
float BlendTime
)

 Set the current sequence of the sequence player with an inertial blend time
Public function Static UFunction BlueprintCallable, Category, Meta FSequencePlayerReference

SetStartPosition ( const FSequencePlayerReference& SequencePlayer,
float StartPosition
)

 Set the start position of the sequence player.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page