SceneLoaderController.cs

Go to the documentation of this file.

using UnityEngine;
using UnityEngine.UI;
using UnityEngine.SceneManagement;
using System.Collections;
using HKI.Core.UI;
using HKI.Core.Loc;
using HKI.Core.GameEvents;

namespace HKI.Core.Scenes
{
    public class SceneLoaderController : MonoBehaviour
    {
        // Public variables
        [SerializeField] GameObject FaderGO = null;

        [SerializeField] CanvasGroup FaderCanvasGroup = null;

        [SerializeField] GameObject VisualsGO = null;

        [SerializeField] GameObject InfoTextGO = null;

        [SerializeField] GameEvent LoadingSceneUnloadedEvent = null;

        // Private variables
        TMProAndUGUITextAccessor infoText = null;

        // Awake function
        void Awake()
        {
            infoText = new TMProAndUGUITextAccessor(InfoTextGO);

            infoText.ChangeText("");
            
            FaderCanvasGroup.alpha = 0.0f;

            HideVisuals();
        }

        // Interface functions
        public void ShowVisuals()
        {
            if (VisualsGO != null)
                VisualsGO.SetActive(true);
        }

        public void HideVisuals()
        {
            if (VisualsGO != null)
                VisualsGO.SetActive(false);
        }

        public void ChangInfoText(TextLocalization textLocalization, Language textLanguage)
        {
            if(textLocalization == null)
            {
                Debug.LogError("(SceneLoaderController) you are trying to change the info text but the given textLocalization is null!)");
                return;
            }

            infoText.ChangeText(textLocalization.GetText(textLanguage));
        }

        public void LoadScene(string loadingScene, string scene, bool directLoad = true, float fadeInTime = 1.0f, float fadeOutTime = 1.0f, bool doFading = true)
        {
            if(!DoesSceneExist(scene))
            {
                Debug.LogError("(SceneLoaderController) you are trying to load a scene that doesn't exist! (Maybe you need to add the scene to the build settings scenes!)");
                return;
            }

            if (directLoad)
                StartCoroutine(SceneLoadingDirectly(scene, fadeInTime, fadeOutTime, doFading));
            else
                StartCoroutine(SceneLoadingWithLoadingScene(loadingScene, scene, fadeInTime, fadeOutTime, doFading));
        }

        public void LoadSceneAdditively(string scene)
        {
            if (!DoesSceneExist(scene))
            {
                Debug.LogError("(SceneLoader) you are trying to load a scene that doesn't exist! (Maybe you need to add the scene to the build settings scenes!)");
                return;
            }

            StartCoroutine(SceneLoadingAdditively(scene));
        }
        
        // Coroutine functions
        IEnumerator SceneLoadingDirectly(string scene, float fadeInTime, float fadeOutTime, bool doFading)
        {
            if(doFading)
                yield return StartCoroutine(Fade(fadeInTime, true));

            yield return SceneManager.LoadSceneAsync(scene, LoadSceneMode.Single);
            
            if(doFading)
                yield return StartCoroutine(Fade(fadeOutTime, false));
        }

        IEnumerator SceneLoadingWithLoadingScene(string loadingScene, string scene, float fadeInTime, float fadeOutTime, bool doFading)
        {
            if (doFading)
                yield return StartCoroutine(Fade(fadeInTime, true));

            yield return SceneManager.LoadSceneAsync(loadingScene, LoadSceneMode.Single);

            ShowVisuals();

            infoText.ChangeText("");
    

            if (doFading)
                yield return StartCoroutine(Fade(fadeOutTime, false));


            yield return SceneLoadingAdditively(scene);

            yield return new WaitForSecondsRealtime(1.0f);

            if (doFading)
                yield return StartCoroutine(Fade(fadeInTime, true));

            if (LoadingSceneUnloadedEvent != null)
                LoadingSceneUnloadedEvent.Raise();

            HideVisuals();

            yield return SceneManager.UnloadSceneAsync(loadingScene);

            if(doFading)
                yield return StartCoroutine(Fade(fadeOutTime, false));
        }

        IEnumerator SceneLoadingAdditively(string scene)
        {
            yield return SceneManager.LoadSceneAsync(scene, LoadSceneMode.Additive);
        }
        
        // Helper functions
        bool DoesSceneExist(string scene)
        {
            return !string.IsNullOrEmpty(scene);
        }

        IEnumerator Fade(float fadingTime, bool fadeIn)
        {
            float timeSinceFadingStart = 0.0f;
            
            FaderCanvasGroup.alpha = fadeIn ? 0.0f : 1.0f;

            while (timeSinceFadingStart < fadingTime)
            {
                timeSinceFadingStart += Time.unscaledDeltaTime;

                if(fadeIn)
                    FaderCanvasGroup.alpha = Mathf.Lerp(0.0f, 1.0f, timeSinceFadingStart / fadingTime);
                else
                    FaderCanvasGroup.alpha = Mathf.Lerp(1.0f, 0.0f, timeSinceFadingStart / fadingTime);

                yield return null;
            }
            
            FaderCanvasGroup.alpha = fadeIn ? 1.0f : 0.0f;

            yield break;
        }
    }
}