UITooltipController.cs

Go to the documentation of this file.

using UnityEngine;
using System.Collections;
using HKI.Core.Loc;

namespace HKI.Core.UI
{
    [AddComponentMenu("HKI/UI/UITooltipController")]
    [RequireComponent(typeof(Canvas))]
    [DisallowMultipleComponent]
    public class UITooltipController : MonoBehaviour
    {
        // Public variables
        public static UITooltipController Instance { get; private set; }

        [Header("General Properties")]
        [SerializeField] GameObject TooltipWindowGO = null;        
        [SerializeField] GameObject TooltipTextGO = null;

        [SerializeField] Language Language = null;

        [SerializeField] float DelayTime = 2.0f;

        [SerializeField] Vector3 TopLeftOffset = new Vector3();
        [SerializeField] Vector3 TopRightOffset = new Vector3();
        [SerializeField] Vector3 BottomLeftOffset = new Vector3();
        [SerializeField] Vector3 BottomRightOffset = new Vector3();

        // Private variables
        Transform tooltipWindowTransform = null;

        TMProAndUGUITextAccessor tooltipText = null;

        UITooltip currentActiveTooltip = null;

        Coroutine showTooltipCoroutine = null;

        // Awake function
        void Awake()
        {
            if(Instance == null)
            {
                Instance = this;
                DontDestroyOnLoad(gameObject);
            }
            else
            {
                Destroy(gameObject);
                return;
            }

            if(TooltipWindowGO == null)
            {
                Debug.LogError("UITooltipController.Awake(): TooltipWindowGO is null!");
                return;
            }

            if(TooltipTextGO == null)
            {
                Debug.LogError("UITooltipController.Awake(): TooltipTextGO is null!");
                return;
            }

            tooltipWindowTransform = TooltipWindowGO.transform;

            tooltipText = new TMProAndUGUITextAccessor(TooltipTextGO);

            TooltipWindowGO.SetActive(false);
        }
        
        // OnDestroy
        void OnDestroy()
        {
            if(Instance == this)
                Instance = null;
        }
        
        // Interface functions
        public void ShowTooltip(UITooltip tooltip, TextLocalization textLocalization)
        {
            if(textLocalization == null)
            {
                Debug.LogError("(UITooltipController) you are trying use a text localization but the given text localization is null!");
                return;
            }

            if(showTooltipCoroutine != null)
            {
                StopCoroutine(showTooltipCoroutine);
                TooltipWindowGO.SetActive(false);
                showTooltipCoroutine = null;
                currentActiveTooltip = null;
            }

            currentActiveTooltip = tooltip;

            showTooltipCoroutine = StartCoroutine(ShowTooltipCoroutine(textLocalization));
        }

        public void HideTooltip(UITooltip tooltip)
        {
            if(currentActiveTooltip == tooltip)
            {
                StopCoroutine(showTooltipCoroutine);
                TooltipWindowGO.SetActive(false);
                showTooltipCoroutine = null;
                currentActiveTooltip = null;
            }
        }

        // Helper functions
        IEnumerator ShowTooltipCoroutine(TextLocalization textLocalization)
        {
            // Wait for some time until the tooltip should popup
            yield return new WaitForSeconds(DelayTime);

            // Set tooltip text
            if(Language != null)
                tooltipText.ChangeText(textLocalization.GetText(Language.Value));
            else
                tooltipText.ChangeText(textLocalization.GetDefaultText());

            switch(currentActiveTooltip.GetTooltipAlingment)
            {
                case UITooltip.TooltipAlingments.BottomRight:
                    ((RectTransform)tooltipWindowTransform).pivot = new Vector2(0.0f, 1.0f);
                    break;

                case UITooltip.TooltipAlingments.TopLeft:
                    ((RectTransform)tooltipWindowTransform).pivot = new Vector2(1.0f, 0.0f);
                    break;

                case UITooltip.TooltipAlingments.BottomLeft:
                    ((RectTransform)tooltipWindowTransform).pivot = new Vector2(1.0f, 1.0f);
                    break;

                case UITooltip.TooltipAlingments.TopRight:
                    ((RectTransform)tooltipWindowTransform).pivot = new Vector2(0.0f, 0.0f);
                    break;
            }

            UpdatePosition();

            TooltipWindowGO.SetActive(true);

            // Update position every frame
            bool updatePosition = true;
            while(updatePosition)
            {
                UpdatePosition();

                yield return null;
            }
        }

        void UpdatePosition()
        {
            switch (currentActiveTooltip.GetTooltipAlingment)
            {
                case UITooltip.TooltipAlingments.BottomRight:
                    tooltipWindowTransform.position = Input.mousePosition + BottomRightOffset;
                    break;

                case UITooltip.TooltipAlingments.TopLeft:
                    tooltipWindowTransform.position = Input.mousePosition + TopLeftOffset;
                    break;

                case UITooltip.TooltipAlingments.BottomLeft:
                    tooltipWindowTransform.position = Input.mousePosition + BottomLeftOffset;
                    break;

                case UITooltip.TooltipAlingments.TopRight:
                    tooltipWindowTransform.position = Input.mousePosition + TopRightOffset;
                    break;
            }
        }
    }
}