unreal.MovieSceneSequencePlayer
¶
- class unreal.MovieSceneSequencePlayer(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
Object
Abstract class that provides consistent player behaviour for various animation players
C++ Source:
Module: MovieScene
File: MovieSceneSequencePlayer.h
Editor Properties: (see get_editor_property/set_editor_property)
on_finished
(OnMovieSceneSequencePlayerEvent): [Read-Write] Event triggered when the level sequence player finishes naturally (without explicitly calling stop)on_pause
(OnMovieSceneSequencePlayerEvent): [Read-Write] Event triggered when the level sequence player is pausedon_play
(OnMovieSceneSequencePlayerEvent): [Read-Write] Event triggered when the level sequence player is playedon_play_reverse
(OnMovieSceneSequencePlayerEvent): [Read-Write] Event triggered when the level sequence player is played in reverseon_stop
(OnMovieSceneSequencePlayerEvent): [Read-Write] Event triggered when the level sequence player is stopped
- change_playback_direction() None ¶
Changes the direction of playback (go in reverse if it was going forward, or vice versa)
- get_bound_objects(object_binding) Array[Object] ¶
Retrieve all objects currently bound to the specified binding identifier
- Parameters:
object_binding (MovieSceneObjectBindingID) –
- Return type:
- get_current_time() QualifiedTime ¶
Get the current playback position
- Returns:
The current playback position
- Return type:
- get_duration() QualifiedTime ¶
Get the total duration of the sequence
- Return type:
- get_end_time() QualifiedTime ¶
Get the offset within the level sequence to finish playing
- Return type:
- get_frame_duration() int32 ¶
Get this sequence’s duration in frames
- Return type:
int32
- get_object_bindings(object) Array[MovieSceneObjectBindingID] ¶
Get the object bindings for the requested object
- Parameters:
object (Object) –
- Return type:
- get_sequence() MovieSceneSequence ¶
Access the sequence this player is playing
- Returns:
the sequence currently assigned to this player
- Return type:
- get_start_time() QualifiedTime ¶
Get the offset within the level sequence to start playing
- Return type:
- go_to_end_and_stop() None ¶
Go to end of the sequence and stop. Adheres to ‘When Finished’ section rules.
- property on_finished: OnMovieSceneSequencePlayerEvent¶
[Read-Write] Event triggered when the level sequence player finishes naturally (without explicitly calling stop)
- Type:
- property on_pause: OnMovieSceneSequencePlayerEvent¶
[Read-Write] Event triggered when the level sequence player is paused
- Type:
- property on_play: OnMovieSceneSequencePlayerEvent¶
[Read-Write] Event triggered when the level sequence player is played
- Type:
- property on_play_reverse: OnMovieSceneSequencePlayerEvent¶
[Read-Write] Event triggered when the level sequence player is played in reverse
- Type:
- property on_stop: OnMovieSceneSequencePlayerEvent¶
[Read-Write] Event triggered when the level sequence player is stopped
- Type:
- play() None ¶
Start playback forwards from the current time cursor position, using the current play rate.
- play_looping(num_loops=-1) None ¶
Start playback from the current time cursor position, looping the specified number of times.
- Parameters:
num_loops (int32) – The number of loops to play. -1 indicates infinite looping.
- play_to(playback_params, play_to_params) None ¶
Play from the current position to the requested position and pause. If requested position is before the current position, playback will be reversed. Playback to the requested position will be cancelled if Stop() or Pause() is invoked during this playback.
- Parameters:
playback_params (MovieSceneSequencePlaybackParams) – The position settings (ie. the position to play to)
play_to_params (MovieSceneSequencePlayToParams) –
- set_disable_camera_cuts(disable_camera_cuts) None ¶
Set whether to disable camera cuts
- Parameters:
disable_camera_cuts (bool) –
- set_frame_range(start_frame, duration, sub_frames=0.000000) None ¶
Set the valid play range for this sequence, determined by a starting frame number (in this sequence player’s plaback frame), and a number of frames duration
- Parameters:
start_frame (int32) – The frame number to start playing back the sequence
duration (int32) – The number of frames to play
sub_frames (float) –
- set_frame_rate(frame_rate) None ¶
Set the frame-rate that this player should play with, making all frame numbers in the specified time-space
- Parameters:
frame_rate (FrameRate) –
- set_play_rate(play_rate) None ¶
Set the playback rate of this player. Negative values will play the animation in reverse.
- Parameters:
play_rate (float) – The new rate of playback for the animation.
- set_playback_position(playback_params) None ¶
Set the current time of the player by evaluating from the current time to the specified time, as if the sequence is playing. Triggers events that lie within the evaluated range. Does not alter the persistent playback status of the player (IsPlaying).
- Parameters:
playback_params (MovieSceneSequencePlaybackParams) – The position settings (ie. the position to set playback to)
- set_time_range(start_time, duration) None ¶
Set the valid play range for this sequence, determined by a starting time and a duration (in seconds)
- set_weight(weight) None ¶
Set a manual weight to be multiplied with all blendable elements within this sequence note:: It is recommended that a weight between 0 and 1 is supplied, though this is not enforced note:: It is recommended that either FMovieSceneSequencePlaybackSettings::DynamicWeighting should be true for this player or the asset it’s playing back should be set to enable dynamic weight to avoid undesirable behavior
- Parameters:
weight (double) – The weight to suuply to all elements in this sequence