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:
- 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:
- continue_sequences_by_tag(tag, exact_match) Array[AvaSequencePlayer] ¶
Triggers Continues in all the sequences matching the provided tag
- Parameters:
- Returns:
the array of the Sequence Players with only valid entries that fired the continue
- Return type:
- 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:
- play_sequence_by_soft_reference(sequence, play_settings) AvaSequencePlayer ¶
Plays a single sequence by its soft reference
- Parameters:
sequence (AvaSequence) – soft reference of the sequence to play
play_settings (AvaSequencePlayParams) – the play settings to use for playback
- Returns:
the player instantiated for the Sequence, or null if Sequence was not valid for playback
- Return type:
- 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:
- 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:
- play_sequences_by_soft_reference(sequences, play_settings) Array[AvaSequencePlayer] ¶
Plays multiple Sequences by their Soft Reference
- Parameters:
sequences (Array[AvaSequence]) – the array of soft reference 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:
- play_sequences_by_tag(tag, exact_match, play_settings) Array[AvaSequencePlayer] ¶
Plays all the Sequences that match the given gameplay tag(s)
- Parameters:
tag (AvaTag) – 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: