Merge pull request #75 from nikkorn/#74

#74 The 'random' function behaviour tree option is used for wait node duration selection and added indefinite waits
nikkorn · May 10, 2023 · d4cc971 · d4cc971
2 parents d1bf549 + 12177fe
commit d4cc971
Show file tree

Hide file tree

Showing 45 changed files with 505 additions and 295 deletions.
diff --git a/README.md b/README.md
@@ -78,7 +78,7 @@ The `BehaviourTree` constructor can take an options object as an argument, the p
 | Option          |Type | Description |
 | :--------------------|:- |:- |
 | getDeltaTime |() => number| A function returning a delta time in seconds that is used to calculate the elapsed duration of any `wait` nodes. If this function is not defined then `Date().getTime()` is used instead by default.  |
-| random |() => number| A function returning a floating-point number between 0 (inclusive) and 1 (exclusive). If defined, this function is used to source a pseudo-random number to use in the selection of active children for any `lotto` nodes. If not defined then `Math.random` will be used instead by default. This function can be useful in seeding all random numbers used in the running of a tree instance to make any behaviour completely deterministic. |
+| random |() => number| A function returning a floating-point number between 0 (inclusive) and 1 (exclusive). If defined, this function is used to source a pseudo-random number to use in operations such as the selection of active children for any `lotto` nodes and the selection of durations for `wait` nodes when minimum and maximum durations are defined. If not defined then `Math.random` will be used instead by default. This function can be useful in seeding all random numbers used in the running of a tree instance to make any behaviour completely deterministic. |
 
 # Nodes
 
