Class: AudioComponent

Entity-attached audio source. AudioSystem wires _audio on add; Play()/Stop()/etc. delegate to it. Single-source semantic (Play stops the previous instance). For overlapping playback, use PlayOneShot.

Extends

• Component

Constructors

Constructor

new AudioComponent(
   assetId?, 
   volume?, 
   loop?, 
   playOnAwake?, 
   pitch?, 
   muted?
): AudioComponent;

Parameters

Parameter	Type	Default value
assetId	string | AudioClip	''
volume	number	1
loop	boolean	false
playOnAwake	boolean	false
pitch	number	1
muted	boolean	false

Returns

AudioComponent

Overrides

Component.constructor

Properties

Property	Modifier	Type	Default value	Inherited from
assetId	public	string	undefined	-
dirty	public	boolean	true	Component.dirty
enabled	public	boolean	true	Component.enabled
loop	public	boolean	undefined	-
muted	public	boolean	undefined	-
pitch	public	number	undefined	-
playOnAwake	public	boolean	undefined	-
volume	public	number	undefined	-

Accessors

audioClip

Get Signature

get audioClip(): AudioClip;

Returns

AudioClip

Set Signature

set audioClip(c): void;

Parameters

Parameter	Type
c	AudioClip

Returns

void

Methods

ApplyVolume()

ApplyVolume(): void;

Push volume/muted to the live instance without restarting. Call after mutating either.

Returns

void

---

IsPlaying()

IsPlaying(): boolean;

Returns

boolean

---

Pause()

Pause(): void;

Returns

void

---

Play()

Play(): void;

Returns

void

---

PlayOneShot()

PlayOneShot(assetId, volumeScale?): number;

Fire-and-forget overlapping instance. Doesn't touch this.assetId.

Parameters

Parameter	Type	Default value
assetId	string	undefined
volumeScale	number	1

Returns

number

---

Resume()

Resume(): void;

Returns

void

---

Stop()

Stop(): void;

One-shots continue to natural end.

Returns

void