PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandMAPlaySound Class Reference

Sequencer command MAPlaySound(group, variation, volume, pitch, wait, subject, follow) More...

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

Public Member Functions

IEnumerator Start ()
 
- 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. More...
 
void Initialize (Sequencer sequencer, Transform speaker, Transform listener, params string[] parameters)
 Initializes the base properties. More...
 

Additional Inherited Members

- Static Public Attributes inherited from PixelCrushers.DialogueSystem.SequencerCommands.BaseMasterAudioSequencerCommand
const string AllKeyword = "all"
 
- Protected Member Functions inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommand
void Stop ()
 Call this method to indicate that the command is done playing. More...
 
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). More...
 
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). More...
 
string GetParameter (int i, string defaultValue=null)
 Gets the i-th parameter (zero-based). More...
 
GetParameterAs< T > (int i, T defaultValue)
 Gets the i-th parameter (zero-based) as a specified type. More...
 
float GetParameterAsFloat (int i, float defaultValue=0)
 Gets the i-th parameter as a float. More...
 
int GetParameterAsInt (int i, int defaultValue=0)
 Gets the i-th parameter as an int. More...
 
bool GetParameterAsBool (int i, bool defaultValue=false)
 Gets the i-th parameter as a bool. More...
 
string GetParameters ()
 Gets the parameters as a comma-separated string. More...
 
bool IsAudioMuted ()
 Checks whether a Lua variable "Mute" is defined and true. More...
 
- Properties inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommand
bool IsPlaying [get, protected set]
 Indicates whether the command is still playing. More...
 
Sequencer Sequencer [get]
 Reference to the Sequencer, so you can access its properties such as SequencerCamera and CameraAngles. More...
 
string[] Parameters [get]
 The parameters for the command. More...
 
string endMessage [get]
 Optional message to send the sequencer when the command completes. More...
 
Transform?? speaker [get]
 
Transform?? listener [get]
 

Detailed Description

Sequencer command MAPlaySound(group, variation, volume, pitch, wait, subject, follow)

  • group: The name of the Sound Group to trigger a sound from.
  • variation: Play a specific variation by name. If blank, a random variation is played.
  • volume: Volume percentage (0-1). Default: 1.
  • pitch: Pitch adjustment. Leave blank for no pitch change.
  • wait: Specify true to wait until the sound is done playing. Default: false.
  • subject: GameObject whose position you want the sound to eminate from. Leave blank to play the sound 2D.
  • follow: Specify true to follow the subject. Leave blank to not follow.

Member Function Documentation

◆ Start()

IEnumerator PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandMAPlaySound.Start ( )

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