net.dreditor.audio 0.0.0-stage → 0.1.7

package/SFXManager.cs

@@ -0,0 +1,348 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Linq;
+using UnityEngine;
+using UnityEngine.Serialization;
+
+
+#if FMOD_UNITY
+using FMODUnity;
+#endif
+
+namespace DREditor.Audio
+{
+    /// <summary>
+    ///
+    /// </summary>
+    public class SFXManager : SFXManagerBase
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        [Header("")]
+        [Divider]
+        [Tooltip("")]
+        [SerializeField] bool debugLogs = false;
+
+
+        [Header("")]
+        [Divider]
+#if FMOD_UNITY
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected StudioEventEmitter sfxSource = null;
+#else
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected AudioSource sfxSource = null;
+#endif
+
+#if FMOD_UNITY
+        /// <summary>
+        ///
+        /// </summary>
+        [Header("")]
+        [Divider]
+        [FormerlySerializedAs("SubmitSource")]
+        [Tooltip("")]
+        [SerializeField] protected StudioEventEmitter submitSource = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [FormerlySerializedAs("CancelSource")]
+        [Tooltip("")]
+        [SerializeField] protected StudioEventEmitter cancelSource = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [FormerlySerializedAs("SelectSource")]
+        [Tooltip("")]
+        [SerializeField] protected StudioEventEmitter selectSource = null;
+#else
+        /// <summary>
+        ///
+        /// </summary>
+        [Header("")]
+        [Divider]
+        [FormerlySerializedAs("SubmitSource")]
+        [Tooltip("")]
+        [SerializeField] protected AudioSource submitSource = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [FormerlySerializedAs("CancelSource")]
+        [Tooltip("")]
+        [SerializeField] protected AudioSource cancelSource = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [FormerlySerializedAs("SelectSource")]
+        [Tooltip("")]
+        [SerializeField] protected AudioSource selectSource = null;
+#endif
+
+        /// <inheritdoc/>
+        protected override void InitializeService()
+        {
+            base.InitializeService();
+#if FMOD_UNITY
+            if (sfxSource == null)
+                sfxSource = GetComponentInChildren<StudioEventEmitter>();
+#else
+            if (sfxSource == null)
+                sfxSource = GetComponentInChildren<AudioSource>();
+#endif
+        }
+
+        /// <inheritdoc/>
+        public override void PlaySubmit() => PlaySource(submitSource);
+
+        /// <inheritdoc/>
+        public override void PlayCancel() => PlaySource(cancelSource);
+
+        /// <inheritdoc/>
+        public override void PlaySelect() => PlaySource(selectSource);
+
+
+        /// <inheritdoc/>
+        public override void PlaySFX<T>(T name)
+        {
+#if FMOD_UNITY
+            if (name is string eventName)
+            {
+                if (eventName == "")
+                {
+                    if (debugLogs)
+                        UnityEngine.Debug.LogWarning("ALERT: CANCELED SFX: " + eventName);
+
+                    return;
+                }
+
+                if (debugLogs)
+                    UnityEngine.Debug.Log("REPORT: Playing SFX: " + eventName);
+
+                if (!sfxSource.IsPlaying())
+                    PlaySource(sfxSource, eventName);
+                else
+                    PlayAdditionalSoundInstance(eventName);
+            }
+#else
+            if (name is AudioClip eventName)
+            {
+                if (eventName == null)
+                {
+                    if (debugLogs)
+                        UnityEngine.Debug.LogWarning("ALERT: CANCELED SFX: " + eventName);
+
+                    return;
+                }
+
+                if (debugLogs)
+                    UnityEngine.Debug.Log("REPORT: Playing SFX: " + eventName);
+
+                if (!sfxSource.isPlaying)
+                    PlaySource(sfxSource, eventName);
+                else
+                    PlayAdditionalSoundInstance(eventName);
+            }
+#endif
+        }
+
+#if FMOD_UNITY
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="eventName"></param>
+        protected virtual void PlayAdditionalSoundInstance(string eventName)
+        {
+            var emitter = gameObject.AddComponent<StudioEventEmitter>();
+
+            emitter.Event = eventName;
+
+            emitter.TriggerOnce = true;
+
+            emitter.Play();
+
+            StartCoroutine(WaitForInstanceSFXToFinish(emitter));
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="emitter"></param>
+        /// <returns></returns>
+        protected virtual IEnumerator WaitForInstanceSFXToFinish(StudioEventEmitter emitter)
+        {
+            while (emitter.IsPlaying())
+                yield return null;
+
+            Destroy(emitter);
+
+            yield break;
+        }
+
+        /// <inheritdoc/>
+        public override void StopSoundFX()
+        {
+            sfxSource.Stop();
+
+            StopAllInstanceEmitters();
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected virtual void StopAllInstanceEmitters()
+        {
+            AffectInstanceEmitters((emitter) => emitter.Stop());
+
+            AffectInstanceEmitters((emitter) => Destroy(emitter));
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="affectEmitter"></param>
+        protected virtual void AffectInstanceEmitters(Action<StudioEventEmitter> affectEmitter)
+        {
+            List<StudioEventEmitter> emitters = GetComponents<StudioEventEmitter>().ToList();
+
+            if (emitters.Count > 0)
+                foreach (StudioEventEmitter emitter in emitters)
+                    if (emitter != null)
+                        affectEmitter(emitter);
+        }
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="emitter"></param>
+        protected virtual void PlaySource(StudioEventEmitter emitter)
+        {
+            if (!(emitter != null) || emitter.Event == "")
+                return;
+
+            emitter.Play();
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="source"></param>
+        /// <param name="eventName"></param>
+        protected virtual void PlaySource(StudioEventEmitter source, string eventName)
+        {
+            if (eventName == "" || source == null)
+                return;
+
+            source.Stop();
+
+            source.Event = eventName;
+
+            source.Play();
+        }
+#else
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="eventName"></param>
+        protected virtual void PlayAdditionalSoundInstance(AudioClip eventName)
+        {
+            var emitter = gameObject.AddComponent<AudioSource>();
+
+            emitter.clip = eventName;
+
+            emitter.Play();
+
+            StartCoroutine(WaitForInstanceSFXToFinish(emitter));
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="emitter"></param>
+        /// <returns></returns>
+        protected virtual IEnumerator WaitForInstanceSFXToFinish(AudioSource emitter)
+        {
+            while (emitter.isPlaying)
+                yield return null;
+
+            Destroy(emitter);
+
+            yield break;
+        }
+
+        public override void StopSoundFX()
+        {
+            sfxSource.Stop();
+
+            StopAllInstanceEmitters();
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected virtual void StopAllInstanceEmitters()
+        {
+            AffectInstanceEmitters((emitter) => emitter.Stop());
+
+            AffectInstanceEmitters((emitter) => Destroy(emitter));
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="affectEmitter"></param>
+        protected virtual void AffectInstanceEmitters(Action<AudioSource> affectEmitter)
+        {
+            List<AudioSource> emitters = GetComponents<AudioSource>().ToList();
+
+            if (emitters.Count > 0)
+                foreach (AudioSource emitter in emitters)
+                    if (emitter != null)
+                        affectEmitter(emitter);
+        }
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="source"></param>
+        protected virtual void PlaySource(AudioSource source)
+        {
+            if (!(source != null) || source.clip == null)
+                return;
+
+            source.Play();
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="source"></param>
+        /// <param name="clip"></param>
+        protected virtual void PlaySource(AudioSource source, AudioClip clip)
+        {
+            if (clip == null || source == null)
+                return;
+
+            source.Stop();
+
+            source.clip = clip;
+
+            source.Play();
+        }
+#endif
+    }
+}

package/SFXManager.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 10fafe8fe726c4c40ab9996aeb682dc3
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/SFXManagerBase.cs

@@ -0,0 +1,38 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+
+namespace DREditor.Audio
+{
+    /// <summary>
+    ///
+    /// </summary>
+    /// <remarks></remarks>
+    public abstract class SFXManagerBase : SoundService<SFXManagerBase>
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="eventName"></param>
+        public abstract void PlaySFX<T>(T eventName);
+
+        /// <summary>
+        ///
+        /// </summary>
+        public abstract void StopSoundFX();
+
+        /// <summary>
+        ///
+        /// </summary>
+        public abstract void PlayCancel();
+
+        /// <summary>
+        ///
+        /// </summary>
+        public abstract void PlaySelect();
+
+        /// <summary>
+        ///
+        /// </summary>
+        public abstract void PlaySubmit();
+    }
+}

package/SFXManagerBase.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 8cc1f3e5447f0a148838cb2da7720bad
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Samples~/Audio_Event_Save_Handler.prefab

@@ -0,0 +1,57 @@
+%YAML 1.1
+%TAG !u! tag:unity3d.com,2011:
+--- !u!1 &2342656775065836890
+GameObject:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  serializedVersion: 6
+  m_Component:
+  - component: {fileID: 7750639106472776802}
+  - component: {fileID: 1102193611957596205}
+  m_Layer: 0
+  m_Name: Audio_Event_Save_Handler
+  m_TagString: Untagged
+  m_Icon: {fileID: 0}
+  m_NavMeshLayer: 0
+  m_StaticEditorFlags: 0
+  m_IsActive: 1
+--- !u!4 &7750639106472776802
+Transform:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 2342656775065836890}
+  m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
+  m_LocalPosition: {x: 0, y: 0, z: 0}
+  m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
+  m_Children: []
+  m_Father: {fileID: 0}
+  m_RootOrder: 0
+  m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
+--- !u!114 &1102193611957596205
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 2342656775065836890}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: 1962043c122f1234fb6461221e02bd73, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
+  entries:
+  - key: BGMVolume
+    value: {fileID: 11400000, guid: c7fc2ceefddb5f74f940b8c2f6a0f729, type: 2}
+    skipOnChapterSelect: 0
+  - key: SFXVolume
+    value: {fileID: 11400000, guid: 4a74a22a65d816249bc71f82549ba217, type: 2}
+    skipOnChapterSelect: 0
+  - key: VoiceVolume
+    value: {fileID: 11400000, guid: 16eddaab211bf4745aec60708aeb95bd, type: 2}
+    skipOnChapterSelect: 0
+  isLoadingFile: {fileID: 11400000, guid: 1d94fdc8796dc9f43b2a3bedb0f5d4dd, type: 2}

package/Samples~/Audio_Event_Save_Handler.prefab.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: a81ae91ecc0f65c42b0c1c3d32f7f6cb
+PrefabImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Samples~/Credits_Music_Unity.prefab

@@ -0,0 +1,66 @@
+%YAML 1.1
+%TAG !u! tag:unity3d.com,2011:
+--- !u!1 &4072052309038271164
+GameObject:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  serializedVersion: 6
+  m_Component:
+  - component: {fileID: 4072052309038271163}
+  - component: {fileID: 4072052309038271162}
+  - component: {fileID: 4072052309038271165}
+  m_Layer: 0
+  m_Name: Credits_Music_Unity
+  m_TagString: Untagged
+  m_Icon: {fileID: 0}
+  m_NavMeshLayer: 0
+  m_StaticEditorFlags: 0
+  m_IsActive: 1
+--- !u!4 &4072052309038271163
+Transform:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 4072052309038271164}
+  m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
+  m_LocalPosition: {x: 0, y: 0, z: 0}
+  m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
+  m_Children: []
+  m_Father: {fileID: 0}
+  m_RootOrder: 0
+  m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
+--- !u!114 &4072052309038271162
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 4072052309038271164}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: 29bd65863043a0b44a511502a9c1f525, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
+  onLeavingCredits: {fileID: 4072052309038271165}
+  musicEvents: []
+--- !u!114 &4072052309038271165
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 4072052309038271164}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: 9122f094a109f78448db952c36a264a9, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
+  Event: {fileID: 11400000, guid: ca68761f388344540a47fdaf29d030b8, type: 2}
+  Response:
+    m_PersistentCalls:
+      m_Calls: []
+  Condition: {fileID: 0}

package/Samples~/Credits_Music_Unity.prefab.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: ea1f7d93d8e048a49af1b2f80978bb98
+PrefabImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Samples~/Dialogue_Click_Sound_Player_DRE.prefab

@@ -0,0 +1,76 @@
+%YAML 1.1
+%TAG !u! tag:unity3d.com,2011:
+--- !u!1001 &3635727860718540364
+PrefabInstance:
+  m_ObjectHideFlags: 0
+  serializedVersion: 2
+  m_Modification:
+    m_TransformParent: {fileID: 0}
+    m_Modifications:
+    - target: {fileID: 4799304048915999206, guid: ea0724de84e9e5949847f5819fac1364,
+        type: 3}
+      propertyPath: clipSFX
+      value: 
+      objectReference: {fileID: 8300000, guid: fc0b4b49047382d4ea110a6a80353608, type: 3}
+    - target: {fileID: 4799304048915999207, guid: ea0724de84e9e5949847f5819fac1364,
+        type: 3}
+      propertyPath: m_RootOrder
+      value: 0
+      objectReference: {fileID: 0}
+    - target: {fileID: 4799304048915999207, guid: ea0724de84e9e5949847f5819fac1364,
+        type: 3}
+      propertyPath: m_LocalPosition.x
+      value: 0
+      objectReference: {fileID: 0}
+    - target: {fileID: 4799304048915999207, guid: ea0724de84e9e5949847f5819fac1364,
+        type: 3}
+      propertyPath: m_LocalPosition.y
+      value: 0
+      objectReference: {fileID: 0}
+    - target: {fileID: 4799304048915999207, guid: ea0724de84e9e5949847f5819fac1364,
+        type: 3}
+      propertyPath: m_LocalPosition.z
+      value: 0
+      objectReference: {fileID: 0}
+    - target: {fileID: 4799304048915999207, guid: ea0724de84e9e5949847f5819fac1364,
+        type: 3}
+      propertyPath: m_LocalRotation.w
+      value: 1
+      objectReference: {fileID: 0}
+    - target: {fileID: 4799304048915999207, guid: ea0724de84e9e5949847f5819fac1364,
+        type: 3}
+      propertyPath: m_LocalRotation.x
+      value: 0
+      objectReference: {fileID: 0}
+    - target: {fileID: 4799304048915999207, guid: ea0724de84e9e5949847f5819fac1364,
+        type: 3}
+      propertyPath: m_LocalRotation.y
+      value: 0
+      objectReference: {fileID: 0}
+    - target: {fileID: 4799304048915999207, guid: ea0724de84e9e5949847f5819fac1364,
+        type: 3}
+      propertyPath: m_LocalRotation.z
+      value: 0
+      objectReference: {fileID: 0}
+    - target: {fileID: 4799304048915999207, guid: ea0724de84e9e5949847f5819fac1364,
+        type: 3}
+      propertyPath: m_LocalEulerAnglesHint.x
+      value: 0
+      objectReference: {fileID: 0}
+    - target: {fileID: 4799304048915999207, guid: ea0724de84e9e5949847f5819fac1364,
+        type: 3}
+      propertyPath: m_LocalEulerAnglesHint.y
+      value: 0
+      objectReference: {fileID: 0}
+    - target: {fileID: 4799304048915999207, guid: ea0724de84e9e5949847f5819fac1364,
+        type: 3}
+      propertyPath: m_LocalEulerAnglesHint.z
+      value: 0
+      objectReference: {fileID: 0}
+    - target: {fileID: 4799304048915999208, guid: ea0724de84e9e5949847f5819fac1364,
+        type: 3}
+      propertyPath: m_Name
+      value: Dialogue_Click_Sound_Player_DRE
+      objectReference: {fileID: 0}
+    m_RemovedComponents: []
+  m_SourcePrefab: {fileID: 100100000, guid: ea0724de84e9e5949847f5819fac1364, type: 3}

package/Samples~/Dialogue_Click_Sound_Player_DRE.prefab.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 54be6537de1f14e49bf55b2eca7bf90a
+PrefabImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: