Component Sound

(NOTE) Plays a specified SoundCue, either when created or when the Play method is called.

Methods	Properties	Base Classes	Derived Classes
Play	Cue	component
Constructor	IsPlaying
Stop	Paused
	Positional
	StartPlaying

Properties

---

Cue : soundcue

var Cue : SoundCue

---

IsPlaying : boolean

read-only

Will be true if the SoundCue is currently being played.

var IsPlaying : Boolean

---

Paused : boolean

Setting this Property to true will pause a currently playing SoundCue. Setting it to false will resume playback.

var Paused : Boolean

---

Positional : boolean

If this property is true the SoundCue will be played positionally (heard at a specific location by SoundListeners) through the SoundEmitter component on the same object. If false, the SoundCue will be played through the SoundSpace, and will NOT be affected by any SoundEmitter settings.

var Positional : Boolean

---

StartPlaying : boolean

If this property is true the SoundCue will begin playing as soon as the object is created.

var StartPlaying : Boolean

---

Methods

---

Play : soundinstance

Begins playing the SoundCue chosen in the Cue property and returns the resulting SoundInstance. If already playing it will be stopped and re-started. |Name|Type|Description| |---|---|---|

function Play() : SoundInstance

---

SimpleSound : Void

constructor

Name	Type	Description

function SimpleSound()

---

Stop : Void

Stops a currently playing SoundInstance if it exists. |Name|Type|Description| |---|---|---|

function Stop()

---