PixelCrushers.QuestMachine.AudioQuestAction Class Reference

Plays an audio clip. More...

Inheritance diagram for PixelCrushers.QuestMachine.AudioQuestAction:

Collaboration diagram for PixelCrushers.QuestMachine.AudioQuestAction:

Public Member Functions
override string	GetEditorName ()
	Returns the name to show in the editor for this subasset.
override void	Execute ()
	Performs the quest action.
override void	OnBeforeProxySerialization ()
	Allows a subasset to save information in a serializable format prior to being serialized to a proxy object for saving.
override void	OnAfterProxyDeserialization ()
	Applies saved information from a proxy object.
override AudioClip[]	GetAudioClips ()
	Overide to return any audio clips that this content references.
Public Member Functions inherited from PixelCrushers.QuestMachine.QuestSubasset
virtual void	SetRuntimeReferences (Quest quest, QuestNode questNode)
	Sets quest references, as some subassets might need to refer to their containing quest and/or quest node.
virtual void	AddTagsToDictionary ()
	Records the static tags used in this asset's text content into the quest's staticTags property.
virtual Sprite[]	GetImages ()
	Override to return any images that this content references.
virtual void	CloneSubassetsInto (QuestSubasset copy)
	Allows subclasses to deep copy their own subassets by instantiating copies.
virtual void	DestroySubassets ()
	Allows subclasses to destroy their subassets, usually when a runtime instance of a quest is being destroyed.

Properties
AudioClip	audioClip [get, set]
	Audio clip to play.
QuestAudioSourceIdentifier	useAudioSourceOn [get, set]
	Identifies the audio source to use.
bool	interruptPreviousClip [get, set]
	If an audio clip is currently-playing on audio source, interrupt it.
Properties inherited from PixelCrushers.QuestMachine.QuestSubasset
Quest	quest [get, protected set]
	(Runtime) The quest that this condition belongs to.
QuestNode	questNode [get, protected set]
	(Runtime) The quest node that this condition belongs to.
TagDictionary	tagDictionary [get]
	(Runtime) The quest's tag dictionary.

Additional Inherited Members
Static Public Member Functions inherited from PixelCrushers.QuestMachine.QuestSubasset
static List< T >	CloneList< T > (List< T > original, Quest quest=null)
	Returns a deep copy of a QuestSubasset list.
static void	DestroyList< T > (List< T > list)
Protected Member Functions inherited from PixelCrushers.QuestMachine.QuestSubasset
virtual void	AddTagsToDictionary (StringField stringField)
	Adds any tags in the StringField to the tags dictionary.
virtual void	AddTagsToDictionary (string s)
	Adds any tags in the string to the tags dictionary.

Detailed Description

Plays an audio clip.

Member Function Documentation

Execute()

override void PixelCrushers.QuestMachine.AudioQuestAction.Execute ( )

inlinevirtual

Performs the quest action.

Reimplemented from PixelCrushers.QuestMachine.QuestAction.

GetAudioClips()

override AudioClip[] PixelCrushers.QuestMachine.AudioQuestAction.GetAudioClips ( )

inlinevirtual

Overide to return any audio clips that this content references.

Returns

Array of audio clips referenced by this content.

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

GetEditorName()

override string PixelCrushers.QuestMachine.AudioQuestAction.GetEditorName ( )

inlinevirtual

Returns the name to show in the editor for this subasset.

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

OnAfterProxyDeserialization()

override void PixelCrushers.QuestMachine.AudioQuestAction.OnAfterProxyDeserialization ( )

inlinevirtual

Applies saved information from a proxy object.

The base method doesn't do anything, but subclasses may need to.

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

OnBeforeProxySerialization()

override void PixelCrushers.QuestMachine.AudioQuestAction.OnBeforeProxySerialization ( )

inlinevirtual

Allows a subasset to save information in a serializable format prior to being serialized to a proxy object for saving.

The base method doesn't do anything, but subclasses may need to.

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

Property Documentation

audioClip

AudioClip PixelCrushers.QuestMachine.AudioQuestAction.audioClip

getset

Audio clip to play.

interruptPreviousClip

bool PixelCrushers.QuestMachine.AudioQuestAction.interruptPreviousClip

getset

If an audio clip is currently-playing on audio source, interrupt it.

Otherwise play in addition.

useAudioSourceOn

QuestAudioSourceIdentifier PixelCrushers.QuestMachine.AudioQuestAction.useAudioSourceOn

getset

Identifies the audio source to use.

---

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

• C:/Dev/Quest Machine/Dev/Source/Assets/Plugins/Pixel Crushers/Quest Machine/Scripts/Quest/Quest Subasset/Quest Action/AudioQuestAction.cs