Merge pull request #85 from nikkorn/#81

Add Race node

README.md

@@ -172,7 +172,7 @@ root {
 ```
 
 ### Parallel
-This composite node will update each child node concurrently. It will move to the `SUCCEEDED` state if all of its children have moved to the `SUCCEEDED` state and will move to the `FAILED` state if any of its children move to the `FAILED` state. This node will remain in the `RUNNING` state if any of its children are in the `RUNNING` state.
+This composite node will update each child node concurrently. It will move to the `SUCCEEDED` state if all of its children have moved to the `SUCCEEDED` state and will move to the `FAILED` state if any of its children move to the `FAILED` state, otherwise it will remain in the `RUNNING` state.
 [Example](https://nikkorn.github.io/mistreevous-visualiser/index.html?example=parallel)
 
 *MDSL*
@@ -205,6 +205,40 @@ root {
 }
 ```
 
+### Race
+This composite node will update each child node concurrently. It will move to the `SUCCEEDED` state if any of its children have moved to the `SUCCEEDED` state and will move to the `FAILED` state if all of its children move to the `FAILED` state, otherwise it will remain in the `RUNNING` state.
+[Example](https://nikkorn.github.io/mistreevous-visualiser/index.html?example=race)
+
+*MDSL*
+```
+root {
+    race {
+        action [UnlockDoor]
+        action [FindAlternativePath]
+    }
+}
+```
+
+*JSON*
+```json
+{
+    "type": "root",
+    "child": {
+        "type": "race",
+        "children": [
+            {
+                "type": "action",
+                "call": "UnlockDoor"
+            },
+            {
+                "type": "action",
+                "call": "FindAlternativePath"
+            }
+        ]
+    }
+}
+```
+
 ### Lotto
 This composite node will select a single child at random to run as the active running node. The state of this node will reflect the state of the active child.
 [Example](https://nikkorn.github.io/mistreevous-visualiser/index.html?example=lotto)

dist/BehaviourTreeDefinition.d.ts

@@ -158,6 +158,15 @@ export interface ParallelNodeDefinition extends CompositeNodeDefinition {
      */
     type: "parallel";
 }
+/**
+ * A race node.
+ */
+export interface RaceNodeDefinition extends CompositeNodeDefinition {
+    /**
+     * The node type.
+     */
+    type: "race";
+}
 /**
  * A root node.
  */
@@ -227,7 +236,7 @@ export interface FailNodeDefinition extends DecoratorNodeDefinition {
 /**
  * A type defining any node definition.
  */
-export type AnyNodeDefinition = BranchNodeDefinition | ActionNodeDefinition | ConditionNodeDefinition | WaitNodeDefinition | SequenceNodeDefinition | SelectorNodeDefinition | LottoNodeDefinition | ParallelNodeDefinition | RootNodeDefinition | RepeatNodeDefinition | RetryNodeDefinition | FlipNodeDefinition | SucceedNodeDefinition | FailNodeDefinition;
+export type AnyNodeDefinition = BranchNodeDefinition | ActionNodeDefinition | ConditionNodeDefinition | WaitNodeDefinition | SequenceNodeDefinition | SelectorNodeDefinition | LottoNodeDefinition | ParallelNodeDefinition | RaceNodeDefinition | RootNodeDefinition | RepeatNodeDefinition | RetryNodeDefinition | FlipNodeDefinition | SucceedNodeDefinition | FailNodeDefinition;
 /**
  * A type defining any node type that can be a child of composite parent node.
  */

dist/nodes/composite/Race.d.ts

@@ -0,0 +1,26 @@
+import Composite from "./Composite";
+import Node from "../Node";
+import { Agent } from "../../Agent";
+import Attribute from "../../attributes/Attribute";
+import { BehaviourTreeOptions } from "../../BehaviourTreeOptions";
+/**
+ * A RACE node.
+ * The child nodes are executed concurrently until one succeeds or all fail.
+ */
+export default class Race extends Composite {
+    /**
+     * @param attributes The node attributes.
+     * @param children The child nodes.
+     */
+    constructor(attributes: Attribute[], children: Node[]);
+    /**
+     * Called when the node is being updated.
+     * @param agent The agent.
+     * @param options The behaviour tree options object.
+     */
+    protected onUpdate(agent: Agent, options: BehaviourTreeOptions): void;
+    /**
+     * Gets the name of the node.
+     */
+    getName: () => string;
+}