unreal.SequencePlayerLibrary
¶
- class unreal.SequencePlayerLibrary(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
BlueprintFunctionLibrary
Exposes operations to be performed on a sequence player anim node Note: Experimental and subject to change!
C++ Source:
Module: AnimGraphRuntime
File: SequencePlayerLibrary.h
- classmethod compute_play_rate_from_duration(sequence_player, duration=1.000000) float ¶
Returns the Play Rate to provide when playing this animation if a specific animation duration is desired
- Parameters:
sequence_player (SequencePlayerReference) –
duration (float) –
- Return type:
- classmethod convert_to_sequence_player(node) -> (SequencePlayerReference, result=AnimNodeReferenceConversionResult)¶
Get a sequence player context from an anim node context
- Parameters:
node (AnimNodeReference) –
- Returns:
result (AnimNodeReferenceConversionResult):
- Return type:
- classmethod convert_to_sequence_player_pure(node) -> (sequence_player=SequencePlayerReference, result=bool)¶
Get a sequence player context from an anim node context (pure)
- Parameters:
node (AnimNodeReference) –
- Returns:
sequence_player (SequencePlayerReference):
result (bool):
- Return type:
tuple
- classmethod get_accumulated_time(sequence_player) float ¶
Gets the current accumulated time of the sequence player
- Parameters:
sequence_player (SequencePlayerReference) –
- Return type:
- classmethod get_loop_animation(sequence_player) bool ¶
Get the looping state of the sequence player
- Parameters:
sequence_player (SequencePlayerReference) –
- Return type:
- classmethod get_play_rate(sequence_player) float ¶
Get the play rate of the sequence player
- Parameters:
sequence_player (SequencePlayerReference) –
- Return type:
- classmethod get_sequence(sequence_player, sequence_base) -> (SequencePlayerReference, sequence_base=AnimSequenceBase)¶
Get the current sequence of the sequence player - DEPRECATED, please use pure version deprecated: Function ‘GetSequence’ is deprecated.
- Parameters:
sequence_player (SequencePlayerReference) –
sequence_base (AnimSequenceBase) –
- Returns:
sequence_base (AnimSequenceBase):
- Return type:
- classmethod get_sequence_pure(sequence_player) AnimSequenceBase ¶
Get the current sequence of the sequence player
- Parameters:
sequence_player (SequencePlayerReference) –
- Return type:
- classmethod get_start_position(sequence_player) float ¶
Get the start position of the sequence player
- Parameters:
sequence_player (SequencePlayerReference) –
- Return type:
- classmethod set_accumulated_time(sequence_player, time) SequencePlayerReference ¶
Set the current accumulated time of the sequence player
- Parameters:
sequence_player (SequencePlayerReference) –
time (float) –
- Return type:
- classmethod set_play_rate(sequence_player, play_rate) SequencePlayerReference ¶
Set the play rate of the sequence player
- Parameters:
sequence_player (SequencePlayerReference) –
play_rate (float) –
- Return type:
- classmethod set_sequence(sequence_player, sequence) SequencePlayerReference ¶
Set the current sequence of the sequence player
- Parameters:
sequence_player (SequencePlayerReference) –
sequence (AnimSequenceBase) –
- Return type:
- classmethod set_sequence_with_inertial_blending(update_context, sequence_player, sequence, blend_time=0.200000) SequencePlayerReference ¶
Set the current sequence of the sequence player with an inertial blend time
- Parameters:
update_context (AnimUpdateContext) –
sequence_player (SequencePlayerReference) –
sequence (AnimSequenceBase) –
blend_time (float) –
- Return type:
- classmethod set_start_position(sequence_player, start_position) SequencePlayerReference ¶
Set the start position of the sequence player. If this is called from On Become Relevant or On Initial Update then it should be accompanied by a call to SetAccumulatedTime to achieve the desired effect of resetting the play time of a sequence player.
- Parameters:
sequence_player (SequencePlayerReference) –
start_position (float) –
- Return type: