#if GRAPH_DESIGNER /// --------------------------------------------- /// Behavior Designer /// Copyright (c) Opsive. All Rights Reserved. /// https://www.opsive.com /// --------------------------------------------- namespace Opsive.BehaviorDesigner.Runtime.Tasks.Composites { using Opsive.BehaviorDesigner.Runtime.Components; using Opsive.GraphDesigner.Runtime; using Opsive.Shared.Utility; using Unity.Entities; using Unity.Burst; using UnityEngine; using System; /// /// A node representation of the selector task. /// [NodeIcon("4c3d0559a9ebc604e88b16e9a3fdfa05", "de3acf0e386a26246b8bc999b1ef8e32")] [Opsive.Shared.Utility.Description("The selector task is similar to an \"or\" operation. It will return success as soon as one of its child tasks return success. " + "If a child task returns failure then it will sequentially run the next task. If no child task returns success then it will return failure.")] public class Selector : ECSCompositeTask, IParentNode, IConditionalAbortParent, IInterruptResponder, ISavableTask, ICloneable { [Tooltip("Specifies how the child conditional tasks should be reevaluated.")] [SerializeField] ConditionalAbortType m_AbortType; private ushort m_ComponentIndex; public ConditionalAbortType AbortType { get => m_AbortType; set => m_AbortType = value; } public Type InterruptSystemType { get => typeof(SelectorInterruptSystem); } /// /// The type of tag that should be enabled when the task is running. /// public override ComponentType Flag { get => typeof(SelectorFlag); } /// /// Returns a new TBufferElement for use by the system. /// /// A new TBufferElement for use by the system. public override SelectorComponent GetBufferElement() { return new SelectorComponent() { Index = RuntimeIndex, }; } /// /// Adds the IBufferElementData to the entity. /// /// The world that the entity exists in. /// The entity that the IBufferElementData should be assigned to. /// The GameObject that the entity is attached to. /// The index of the element within the buffer. public override int AddBufferElement(World world, Entity entity, GameObject gameObject) { m_ComponentIndex = (ushort)base.AddBufferElement(world, entity, gameObject); return m_ComponentIndex; } /// /// Specifies the type of reflection that should be used to save the task. /// /// The index of the sub-task. This is used for the task set allowing each contained task to have their own save type. public MemberVisibility GetSaveReflectionType(int index) { return MemberVisibility.None; } /// /// Returns the current task state. /// /// The DOTS world. /// The DOTS entity. /// The current task state. public object Save(World world, Entity entity) { var selectorComponents = world.EntityManager.GetBuffer(entity); var selectorComponent = selectorComponents[m_ComponentIndex]; // Save the active child. return selectorComponent.ActiveChildIndex; } /// /// Loads the previous task state. /// /// The previous task state. /// The DOTS world. /// The DOTS entity. public void Load(object saveData, World world, Entity entity) { var selectorComponents = world.EntityManager.GetBuffer(entity); var selectorComponent = selectorComponents[m_ComponentIndex]; // saveData is the active child. selectorComponent.ActiveChildIndex = (ushort)saveData; selectorComponents[m_ComponentIndex] = selectorComponent; } /// /// Creates a deep clone of the component. /// /// A deep clone of the component. public object Clone() { var clone = Activator.CreateInstance(); clone.Index = Index; clone.ParentIndex = ParentIndex; clone.SiblingIndex = SiblingIndex; clone.AbortType = AbortType; return clone; } } /// /// The DOTS data structure for the Selector class. /// public struct SelectorComponent : IBufferElementData { [Tooltip("The index of the node.")] public ushort Index; [Tooltip("The index of the child that is currently active.")] public ushort ActiveChildIndex; } /// /// A DOTS tag indicating when a Selector node is active. /// public struct SelectorFlag : IComponentData, IEnableableComponent { } /// /// Runs the Selector logic. /// [DisableAutoCreation] public partial struct SelectorTaskSystem : ISystem { /// /// Creates the job. /// /// The current state of the system. [BurstCompile] private void OnUpdate(ref SystemState state) { var query = SystemAPI.QueryBuilder().WithAllRW().WithAllRW().WithAllRW().WithAll().Build(); state.Dependency = new SelectorJob().ScheduleParallel(query, state.Dependency); } /// /// Job which executes the task logic. /// [BurstCompile] private partial struct SelectorJob : IJobEntity { /// /// Executes the selector logic. /// /// An array of BranchComponents. /// An array of TaskComponents. /// An array of SelectorComponents. [BurstCompile] public void Execute(ref DynamicBuffer branchComponents, ref DynamicBuffer taskComponents, ref DynamicBuffer selectorComponents) { for (int i = 0; i < selectorComponents.Length; ++i) { var selectorComponent = selectorComponents[i]; var taskComponent = taskComponents[selectorComponent.Index]; var branchComponent = branchComponents[taskComponent.BranchIndex]; // Do not continue if there will be an interrupt or the branch cannot execute. if (branchComponent.InterruptType != InterruptType.None || !branchComponent.CanExecute) { continue; } if (taskComponent.Status == TaskStatus.Queued) { taskComponent.Status = TaskStatus.Running; taskComponents[taskComponent.Index] = taskComponent; selectorComponent.ActiveChildIndex = (ushort)(taskComponent.Index + 1); selectorComponents[i] = selectorComponent; branchComponent.NextIndex = selectorComponent.ActiveChildIndex; branchComponents[taskComponent.BranchIndex] = branchComponent; // Start the child. var nextChildTaskComponent = taskComponents[branchComponent.NextIndex]; nextChildTaskComponent.Status = TaskStatus.Queued; taskComponents[branchComponent.NextIndex] = nextChildTaskComponent; } else if (taskComponent.Status != TaskStatus.Running) { continue; } // The selector task is currently active. Check the first child. var childTaskComponent = taskComponents[selectorComponent.ActiveChildIndex]; if (childTaskComponent.Status == TaskStatus.Queued || childTaskComponent.Status == TaskStatus.Running) { // The child should keep running. continue; } if (childTaskComponent.SiblingIndex == ushort.MaxValue || childTaskComponent.Status == TaskStatus.Success) { // There are no more children or the child succeeded. The selector task should end. A task status of inactive indicates the last task was disabled. Return failure. taskComponent.Status = childTaskComponent.Status != TaskStatus.Inactive ? childTaskComponent.Status : TaskStatus.Failure; selectorComponent.ActiveChildIndex = (ushort)(selectorComponent.Index + 1); taskComponents[selectorComponent.Index] = taskComponent; branchComponent.NextIndex = taskComponent.ParentIndex; branchComponents[taskComponent.BranchIndex] = branchComponent; } else { // The previous task is no longer running. var siblingTaskComponent = taskComponents[childTaskComponent.SiblingIndex]; siblingTaskComponent.Status = TaskStatus.Queued; taskComponents[childTaskComponent.SiblingIndex] = siblingTaskComponent; // The current index is now the sibling index. selectorComponent.ActiveChildIndex = childTaskComponent.SiblingIndex; branchComponent.NextIndex = selectorComponent.ActiveChildIndex; branchComponents[taskComponent.BranchIndex] = branchComponent; } selectorComponents[i] = selectorComponent; } } } } /// /// An interrupt has occurred. Ensure the task state is correct after the interruption. /// [DisableAutoCreation] public partial struct SelectorInterruptSystem : ISystem { /// /// Runs the logic after an interruption. /// /// The current state of the system. [BurstCompile] private void OnUpdate(ref SystemState state) { foreach (var (taskComponents, selectorComponents) in SystemAPI.Query, DynamicBuffer>().WithAll()) { for (int i = 0; i < selectorComponents.Length; ++i) { var selectorComponent = selectorComponents[i]; // The active child will have a non-running status if it has been interrupted. if (taskComponents[selectorComponent.ActiveChildIndex].Status != TaskStatus.Running) { var childIndex = (ushort)(selectorComponent.Index + 1); // Find the currently active task. while (childIndex != ushort.MaxValue && taskComponents[childIndex].Status != TaskStatus.Running) { childIndex = taskComponents[childIndex].SiblingIndex; } if (childIndex != ushort.MaxValue) { selectorComponent.ActiveChildIndex = childIndex; } var selectorBuffer = selectorComponents; selectorBuffer[i] = selectorComponent; } } } } } } #endif