@@ -442,7 +442,7 @@ root {
 In the above example, we are using a wait node to wait 2 seconds between each run of the **FireWeapon** action.
 
 The duration to wait in milliseconds can also be selected at random within a lower and upper bound if these are defined as two integer node arguments. In the example below, we would run the **PickUpProjectile** action and then wait for 2 to 8 seconds before running the **ThrowProjectile** action.
-[Example](https://nikkorn.github.io/mistreevous-visualiser/index.html?example=wait-one-to-five-seconds)
+[Example](https://nikkorn.github.io/mistreevous-visualiser/index.html?example=wait)
 
 ```
 root {
@@ -454,6 +454,15 @@ root {
 }
 ```
 
+If no node arguments are defined then the wait node will remain in the running state indefinitely until it is aborted.
+[Example](https://nikkorn.github.io/mistreevous-visualiser/index.html?example=wait)
+
+```
+root {
+    wait
+}
+```
+
 ### Branch
 Named root nodes can be referenced using the **branch** node. This node acts as a placeholder that will be replaced by the child node of the referenced root node. The two definitions below are synonymous.
 
@@ -531,14 +540,14 @@ root {
 ```
 
 ## Guards
-A guard defines a condition that must be met in order for the node to remain active. Any running nodes will have their guard condition evaluated for each leaf node update, and will move to a failed state if the guard condition is not met.
+A guard defines a condition that must be met in order for the associated node to remain active. Any running nodes will have their guard condition evaluated for each leaf node update, and will move to a failed state if the guard condition is not met.
 [Example](https://nikkorn.github.io/mistreevous-visualiser/index.html?example=guards)
 
 This functionality is useful as a means of aborting long running actions or branches that span across multiple steps of the tree.
 
 ```
 root {
-    wait [10000] while(CanWait)
+    wait while(CanWait)
 }
 ```
 

diff --git a/dist/agent.d.ts → dist/Agent.d.ts b/dist/agent.d.ts → dist/Agent.d.ts
diff --git a/dist/behaviourTree.d.ts → dist/BehaviourTree.d.ts b/dist/behaviourTree.d.ts → dist/BehaviourTree.d.ts
diff --git a/dist/behaviourTreeOptions.d.ts → dist/BehaviourTreeOptions.d.ts b/dist/behaviourTreeOptions.d.ts → dist/BehaviourTreeOptions.d.ts
diff --git a/dist/lookup.d.ts → dist/Lookup.d.ts b/dist/lookup.d.ts → dist/Lookup.d.ts
diff --git a/dist/rootAstNodesBuilder.d.ts → dist/RootAstNodesBuilder.d.ts b/dist/rootAstNodesBuilder.d.ts → dist/RootAstNodesBuilder.d.ts
@@ -84,7 +84,8 @@ export type ConditionAstNode = LeafAstNode<Condition> & {
 export type WaitAstNode = LeafAstNode<Wait> & {
     type: "wait";
     duration: number | null;
-    longestDuration: number | null;
+    durationMin: number | null;
+    durationMax: number | null;
 };
 export type AnyAstNode = BranchAstNode | CompositeAstNode | LottoAstNode | DecoratorAstNode | RootAstNode | IterableAstNode | LeafAstNode | ActionAstNode | ConditionAstNode | WaitAstNode;
 /**

diff --git a/dist/state.d.ts → dist/State.d.ts b/dist/state.d.ts → dist/State.d.ts
diff --git a/dist/attributes/attribute.d.ts → dist/attributes/Attribute.d.ts b/dist/attributes/attribute.d.ts → dist/attributes/Attribute.d.ts
diff --git a/dist/attributes/callbacks/callback.d.ts → dist/attributes/callbacks/Callback.d.ts b/dist/attributes/callbacks/callback.d.ts → dist/attributes/callbacks/Callback.d.ts
diff --git a/dist/attributes/callbacks/entry.d.ts → dist/attributes/callbacks/Entry.d.ts b/dist/attributes/callbacks/entry.d.ts → dist/attributes/callbacks/Entry.d.ts
diff --git a/dist/attributes/callbacks/exit.d.ts → dist/attributes/callbacks/Exit.d.ts b/dist/attributes/callbacks/exit.d.ts → dist/attributes/callbacks/Exit.d.ts
diff --git a/dist/attributes/callbacks/step.d.ts → dist/attributes/callbacks/Step.d.ts b/dist/attributes/callbacks/step.d.ts → dist/attributes/callbacks/Step.d.ts
diff --git a/dist/attributes/guards/guard.d.ts → dist/attributes/guards/Guard.d.ts b/dist/attributes/guards/guard.d.ts → dist/attributes/guards/Guard.d.ts
diff --git a/dist/attributes/guards/guardPath.d.ts → dist/attributes/guards/GuardPath.d.ts b/dist/attributes/guards/guardPath.d.ts → dist/attributes/guards/GuardPath.d.ts
diff --git a/...tes/guards/guardUnsatisifedException.d.ts → ...tes/guards/GuardUnsatisifedException.d.ts b/...tes/guards/guardUnsatisifedException.d.ts → ...tes/guards/GuardUnsatisifedException.d.ts
diff --git a/dist/attributes/guards/until.d.ts → dist/attributes/guards/Until.d.ts b/dist/attributes/guards/until.d.ts → dist/attributes/guards/Until.d.ts
diff --git a/dist/attributes/guards/while.d.ts → dist/attributes/guards/While.d.ts b/dist/attributes/guards/while.d.ts → dist/attributes/guards/While.d.ts
diff --git a/dist/attributes/guards/timeout.d.ts b/dist/attributes/guards/timeout.d.ts
diff --git a/dist/bundle.js b/dist/bundle.js
diff --git a/dist/bundle.js.map b/dist/bundle.js.map
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/dist/nodes/node.d.ts → dist/nodes/Node.d.ts b/dist/nodes/node.d.ts → dist/nodes/Node.d.ts
diff --git a/dist/nodes/composite/composite.d.ts → dist/nodes/composite/Composite.d.ts b/dist/nodes/composite/composite.d.ts → dist/nodes/composite/Composite.d.ts
diff --git a/dist/nodes/composite/lotto.d.ts → dist/nodes/composite/Lotto.d.ts b/dist/nodes/composite/lotto.d.ts → dist/nodes/composite/Lotto.d.ts
diff --git a/dist/nodes/composite/parallel.d.ts → dist/nodes/composite/Parallel.d.ts b/dist/nodes/composite/parallel.d.ts → dist/nodes/composite/Parallel.d.ts
diff --git a/dist/nodes/composite/selector.d.ts → dist/nodes/composite/Selector.d.ts b/dist/nodes/composite/selector.d.ts → dist/nodes/composite/Selector.d.ts
diff --git a/dist/nodes/composite/sequence.d.ts → dist/nodes/composite/Sequence.d.ts b/dist/nodes/composite/sequence.d.ts → dist/nodes/composite/Sequence.d.ts
diff --git a/dist/nodes/decorator/decorator.d.ts → dist/nodes/decorator/Decorator.d.ts b/dist/nodes/decorator/decorator.d.ts → dist/nodes/decorator/Decorator.d.ts
diff --git a/dist/nodes/decorator/fail.d.ts → dist/nodes/decorator/Fail.d.ts b/dist/nodes/decorator/fail.d.ts → dist/nodes/decorator/Fail.d.ts
diff --git a/dist/nodes/decorator/flip.d.ts → dist/nodes/decorator/Flip.d.ts b/dist/nodes/decorator/flip.d.ts → dist/nodes/decorator/Flip.d.ts
diff --git a/dist/nodes/decorator/repeat.d.ts → dist/nodes/decorator/Repeat.d.ts b/dist/nodes/decorator/repeat.d.ts → dist/nodes/decorator/Repeat.d.ts
diff --git a/dist/nodes/decorator/retry.d.ts → dist/nodes/decorator/Retry.d.ts b/dist/nodes/decorator/retry.d.ts → dist/nodes/decorator/Retry.d.ts
diff --git a/dist/nodes/decorator/root.d.ts → dist/nodes/decorator/Root.d.ts b/dist/nodes/decorator/root.d.ts → dist/nodes/decorator/Root.d.ts
diff --git a/dist/nodes/decorator/succeed.d.ts → dist/nodes/decorator/Succeed.d.ts b/dist/nodes/decorator/succeed.d.ts → dist/nodes/decorator/Succeed.d.ts
diff --git a/dist/nodes/leaf/action.d.ts → dist/nodes/leaf/Action.d.ts b/dist/nodes/leaf/action.d.ts → dist/nodes/leaf/Action.d.ts
diff --git a/dist/nodes/leaf/condition.d.ts → dist/nodes/leaf/Condition.d.ts b/dist/nodes/leaf/condition.d.ts → dist/nodes/leaf/Condition.d.ts
diff --git a/dist/nodes/leaf/leaf.d.ts → dist/nodes/leaf/Leaf.d.ts b/dist/nodes/leaf/leaf.d.ts → dist/nodes/leaf/Leaf.d.ts
diff --git a/dist/nodes/leaf/wait.d.ts → dist/nodes/leaf/Wait.d.ts b/dist/nodes/leaf/wait.d.ts → dist/nodes/leaf/Wait.d.ts
@@ -8,13 +8,15 @@ import { BehaviourTreeOptions } from "../../BehaviourTreeOptions";
  */
 export default class Wait extends Leaf {
     private duration;
-    private longestDuration;
+    private durationMin;
+    private durationMax;
     /**
      * @param attributes The node attributes.
      * @param duration The duration that this node will wait to succeed in milliseconds, or the earliest if longestDuration is defined.
-     * @param longestDuration The longest possible duration in milliseconds that this node will wait to succeed.
+     * @param durationMin The minimum possible duration in milliseconds that this node will wait to succeed.
+     * @param durationMax The maximum possible duration in milliseconds that this node will wait to succeed.
      */
-    constructor(attributes: Attribute[], duration: number, longestDuration: number);
+    constructor(attributes: Attribute[], duration: number | null, durationMin: number | null, durationMax: number | null);
     /**
      * The time in milliseconds at which this node was first updated.
      */