SfxManager

SfxManager#

NAMESPACE:

UnityUtils.ScriptUtils.Audio

The SfxManager is used to easily play sound effects with preset volumes from the AudioManager script, and add random pitch variance.

  • Default pitch variance is 0.1.

Example Usage#

using UnityEngine;
using UnityUtils.ScriptUtils.Audio;

public class ExampleScript : MonoBehaviour
{
     public AudioClip clip;

     void Start()
     {
        // Play basic SFX
        SfxManager.PlaySfxAudioClip(clip, 1, 0.6);

        // Play sfx clip for set amount of time
        SfxManager.PlayTimedSFXAudioClip(clip, 1);
     }
}

Functions#

UnityUtils.ScriptUtils.Audio.SfxManager

Public Static Functions

void PlaySfxAudioClip (AudioClip clip, float volume=1, float pitchVariance=default, AudioManager.VolumeType type=AudioManager.VolumeType.Sfx)

Plays an AudioClip globally (non-spacialy) at a certain volume with a pitch variance (to feel less repetative).

Parameters:

  • clip – AudioClip to play.

  • volume – Playback volume.

  • pitchVariance – Random variance to make sound feel less repetative. randomly modifies the pitch of the MusicAudioSource in a random of 1 - pitchVariance, and 1 + pitchVariance (AudioManager.DEFAULT_PITCH_VARIANCE is the default value).

void PlayTimedSFXAudioClip (AudioClip clip, float time, float volume=1, AudioManager.VolumeType type=AudioManager.VolumeType.Sfx)

Plays an AudioClip globally (non-spacialy) at a certain volume for a set amount of time.

Parameters:

  • clip – AudioClip to play

  • time – Specified time for AudioClip to play for in seconds.

  • volume – Playback volume.

void PlaySpacialSfxAudioClip (AudioClip clip, Vector3 position, float volume=1, float pitchVariance=default, AudioManager.VolumeType type=AudioManager.VolumeType.Sfx)

Plays an AudioClip spacially (Changes volume and L/R volume channel based on location) at a certain volume with a pitch variance (to feel less repetative).

Parameters:

  • clip – AudioClip to play.

  • position – Position to play AudioClip at.

  • volume – Playback volume.

  • pitchVariance – Random variance to make sound feel less repetative. randomly modifies the pitch of the MusicAudioSource in a random of 1 - pitchVariance, and 1 + pitchVariance (DEFAULT_PITCH_VARIANCE is the default value).

void PlayClipOnSource (AudioClip clip, AudioSource source, float volume=1, float pitchVariance=default, AudioManager.VolumeType audioType=AudioManager.VolumeType.Sfx)

Plays an AudioClip on an already existing AudioSource at a certain volume with a pitch variance (to feel less repetative).

Parameters:

  • volume – Playback volume.

  • audioType – used to get the proper volume, see AudioManager.CalculateVolumeBasedOnType(float, AudioManager.VolumeType) to get more info.

  • pitchVariance – Random variance to make sound feel less repetative. randomly modifies the pitch of the MusicAudioSource in a random of 1 - pitchVariance, and 1 + pitchVariance (DEFAULT_PITCH_VARIANCE is the default value).

Contents