Class MusicPlayer

Namespace

TDMaker.Unity.View

Assembly

TDMaker.Unity.dll

Plays background music: a menu loop while no battle is shown, the level's battle loop (music, falling back to this component's defaults), an optional intense loop from configurable waves (last wave, waves flagged bossWave, or from a wave number) and victory / defeat stingers that stop or duck the loop. Changes crossfade between two pooled AudioSources; a third plays stingers. Volume = track × TDGameSettings Music × Master, routed to the Music mixer group when one is set. No allocation per frame; every clip is optional (an empty slot is silent).

[AddComponentMenu("2D Tower Defense Maker/Music Player")]
public sealed class MusicPlayer : MonoBehaviour

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

MusicPlayer

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.didStart

MonoBehaviour.didAwake

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.CompareTag(TagHandle)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.transformHandle

Component.gameObject

Component.tag

Object.GetEntityId()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectsByType(Type)

Object.FindObjectsByType(Type, FindObjectsInactive)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsByType<T>()

Object.FindObjectsByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

MusicPlayer()

public MusicPlayer()

Properties

BattleRoot

The object whose visibility selects battle music (null: battle music whenever a simulation runs).

public GameObject BattleRoot { get; set; }

Property Value

GameObject

Crossfade

Crossfade time in real seconds.

public float Crossfade { get; set; }

Property Value

float

Current

What is playing.

public MusicPlayer.State Current { get; }

Property Value

MusicPlayer.State

CurrentClip

The clip of the current loop, or null.

public AudioClip CurrentClip { get; }

Property Value

AudioClip

IsPlaying

Whether a loop is sounding.

public bool IsPlaying { get; }

Property Value

bool

IsStingerPlaying

Whether a stinger is sounding.

public bool IsStingerPlaying { get; }

Property Value

bool

MenuMusic

The default menu loop.

public AudioClip MenuMusic { get; set; }

Property Value

AudioClip

StingerClip

The stinger clip last started, or null.

public AudioClip StingerClip { get; }

Property Value

AudioClip

Methods

Configure(SimulationRunner, GameObject, AudioClip, AudioClip, AudioClip, AudioClip, AudioClip)

Assigns the runner, the optional battle root and the default clips; call before enabling.

public void Configure(SimulationRunner source, GameObject battle = null, AudioClip menu = null, AudioClip battleLoop = null, AudioClip intenseLoop = null, AudioClip victory = null, AudioClip defeat = null)

Parameters

source SimulationRunner

battle GameObject

menu AudioClip

battleLoop AudioClip

intenseLoop AudioClip

victory AudioClip

defeat AudioClip

CrossfadeTo(AudioClip, float)

Crossfades to clip at trackVolume (null fades out). The same clip already playing only changes its volume.

public void CrossfadeTo(AudioClip clip, float trackVolume)

Parameters

clip AudioClip

trackVolume float

IsIntenseWave(int)

Whether wave wave (one-based) switches the current level to its intense loop.

public bool IsIntenseWave(int wave)

Parameters

wave int

Returns

bool

PlayBattle(bool)

Crossfades to the level's battle loop, or its intense loop (falls back to the battle loop when there is none).

public void PlayBattle(bool intense)

Parameters

intense bool

PlayMenu()

Crossfades to the menu loop (silence when there is none).

public void PlayMenu()

PlayOutcome(bool)

Plays the victory or defeat stinger and stops or ducks the loop (once per run).

public void PlayOutcome(bool victory)

Parameters

victory bool

Stop()

Fades the loop out.

public void Stop()