MusicClip

MusicClip#

NAMESPACE:

UnityUtils.ScriptUtils.Audio

An abstract class that is used in MusicManager. Has a BackgroundMusic which acts as an example, and also will always be played.

Example Usage#

[CreateAssetMenu(fileName = "BackgroundMusic", menuName = "UnityUtils/Audio/Background Music", order = 0)]
public class BackgroundMusic : MusicClip
{
  public override bool CanBePlayed()
  {
    // Add logic to decide if this clip can be played
    return true;
  }
}

Functions#

UnityUtils.ScriptUtils.Audio.MusicClip : ScriptableObject

Subclassed by UnityUtils.ScriptUtils.Audio.BackgroundMusic

Public Functions

bool CanBePlayed()#

return:

If true, the clip can be played when picking music

Public Members

AudioClip musicClip#

The music clip played.

string musicName = "Music Clip [UnityUtils.ScriptUtils.Audio]"#

The name of this music clip.

SFXVolumeSettings volumeSettings  = new SFXVolumeSettings().SetVolume(1, AudioManager.VolumeType.Music)

The SFXVolumeSettings for this music clip.

SFXPitchSettings pitchSettings  = new SFXPitchSettings().SetPitch(0, 1)

The SFXPitchSettings for this music clip.