PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandSALSA Class Reference

Sequencer command SALSA(clip, [subject], [audioclips...]). More...

Inheritance diagram for PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandSALSA:
Collaboration diagram for PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandSALSA:

Protected Member Functions

override AudioSource GetAudioSource (Transform subject)
 
override AudioSource GetAudioSource (Transform subject)
 
- Protected Member Functions inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait
virtual void TryAudioClip (string audioClipName)
 
- Protected Member Functions inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommand
void Stop ()
 Call this method to indicate that the command is done playing.
 
Transform GetSubject (string specifier, Transform defaultSubject=null)
 Sequencer commands usually specify a subject to which the command applies (e.g., where to aim the camera).
 
Transform GetSubject (int i, Transform defaultSubject=null)
 Sequencer commands usually specify a subject to which the command applies (e.g., where to aim the camera).
 
string GetParameter (int i, string defaultValue=null)
 Gets the i-th parameter (zero-based).
 
GetParameterAs< T > (int i, T defaultValue)
 Gets the i-th parameter (zero-based) as a specified type.
 
float GetParameterAsFloat (int i, float defaultValue=0)
 Gets the i-th parameter as a float.
 
int GetParameterAsInt (int i, int defaultValue=0)
 Gets the i-th parameter as an int.
 
bool GetParameterAsBool (int i, bool defaultValue=false)
 Gets the i-th parameter as a bool.
 
string GetParameters ()
 Gets the parameters as a comma-separated string.
 
bool IsAudioMuted ()
 Checks whether a Lua variable "Mute" is defined and true.
 

Additional Inherited Members

- Public Member Functions inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait
virtual IEnumerator Start ()
 
virtual void Update ()
 
virtual void OnDialogueSystemPause ()
 
virtual void OnDialogueSystemUnpause ()
 
virtual void OnDestroy ()
 
- Public Member Functions inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommand
void Initialize (Sequencer sequencer, string endMessage, Transform speaker, Transform listener, params string[] parameters)
 Initializes the base properties.
 
void Initialize (Sequencer sequencer, Transform speaker, Transform listener, params string[] parameters)
 Initializes the base properties.
 
- Static Public Member Functions inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait
static float GetAudioClipLength (AudioSource audioSource, AudioClip audioClip)
 
- Public Attributes inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommand
bool isPlaying = true
 Indicates whether the command is still playing.
 
- Protected Attributes inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait
float stopTime = 0
 
AudioSource audioSource = null
 
int nextClipIndex = 2
 
string audioClipName
 
AudioClip currentClip = null
 
AudioClip originalClip = null
 
bool restoreOriginalClip = false
 
bool playedAudio = false
 
bool isLoadingAudio = false
 
- Properties inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommand
Sequencer sequencer [get]
 Reference to the Sequencer, so you can access its properties such as SequencerCamera and CameraAngles.
 
string[] parameters [get]
 The parameters for the command.
 
string endMessage [get]
 Optional message to send the sequencer when the command completes.
 
Transform speaker [get]
 
Transform listener [get]
 

Detailed Description

Sequencer command SALSA(clip, [subject], [audioclips...]).

  • clip: The path to an audio clip in a Resources folder.
  • subject: The GameObject with the Salsa component. Default: speaker.
  • Additional parameters are additional audio clips to play in sequence.

Since the Salsa component now works simply by watching audio clips on the subject, this command is just a wrapper for AudioWait().

Member Function Documentation

◆ GetAudioSource() [1/2]

override AudioSource PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandSALSA.GetAudioSource ( Transform  subject)
inlineprotectedvirtual

◆ GetAudioSource() [2/2]

override AudioSource PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandSALSA.GetAudioSource ( Transform  subject)
inlineprotectedvirtual

The documentation for this class was generated from the following files: