Cielonos/Packages/com.opsive.behaviordesigner/Runtime/Tasks/Actions/Wait.cs

#if GRAPH_DESIGNER
/// ---------------------------------------------
/// Behavior Designer
/// Copyright (c) Opsive. All Rights Reserved.
/// https://www.opsive.com
/// ---------------------------------------------
namespace Opsive.BehaviorDesigner.Runtime.Tasks.Actions.Time
{
    using Opsive.BehaviorDesigner.Runtime.Components;
    using Opsive.BehaviorDesigner.Runtime.Utility;
    using Opsive.GraphDesigner.Runtime;
    using Opsive.GraphDesigner.Runtime.Variables;
    using Opsive.GraphDesigner.Runtime.Variables.ECS;
    using Opsive.Shared.Utility;
    using Unity.Entities;
    using Unity.Burst;
    using UnityEngine;
    using UnityEngine.Scripting.APIUpdating;
    using System;

    [NodeIcon("b4b59e888607422409f1efa599af34ae", "e1cb9cb566a90fb4489bf31465b99747")]
    [Opsive.Shared.Utility.Description("Wait a specified amount of time. The task will return running until the task is done waiting. It will return success after the wait time has elapsed.")]
    [MovedFrom(false, "Opsive.BehaviorDesigner.Runtime.Tasks.Actions", "Opsive.BehaviorDesigner.Runtime", "Wait")]
    public class Wait : ECSActionTask<WaitTaskSystem, WaitComponent, WaitFlag>, ICloneable, IPausableTask, ISavableTask
    {
        [Tooltip("The amount of time to wait (in seconds).")]
        [FormerlySerializedType(typeof(float))]
        [SerializeField] SharedVariable<float> m_Duration = 1;
        [Tooltip("Should the wait duration be randomized?")]
        [FormerlySerializedType(typeof(bool))]
        [SerializeField] SharedVariable<bool> m_RandomDuration = false;
        [Tooltip("The seed of the random number generator. Set to 0 to use the entity index as the seed.")]
        [SerializeField] uint m_Seed;
        [Tooltip("The wait duration range if random wait is enabled.")]
        [FormerlySerializedType(typeof(RangeFloat))]
        [SerializeField] SharedVariable<RangeFloat> m_RandomDurationRange = new RangeFloat(1, 1);

        private ushort m_ComponentIndex;
        private ECSSharedVariableIndex<float> m_DurationVariableIndex;
        private ECSSharedVariableIndex<bool> m_RandomDurationVariableIndex;
        private ECSSharedVariableIndex<RangeFloat> m_RandomDurationRangeVariableIndex;

        public SharedVariable<float> Duration { get => m_Duration; set => m_Duration = value; }
        public SharedVariable<bool> RandomDuration { get => m_RandomDuration; set => m_RandomDuration = value; }
        public uint Seed { get => m_Seed; set => m_Seed = value; }
        public SharedVariable<RangeFloat> RandomDurationRange { get => m_RandomDurationRange; set => m_RandomDurationRange = value; }

        /// <summary>
        /// Resets the task to its default values.
        /// </summary>
        public override void Reset()
        {
            m_Duration = 1;
            m_RandomDuration = false;
            m_Seed = 0;
            m_RandomDurationRange = new RangeFloat(1, 1);
        }

        /// <summary>
        /// Returns a new TBufferElement for use by the system.
        /// </summary>
        /// <returns>A new TBufferElement for use by the system.</returns>
        public override WaitComponent GetBufferElement()
        {
            return new WaitComponent() {
                Index = RuntimeIndex,
                DurationVariableIndex = m_DurationVariableIndex.Index,
                RandomDurationVariableIndex = m_RandomDurationVariableIndex.Index,
                RandomDurationRangeVariableIndex = m_RandomDurationRangeVariableIndex.Index,
                Seed = m_Seed,
            };
        }

        /// <summary>
        /// Adds the IBufferElementData to the entity.
        /// </summary>
        /// <param name="world">The world that the entity exists in.</param>
        /// <param name="entity">The entity that the IBufferElementData should be assigned to.</param>
        /// <param name="registry">The ECS variable registry for registering SharedVariable fields.</param>
        /// <param name="gameObject">The GameObject that the entity is attached to.</param>
        /// <returns>The index of the element within the buffer.</returns>
        public override int AddBufferElement(World world, Entity entity, ECSVariableRegistry registry, GameObject gameObject)
        {
            m_DurationVariableIndex = new ECSSharedVariableIndex<float>(registry.Register(m_Duration));
            m_RandomDurationVariableIndex = new ECSSharedVariableIndex<bool>(registry.Register(m_RandomDuration));
            m_RandomDurationRangeVariableIndex = new ECSSharedVariableIndex<RangeFloat>(registry.Register(m_RandomDurationRange));
            m_ComponentIndex = (ushort)base.AddBufferElement(world, entity, registry, gameObject);
            return m_ComponentIndex;
        }

        /// <summary>
        /// Specifies the type of reflection that should be used to save the task.
        /// </summary>
        /// <param name="index">The index of the sub-task. This is used for the task set allowing each contained task to have their own save type.</param>
        public MemberVisibility GetSaveReflectionType(int index) { return MemberVisibility.None; }

        /// <summary>
        /// The task has been paused.
        /// </summary>
        /// <param name="world">The DOTS world.</param>
        /// <param name="entity">The DOTS entity.</param>
        public void Pause(World world, Entity entity)
        {
            var waitComponents = world.EntityManager.GetBuffer<WaitComponent>(entity);
            var waitComponent = waitComponents[m_ComponentIndex];
            waitComponent.PauseTime = UnityEngine.Time.time;
            var waitComponentBuffer = waitComponents;
            waitComponentBuffer[m_ComponentIndex] = waitComponent;
        }

        /// <summary>
        /// The task has been resumed.
        /// </summary>
        /// <param name="world">The DOTS world.</param>
        /// <param name="entity">The DOTS entity.</param>
        public void Resume(World world, Entity entity)
        {
            var waitComponents = world.EntityManager.GetBuffer<WaitComponent>(entity);
            var waitComponent = waitComponents[m_ComponentIndex];
            waitComponent.StartTime += (UnityEngine.Time.time - waitComponent.PauseTime);
            waitComponent.PauseTime = 0;
            var waitComponentBuffer = waitComponents;
            waitComponentBuffer[m_ComponentIndex] = waitComponent;
        }

        /// <summary>
        /// Returns the current task state.
        /// </summary>
        /// <param name="world">The DOTS world.</param>
        /// <param name="entity">The DOTS entity.</param>
        /// <returns>The current task state.</returns>
        public object Save(World world, Entity entity)
        {
            var waitComponents = world.EntityManager.GetBuffer<WaitComponent>(entity);
            var waitComponent = waitComponents[m_ComponentIndex];

            // Save the unique data.
            return new object[] { waitComponent.WaitDuration, waitComponent.StartTime >= 0 ? (double)(UnityEngine.Time.time - waitComponent.StartTime) : 0.0 };
        }

        /// <summary>
        /// Loads the previous task state.
        /// </summary>
        /// <param name="saveData">The previous task state.</param>
        /// <param name="world">The DOTS world.</param>
        /// <param name="entity">The DOTS entity.</param>
        public void Load(object saveData, World world, Entity entity)
        {
            var waitComponents = world.EntityManager.GetBuffer<WaitComponent>(entity);
            var waitComponent = waitComponents[m_ComponentIndex];

            // saveData is the wait duration and the elapsed amount of time.
            var data = (object[])saveData;
            waitComponent.WaitDuration = (double)data[0];
            var elapsedTime = (double)data[1];
            if (elapsedTime > 0) {
                waitComponent.StartTime = UnityEngine.Time.time - elapsedTime;
            } else {
                waitComponent.StartTime = -1;
            }
            waitComponents[m_ComponentIndex] = waitComponent;
        }

        /// <summary>
        /// Creates a deep clone of the component.
        /// </summary>
        /// <returns>A deep clone of the component.</returns>
        public object Clone()
        {
            var clone = Activator.CreateInstance<Wait>();
            clone.Index = Index;
            clone.ParentIndex = ParentIndex;
            clone.SiblingIndex = SiblingIndex;
            clone.Enabled = Enabled;
            clone.Duration = Duration?.Clone() as SharedVariable<float>;
            clone.RandomDuration = RandomDuration?.Clone() as SharedVariable<bool>;
            clone.Seed = Seed;
            clone.RandomDurationRange = RandomDurationRange?.Clone() as SharedVariable<RangeFloat>;
            return clone;
        }
    }

    /// <summary>
    /// The DOTS data structure for the Wait struct.
    /// </summary>
    public struct WaitComponent : IBufferElementData
    {
        [Tooltip("The index of the node.")]
        public ushort Index;
        [Tooltip("Buffer index into SharedVariableElement for the wait duration.")]
        public int DurationVariableIndex;
        [Tooltip("Buffer index into SharedVariableElement for the randomized wait flag.")]
        public int RandomDurationVariableIndex;
        [Tooltip("Buffer index into SharedVariableElement for the random wait duration range.")]
        public int RandomDurationRangeVariableIndex;
        [Tooltip("The amount of time the task should wait.")]
        public double WaitDuration;
        [Tooltip("The real time the task started to wait.")]
        public double StartTime;
        [Tooltip("The seed of the random number generator.")]
        public uint Seed;
        [Tooltip("The random number generator for the task.")]
        public Unity.Mathematics.Random RandomNumberGenerator;
        [Tooltip("The time the task was paused.")]
        public double PauseTime;
    }

    /// <summary>
    /// A DOTS tag indicating when a Wait node is active.
    /// </summary>
    public struct WaitFlag : IComponentData, IEnableableComponent { }

    /// <summary>
    /// Runs the Wait logic.
    /// </summary>
    [DisableAutoCreation]
    public partial struct WaitTaskSystem : ISystem
    {
        private EntityQuery m_Query;

        /// <summary>
        /// Builds the query.
        /// </summary>
        /// <param name="state">The current state of the system.</param>
        private void OnCreate(ref SystemState state)
        {
            m_Query = SystemAPI.QueryBuilder().WithAllRW<TaskComponent>().WithAllRW<WaitComponent>().WithAll<WaitFlag, EvaluateFlag, SharedVariableElement>().Build();
        }

        /// <summary>
        /// Updates the logic.
        /// </summary>
        /// <param name="state">The current state of the system.</param>
        [BurstCompile]
        private void OnUpdate(ref SystemState state)
        {
            state.Dependency = new WaitJob() { ElapsedTime = SystemAPI.Time.ElapsedTime }.ScheduleParallel(m_Query, state.Dependency);
        }

        /// <summary>
        /// Waits for the specified amount of time.
        /// </summary>
        [BurstCompile]
        private partial struct WaitJob : IJobEntity
        {
            [Tooltip("The current ElapsedTime.")]
            public double ElapsedTime;

            /// <summary>
            /// Updates the logic.
            /// </summary>
            /// <param name="entity">The entity.</param>
            /// <param name="taskComponents">An array of TaskComponents.</param>
            /// <param name="waitComponents">An array of WaitComponents.</param>
            [BurstCompile]
            public void Execute(Entity entity, ref DynamicBuffer<TaskComponent> taskComponents, ref DynamicBuffer<WaitComponent> waitComponents,
                DynamicBuffer<SharedVariableElement> sharedVariables)
            {
                for (int i = 0; i < waitComponents.Length; ++i) {
                    var waitComponent = waitComponents[i];
                    var taskComponent = taskComponents[waitComponent.Index];
                    if (taskComponent.Status == TaskStatus.Queued) {
                        taskComponent.Status = TaskStatus.Running;
                        waitComponent.StartTime = ElapsedTime;

                        var randomDuration = sharedVariables.Get<bool>(waitComponent.RandomDurationVariableIndex);
                        if (randomDuration) {
                            var randomDurationRange = sharedVariables.Get<RangeFloat>(waitComponent.RandomDurationRangeVariableIndex);
                            // Generate a new random number seed for each entity.
                            if (waitComponent.RandomNumberGenerator.state == 0) {
                                waitComponent.RandomNumberGenerator = Unity.Mathematics.Random.CreateFromIndex(waitComponent.Seed != 0 ? waitComponent.Seed : (uint)entity.Index);
                            }

                            waitComponent.WaitDuration = waitComponent.RandomNumberGenerator.NextDouble(randomDurationRange.Min, randomDurationRange.Max);
                        } else {
                            waitComponent.WaitDuration = sharedVariables.Get<float>(waitComponent.DurationVariableIndex);
                        }

                        waitComponents[i] = waitComponent;
                    }
                    if (taskComponent.Status == TaskStatus.Running) {
                        if (waitComponent.StartTime + waitComponent.WaitDuration <= ElapsedTime) {
                            taskComponent.Status = TaskStatus.Success;
                        }
                    }
                    taskComponents[waitComponent.Index] = taskComponent;
                }
            }
        }
    }

    [NodeIcon("b4b59e888607422409f1efa599af34ae", "e1cb9cb566a90fb4489bf31465b99747")]
    [Opsive.Shared.Utility.Description("Wait a specified amount of time. The task will return running until the task is done waiting. It will return success after the wait time has elapsed. Uses the GameObject workflow.")]
    [MovedFrom(false, "Opsive.BehaviorDesigner.Runtime.Tasks.Actions", "Opsive.BehaviorDesigner.Runtime", "SharedWait")]
    public class SharedWait : Actions.Action
    {
        [Tooltip("The amount of time to wait (in seconds).")]
        [SerializeField] SharedVariable<float> m_Duration = 1;
        [Tooltip("The seed of the random number generator. Set to 0 to disable.")]
        [SerializeField] int m_Seed;
        [Tooltip("Should the wait duration be randomized?")]
        [SerializeField] SharedVariable<bool> m_RandomDuration;
        [Tooltip("The minimum wait duration if random wait is enabled.")]
        [SerializeField] SharedVariable<RangeFloat> m_RandomDurationRange = new RangeFloat(1, 1);
        [Tooltip("The maximum wait duration if random wait is enabled.")]
        [SerializeField] SharedVariable<float> m_RandomDurationMax = 1;

        public SharedVariable<float> Duration { get => m_Duration; set => m_Duration = value; }
        public int Seed { get => m_Seed; set => m_Seed = value; }
        public SharedVariable<bool> RandomDuration { get => m_RandomDuration; set => m_RandomDuration = value; }
        public SharedVariable<RangeFloat> RandomDurationRange { get => m_RandomDurationRange; set => m_RandomDurationRange = value; }
        public SharedVariable<float> RandomDurationMax { get => m_RandomDurationMax; set => m_RandomDurationMax = value; }

        private float m_WaitDuration;
        private float m_StartTime;
        private float m_PauseTime = -1;

        /// <summary>
        /// Callback when the task is initialized.
        /// </summary>
        public override void OnAwake()
        {
            if (m_Seed != 0) {
                UnityEngine.Random.InitState(m_Seed);
            }
        }

        /// <summary>
        /// Callback when the task is started.
        /// </summary>
        public override void OnStart()
        {
            if (m_RandomDuration.Value) {
                m_WaitDuration = UnityEngine.Random.Range(m_RandomDurationRange.Value.Min, m_RandomDurationRange.Value.Max);
            } else {
                m_WaitDuration = m_Duration.Value;
            }
            m_StartTime = UnityEngine.Time.time;
        }

        /// <summary>
        /// Executes the task logic.
        /// </summary>
        /// <returns>The status of the task.</returns>
        public override TaskStatus OnUpdate()
        {
            return m_StartTime + m_WaitDuration <= UnityEngine.Time.time ? TaskStatus.Success : TaskStatus.Running;
        }

        /// <summary>
        /// Returns the current task state.
        /// </summary>
        /// <param name="world">The DOTS world.</param>
        /// <param name="entity">The DOTS entity.</param>
        /// <returns>The current task state.</returns>
        public override object Save(World world, Entity entity)
        {
            // Save the unique data.
            return new object[] { m_WaitDuration, UnityEngine.Time.time - m_StartTime };
        }

        /// <summary>
        /// Loads the previous task state.
        /// </summary>
        /// <param name="saveData">The previous task state.</param>
        /// <param name="world">The DOTS world.</param>
        /// <param name="entity">The DOTS entity.</param>
        public override void Load(object saveData, World world, Entity entity)
        {
            // saveData is the wait duration and the elapsed amount of time.
            var data = (object[])saveData;
            m_WaitDuration = (float)data[0];
            m_StartTime = UnityEngine.Time.time - (float)data[1];
        }

        /// <summary>
        /// The behavior tree has been started.
        /// </summary>
        public override void OnBehaviorTreeStarted()
        {
            base.OnBehaviorTreeStarted();

            if (m_PauseTime != -1) {
                m_StartTime += (UnityEngine.Time.time - m_PauseTime);
                m_PauseTime = -1;
            }
        }

        /// <summary>
        /// The behavior tree has been stopped or paused.
        /// </summary>
        /// <param name="paused">True if the tree has been paused.</param>
        public override void OnBehaviorTreeStopped(bool paused)
        {
            base.OnBehaviorTreeStopped(paused);

            if (paused) {
                m_PauseTime = UnityEngine.Time.time;
            }
        }

        /// <summary>
        /// Resets the variables.
        /// </summary>
        public override void Reset()
        {
            base.Reset();

            m_Duration = 1;
            m_RandomDuration = false;
            m_Seed = 0;
            m_RandomDurationRange = new RangeFloat(1, 1);
            m_PauseTime = -1;
        }
    }
}
#endif