unreal.AvaSequencePlaybackObject

class unreal.AvaSequencePlaybackObject(outer: Object | None = None, name: Name | str = 'None')

Bases: Interface

Ava Sequence Playback Object

C++ Source:

  • Plugin: Avalanche

  • Module: AvalancheSequence

  • File: AvaSequencePlaybackObject.h

continue_sequences_by_label(sequence_label) → Array[AvaSequencePlayer]

Triggers Continue for the playing sequences that match the given label

Parameters:

sequence_label (Name) – the label of the sequences to continue

Returns:

the sequence players that fired the continue, or null if there were no active players

Return type:

Array[AvaSequencePlayer]

continue_sequences_by_labels(sequence_labels) → Array[AvaSequencePlayer]

Triggers Continues in multiple playing sequences given by an array of sequence labels

Parameters:

sequence_labels (Array[Name]) – the array of sequence labels to trigger continue (must be an active sequence playing)

Returns:

the sequence player array that fired the continue. It might have possible invalid/null entries so that each Player matches in Index with the input Sequence labels

Return type:

Array[AvaSequencePlayer]

continue_sequences_by_tag(tag_handle, exact_match) → Array[AvaSequencePlayer]

Triggers Continues in all the sequences matching the provided tag

Parameters:

  • tag_handle (AvaTagHandle) – the tag to match

  • exact_match (bool) – whether to only consider sequences that have the tag exactly

Returns:

the array of the Sequence Players with only valid entries that fired the continue

Return type:

Array[AvaSequencePlayer]

get_all_sequence_players() → Array[AvaSequencePlayer]

Retrieves all Active Sequence Players

Return type:

Array[AvaSequencePlayer]

has_active_sequence_players() → bool

Returns true if there are any Active Sequence Players

Return type:

bool

pause_sequences_by_label(sequence_label) → None

Pauses all players for sequences that match the given label

Parameters:

sequence_label (Name) – the label of the sequences to pause

pause_sequences_by_labels(sequence_labels) → None

Pauses all players for sequences that match the given labels

Parameters:

sequence_labels (Array[Name]) – the array of sequence labels to pause (must be an active sequence playing)

pause_sequences_by_tag(tag_handle, exact_match) → None

Pauses all players for sequences that match the provided tag

Parameters:

  • tag_handle (AvaTagHandle) – the tag to match

  • exact_match (bool) – whether to only consider sequences that match the tag exactly

play_scheduled_sequences() → Array[AvaSequencePlayer]

Plays the Scheduled Sequences with the Scheduled Play Settings

Returns:

an array of the Sequence Players with possible invalid/null entries kept so that each Player matches in Index with the Scheduled Sequence it is playing

Return type:

Array[AvaSequencePlayer]

play_sequence_by_soft_reference(sequence, play_settings) → AvaSequencePlayer

Plays a single sequence by its soft reference

Parameters:
Returns:

the player instantiated for the Sequence, or null if Sequence was not valid for playback

Return type:

AvaSequencePlayer

play_sequences_by_label(sequence_label, play_settings) → Array[AvaSequencePlayer]

Plays all the sequences that have the provided label

Parameters:

  • sequence_label (Name) – the label of the sequences to play

  • play_settings (AvaSequencePlayParams) – the play settings to use for playback

Returns:

an array of the Sequence Players with possible invalid/null entries kept so that each Player matches in Index with the input Sequence it is playing

Return type:

Array[AvaSequencePlayer]

play_sequences_by_labels(sequence_labels, play_settings) → Array[AvaSequencePlayer]

Plays multiple Sequences by an array of sequence labels

Parameters:

  • sequence_labels (Array[Name]) – the array of sequence labels to play

  • play_settings (AvaSequencePlayParams) – the play settings to use for playback

Returns:

an array of the Sequence Players with possible invalid/null entries kept so that each Player matches in Index with the input Sequence it is playing

Return type:

Array[AvaSequencePlayer]

play_sequences_by_soft_reference(sequences, play_settings) → Array[AvaSequencePlayer]

Plays multiple Sequences by their Soft Reference

Parameters:
Returns:

an array of the Sequence Players with possible invalid/null entries kept so that each Player matches in Index with the input Sequence it is playing

Return type:

Array[AvaSequencePlayer]

play_sequences_by_tag(tag_handle, exact_match, play_settings) → Array[AvaSequencePlayer]

Plays all the Sequences that match the given gameplay tag(s)

Parameters:

  • tag_handle (AvaTagHandle) – the tag to match

  • exact_match (bool) – whether to only consider sequences that have the tag exactly

  • play_settings (AvaSequencePlayParams) – the play settings to use for playback

Returns:

an array of the Sequence Players with only valid entries kept

Return type:

Array[AvaSequencePlayer]

stop_sequences_by_label(sequence_label) → None

Stops all players for sequences that match the given label

Parameters:

sequence_label (Name) – the label of the sequences to stop

stop_sequences_by_labels(sequence_labels) → None

Stops all players for sequences that match the given labels

Parameters:

sequence_labels (Array[Name]) – the array of sequence labels to stop (must be an active sequence playing)

stop_sequences_by_tag(tag_handle, exact_match) → None

Stops all players for sequences that match the provided tag

Parameters:

  • tag_handle (AvaTagHandle) – the tag to match

  • exact_match (bool) – whether to only consider sequences that match the tag exactly