1. Epic GamesDeveloper
  3. USequencePlayerLibrary

USequencePlayerLibrary

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

API > API/Runtime > API/Runtime/AnimGraphRuntime

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

   
Name USequencePlayerLibrary
Type class
Header File /Engine/Source/Runtime/AnimGraphRuntime/Public/SequencePlayerLibrary.h
Include Path #include "SequencePlayerLibrary.h"

Syntax

UCLASS (Experimental, MinimalAPI)  
class USequencePlayerLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static float ComputePlayRateFromDuration ( const FSequencePlayerReference& SequencePlayer,
float Duration
)

 Returns the Play Rate to provide when playing this animation if a specific animation duration is desired SequencePlayerLibrary.h
  • BlueprintPure
  • Category="Animation|Sequences"
  • Meta=(BlueprintThreadSafe)

static FSequencePlayerReference ConvertToSequencePlayer ( const FAnimNodeReference& Node,
EAnimNodeReferenceConversionResult& Result
)

 Get a sequence player context from an anim node context SequencePlayerLibrary.h
  • BlueprintCallable
  • Category="Animation|Sequences"
  • Meta=(BlueprintThreadSafe, ExpandEnumAsExecs="Result")

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

 Get a sequence player context from an anim node context (pure) SequencePlayerLibrary.h
  • BlueprintPure
  • Category="Animation|Sequences"
  • Meta=(BlueprintThreadSafe, DisplayName="Convert to Sequence Player")

static float GetAccumulatedTime ( const FSequencePlayerReference& SequencePlayer
)

 Gets the current accumulated time of the sequence player SequencePlayerLibrary.h
  • BlueprintPure
  • Category="Animation|Sequences"
  • Meta=(BlueprintThreadSafe)

static bool GetLoopAnimation ( const FSequencePlayerReference& SequencePlayer
)

 Get the looping state of the sequence player SequencePlayerLibrary.h
  • BlueprintPure
  • Category="Animation|Sequences"
  • Meta=(BlueprintThreadSafe)

static float GetPlayRate ( const FSequencePlayerReference& SequencePlayer
)

 Get the play rate of the sequence player SequencePlayerLibrary.h
  • BlueprintPure
  • Category="Animation|Sequences"
  • Meta=(BlueprintThreadSafe)

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

 Get the current sequence of the sequence player - DEPRECATED, please use pure version SequencePlayerLibrary.h
  • BlueprintCallable
  • Category="Animation|Sequences"
  • Meta=(BlueprintThreadSafe, DeprecatedFunction)

static UAnimSequenceBase * GetSequencePure ( const FSequencePlayerReference& SequencePlayer
)

 Get the current sequence of the sequence player SequencePlayerLibrary.h
  • BlueprintPure
  • Category="Animation|Sequences"
  • Meta=(BlueprintThreadSafe, DisplayName="Get Sequence")

static float GetStartPosition ( const FSequencePlayerReference& SequencePlayer
)

 Get the start position of the sequence player SequencePlayerLibrary.h
  • BlueprintPure
  • Category="Animation|Sequences"
  • Meta=(BlueprintThreadSafe)

static FSequencePlayerReference SetAccumulatedTime ( const FSequencePlayerReference& SequencePlayer,
float Time
)

 Set the current accumulated time of the sequence player SequencePlayerLibrary.h
  • BlueprintCallable
  • Category="Animation|Sequences"
  • Meta=(BlueprintThreadSafe)

static FSequencePlayerReference SetPlayRate ( const FSequencePlayerReference& SequencePlayer,
float PlayRate
)

 Set the play rate of the sequence player SequencePlayerLibrary.h
  • BlueprintCallable
  • Category="Animation|Sequences"
  • Meta=(BlueprintThreadSafe)

static FSequencePlayerReference SetSequence ( const FSequencePlayerReference& SequencePlayer,
UAnimSequenceBase* Sequence
)

 Set the current sequence of the sequence player SequencePlayerLibrary.h
  • BlueprintCallable
  • Category="Animation|Sequences"
  • Meta=(BlueprintThreadSafe)

static 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 SequencePlayerLibrary.h
  • BlueprintCallable
  • Category="Animation|Sequences"
  • Meta=(BlueprintThreadSafe)

static FSequencePlayerReference SetStartPosition ( const FSequencePlayerReference& SequencePlayer,
float StartPosition
)

 Set the start position of the sequence player. SequencePlayerLibrary.h
  • BlueprintCallable
  • Category="Animation|Sequences"
  • Meta=(BlueprintThreadSafe)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page