Table of Contents

Class ToggleAudioHandler

Namespace
Fallencake.UI.Audio
Assembly
Fallencake.UI.dll

Audio handler for Toggle-like components via IToggleAudioProvider. Plays toggle on/off sounds.

public class ToggleAudioHandler : UIAudioHandler<IToggleAudioProvider>, IAudioEventHandler, IToggleAudioHandler, IAudioHandler
Inheritance
object
ToggleAudioHandler
Implements
Inherited Members

Constructors

ToggleAudioHandler(IToggleAudioProvider) 

public ToggleAudioHandler(IToggleAudioProvider provider)

Parameters

provider IToggleAudioProvider

Properties

ToggleOffSound

Sound when the toggle is deactivated.

public AudioClip ToggleOffSound { get; }

Property Value

AudioClip

ToggleOffSoundData 

public AudioData ToggleOffSoundData { get; }

Property Value

AudioData

ToggleOnSound

Sound when the toggle is activated.

public AudioClip ToggleOnSound { get; }

Property Value

AudioClip

ToggleOnSoundData 

public AudioData ToggleOnSoundData { get; }

Property Value

AudioData

Methods

Create(IToggleAudioProvider)

Static factory to create and configure the toggle audio handler. Ensures an UnityEngine.AudioSource exists when sounds are enabled.

public static ToggleAudioHandler Create(IToggleAudioProvider provider)

Parameters

provider IToggleAudioProvider

The toggle audio provider.

Returns

ToggleAudioHandler

New ToggleAudioHandler or null if sounds disabled.

PlayToggleOffSound()

Plays the toggle off sound.

public void PlayToggleOffSound()

PlayToggleOnSound()

Plays the toggle on sound.

public void PlayToggleOnSound()