using System;
using ActionGame;
using UnityEngine;

namespace KKAPI.MainGame
{
    /// <summary>
    /// Base type for custom game extensions.
    /// It provides many useful methods that abstract away the nasty hooks needed to figure out when the state of the game
    /// changes.
    /// 
    /// This controller is a MonoBehaviour that is created upon registration in <see cref="GameAPI.RegisterExtraBehaviour{T}"/>.
    /// The controller is created only once. If it's created too late it might miss some events.
    /// It's recommended to register controllers in your Start method.
    /// </summary>
    public abstract class GameCustomFunctionController : MonoBehaviour
    {
        // todo in the future add extended save to game saves

        private static Cycle _cycle;

        /// <summary>
        /// Extended save ID used by this function controller
        /// </summary>
        [Obsolete("Not yet implemented")]
        public string ExtendedDataId { get; internal set; }

        /// <summary>
        /// Triggered when the H scene is ended, but before it is unloaded.
        /// Warning: This is triggered in free H as well!
        /// </summary>
        /// <param name="proc">H scene controller instance</param>
        /// <param name="freeH">If true, the h scene was started from Main menu > Extra > FreeH</param>
        protected internal virtual void OnEndH(HSceneProc proc, bool freeH) { }

        /// <summary>
        /// Triggered when the night menu is entered at the end of the day (screen where you can save and load the game).
        /// You can use <see cref="GetCycle"/> to see what day it is as well as other game state.
        /// </summary>
        protected internal virtual void OnEnterNightMenu() { }

        /// <summary>
        /// Triggered right after game state was loaded from a file. Some things might still be uninitialized.
        /// </summary>
        protected internal virtual void OnGameLoad(GameSaveLoadEventArgs args) { }

        /// <summary>
        /// Triggered right before game state is saved to a file.
        /// </summary>
        protected internal virtual void OnGameSave(GameSaveLoadEventArgs args) { }

        /// <summary>
        /// Triggered after an H scene is loaded.
        /// Warning: This is triggered in free H as well!
        /// </summary>
        /// <param name="proc">H scene controller instance</param>
        /// <param name="freeH">If true, the h scene was started from Main menu > Extra > FreeH</param>
        protected internal virtual void OnStartH(HSceneProc proc, bool freeH) { }

        /// <summary>
        /// Get the current game Cycle object, if it exists.
        /// </summary>
        protected static Cycle GetCycle()
        {
            if (_cycle == null)
                _cycle = FindObjectOfType<Cycle>();
            return _cycle;
        }

        /// <summary>
        /// Triggered when the current day changes in story mode.
        /// </summary>
        protected internal virtual void OnDayChange(Cycle.Week day) { }

        /// <summary>
        /// Triggered when the current time of the day changes in story mode.
        /// </summary>
        protected internal virtual void OnPeriodChange(Cycle.Type period) { }
    }
}