docs: Update audio engine

Author: jcs090218

Assets/JCSUnity/Scripts/UI/Slider/JCS_SoundSlider.cs

@@ -25,11 +25,11 @@ public class JCS_SoundSlider : MonoBehaviour
 
         [Separator("Initialize Variables (JCS_SoundSlider)")]
 
-        [Tooltip("The mixer to control.")]
+        [Tooltip("The mixer to control; if null assign the default mixer.")]
         [SerializeField]
         private AudioMixer mMixer = null;
 
-        [Tooltip("The target float parameter.")]
+        [Tooltip("The target volume parameter.")]
         [SerializeField]
         private string mParameter = "";
 
@@ -50,6 +50,10 @@ private void Awake()
 
         private void Start()
         {
+            // Assign default mixer.
+            if (mMixer == null)
+                mMixer = JCS_SoundSettings.instance.MIXER;
+
             AddListener();
         }
 

Assets/JCSUnity/Scripts/Util/JCS_Util.cs

@@ -15,7 +15,6 @@
 using UnityEngine.Audio;
 using UnityEngine.SceneManagement;
 using PeterVuorela.Tweener;
-using System.Data.Common;
 
 namespace JCSUnity
 {
@@ -1305,7 +1304,7 @@ public static float GetLayerWeight(Animator ator, int index)
         #region Audio
 
         /// <summary>
-        /// Return the float value from audio mixer.
+        /// Return a float value from the audio mixer.
         /// </summary>
         public static float GetFloat(AudioMixer mixer, string parameter)
         {

docs/ScriptReference/Actions/JCS_SoundPoolAction.md

@@ -7,7 +7,6 @@ A pool of audio clips.
 | Name              | Description                       |
 |:------------------|:----------------------------------|
 | mAudioClips       | Pool of audio clips.              |
-| mSoundSettingType | Sound type you want to organized. |
 
 ## Functions
 

docs/ScriptReference/Actions/JCS_SoundProxyAction.md

@@ -8,4 +8,3 @@ the game object will be destroyed.
 | Name              | Description          |
 |:------------------|:---------------------|
 | mAudioClip        | Sound to plays.      |
-| mSoundSettingType | Sound settings type. |

docs/ScriptReference/Actions/JCS_SwingAttackAction.md

@@ -19,7 +19,6 @@ Action to do swing attack.
 | mAnimOffsetPosition    | Animation offset position value.                                                 |
 | mAnimOffsetScale       | Animation offset scale value.                                                    |
 | mAudioClip             | Sound to play for this action.                                                   |
-| mSoundType             | Sound settings type.                                                             |
 | mApplyDamageTextAction | If you want the action apply damage text add apply this.                         |
 | mKeyCode               | Key to active attack.                                                            |
 | mSpeedLayer            | Speed layer.                                                                     |

docs/ScriptReference/Effects/Pool/JCS_SoundPool.md

@@ -7,7 +7,6 @@ Pool of sound.
 | Name              | Description                      |
 |:------------------|:---------------------------------|
 | mAudioClips       | Pool of the audio clips.         |
-| mSoundSettingType | Sound type you want to organize. |
 
 ## Functions
 

docs/ScriptReference/Enums/JCS_SoundSettingType.md

@@ -17,6 +17,3 @@ Manage of all the music, sound and SFX in the game.
 |:------------------|:-----------------------------------------------------|
 | SwitchBGM         | Switch the background music, fading in and out.      |
 | PlayOneShotBGM    | Play one shot background music, after playing it.    |
-| PlayOneShotEffect | Push to the sound effect into array ready for use!   |
-| SetVolume         | Set the sound volume base on type.                   |
-| SetMute           | Set weather the sound are mute or not by sound type. |

docs/ScriptReference/Managers/JCS_SoundManager.md

@@ -6,12 +6,7 @@ Sound related settings.
 
 | Name                              | Description                                                   |
 |:----------------------------------|:--------------------------------------------------------------|
-| BGM_MUTE                          | Background music mute?                                        |
-| EFFECT_MUTE                       | SFX mute?                                                     |
-| PERFONAL_EFFECT_MUTE              | Player sound effect mute?                                     |
-| BGM_SOUND                         | Background music volume.                                      |
-| SFX_SOUND                         | SFX volume.                                                   |
-| SKILLS_SOUND                      | Play sound volume.                                            |
+| MIXER                             | The current audio mixer.                                      |
 | SOUND_FADEOUT_TIME                | Time to fade out the background music.                        |
 | SOUND_FADEIN_TIME                 | Time to fade in the background music.                         |
 | KEEP_BGM_SWITCH_SCENE             | Keep the background music when switch to next scene.          |

docs/ScriptReference/Settings/JCS_SoundSettings.md

@@ -4,6 +4,7 @@ Slider component to control framework's sound control.
 
 ## Variables
 
-| Name                       | Description                                                      |
-|:---------------------------|:-----------------------------------------------------------------|
-| mSoundType                 | Sound type you would like the slider to control.                 |
+| Name       | Description                                             |
+|:-----------|:--------------------------------------------------------|
+| mMixer     | The mixer to control; if null assign the default mixer. |
+| mParameter | The target volume parameter.                            |