PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait Class Reference

Implements sequencer command: AudioWait(audioClip[, subject[, audioClips...]]) More...

Inheritance diagram for PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait:

Collaboration diagram for PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait:

Public Member Functions
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
static float	GetAudioClipLength (AudioSource audioSource, AudioClip audioClip)

Protected Member Functions
virtual AudioSource	GetAudioSource (Transform subject)
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).
T	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.

Protected Attributes
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

Additional Inherited Members
Public Attributes inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommand
bool	isPlaying = true
	Indicates whether the command is still playing.
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

Implements sequencer command: AudioWait(audioClip[, subject[, audioClips...]])

Member Function Documentation

GetAudioClipLength()

static float PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait.GetAudioClipLength ( AudioSource  audioSource, AudioClip  audioClip  )

inlinestatic

GetAudioSource()

virtual AudioSource PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait.GetAudioSource ( Transform  subject )

inlineprotectedvirtual

Reimplemented in PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandSALSA, and PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandSALSA.

OnDestroy()

virtual void PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait.OnDestroy ( )

inlinevirtual

OnDialogueSystemPause()

virtual void PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait.OnDialogueSystemPause ( )

inlinevirtual

OnDialogueSystemUnpause()

virtual void PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait.OnDialogueSystemUnpause ( )

inlinevirtual

Start()

virtual IEnumerator PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait.Start ( )

inlinevirtual

TryAudioClip()

virtual void PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait.TryAudioClip ( string  audioClipName )

inlineprotectedvirtual

Update()

virtual void PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait.Update ( )

inlinevirtual

Member Data Documentation

audioClipName

string PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait.audioClipName

protected

audioSource

AudioSource PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait.audioSource = null

protected

currentClip

AudioClip PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait.currentClip = null

protected

isLoadingAudio

bool PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait.isLoadingAudio = false

protected

nextClipIndex

int PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait.nextClipIndex = 2

protected

originalClip

AudioClip PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait.originalClip = null

protected

playedAudio

bool PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait.playedAudio = false

protected

restoreOriginalClip

bool PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait.restoreOriginalClip = false

protected

stopTime

float PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandAudioWait.stopTime = 0

protected

---

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

• C:/Dev/Dialogue System/Dev/Release2/Assets/Plugins/Pixel Crushers/Dialogue System/Scripts/MVC/Sequencer/Commands/SequencerCommandAudioWait.cs