Tidying

README.md

@@ -77,8 +77,8 @@ 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 operations such as the selection of active children for any `lotto` nodes as well as the selection of durations for `wait` nodes, iterations for `repeat` nodes and attempts for `retry` nodes when minimum and maximum bounds 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. |
+| 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.prototype.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 operations such as the selection of active children for any `lotto` nodes as well as the selection of durations for `wait` nodes, iterations for `repeat` nodes and attempts for `retry` nodes when minimum and maximum bounds 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
 

dist/BehaviourTreeDefinition.d.ts

@@ -3,7 +3,7 @@
  */
 export interface NodeAttributeDefinition {
     /**
-     * The name of the agent function to invoke.
+     * The name of the agent function or globally registered function to invoke.
      */
     call: string;
     /**
@@ -80,7 +80,7 @@ export interface ActionNodeDefinition extends NodeDefinition {
      */
     type: "action";
     /**
-     * The name of the agent function or registered function to invoke.
+     * The name of the agent function or globally registered function to invoke.
      */
     call: string;
     /**
@@ -97,7 +97,7 @@ export interface ConditionNodeDefinition extends NodeDefinition {
      */
     type: "condition";
     /**
-     * The name of the agent function or registered function to invoke.
+     * The name of the agent function or globally registered function to invoke.
      */
     call: string;
     /**
@@ -113,6 +113,9 @@ export interface WaitNodeDefinition extends NodeDefinition {
      * The node type.
      */
     type: "wait";
+    /**
+     * The duration to wait in milliseconds if defined as a single integer, or the lower and upper duration bounds if defined as an array containing two integer values.
+     */
     duration?: number | [number, number];
 }
 /**
@@ -176,6 +179,9 @@ export interface RepeatNodeDefinition extends DecoratorNodeDefinition {
      * The node type.
      */
     type: "repeat";
+    /**
+     * The number of iterations to make if defined as a single number, or the lower and upper iteration bounds if defined as an array containing two integer values.
+     */
     iterations?: number | [number, number];
 }
 /**
@@ -186,6 +192,9 @@ export interface RetryNodeDefinition extends DecoratorNodeDefinition {
      * The node type.
      */
     type: "retry";
+    /**
+     * The number of attempts to make if defined as a single number, or the lower and upper attempt bounds if defined as an array containing two integer values.
+     */
     attempts?: number | [number, number];
 }
 /**

dist/BehaviourTreeOptions.d.ts

@@ -3,12 +3,17 @@
  */
 export interface BehaviourTreeOptions {
     /**
-     * Gets a delta time in seconds that is used to calculate the elapsed duration of any wait nodes.
+     * Gets 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.prototype.getTime()` will be used instead by default.
      * @returns The delta time to use in seconds.
      */
     getDeltaTime?(): number;
     /**
-     * Gets a pseudo-random floating-point number between 0 (inclusive) and 1 (exclusive) for use in the selection of active children for any lotto nodes.
+     * Gets a pseudo-random floating-point number between 0 (inclusive) and 1 (exclusive) for use in operations such as:
+     *  - The selection of active children for any `lotto` nodes.
+     *  - The selection of durations for `wait` nodes,
+     *  - The selection of iterations for `repeat` nodes and attempts for `retry` nodes when minimum and maximum bounds are defined.
+     * If not defined then `Math.random()` will be used instead by default.
      * @returns A floating-point number between 0 (inclusive) and 1 (exclusive)
      */
     random?(): number;

dist/index.d.ts

@@ -1,7 +1,7 @@
 import State from "./State";
-import { validateDefinition } from "./BehaviourTreeDefinitionValidator";
-import { convertMDSLToJSON } from "./mdsl/MDSLDefinitionParser";
 import { BehaviourTree, FlattenedTreeNode } from "./BehaviourTree";
 import { BehaviourTreeOptions } from "./BehaviourTreeOptions";
+import { validateDefinition } from "./BehaviourTreeDefinitionValidator";
+import { convertMDSLToJSON } from "./mdsl/MDSLDefinitionParser";
 export { BehaviourTree, State, convertMDSLToJSON, validateDefinition };
 export type { FlattenedTreeNode, BehaviourTreeOptions };

src/BehaviourTreeDefinition.ts

@@ -3,7 +3,7 @@
  */
 export interface NodeAttributeDefinition {
     /**
-     * The name of the agent function to invoke.
+     * The name of the agent function or globally registered function to invoke.
      */
     call: string;
     /**
@@ -85,7 +85,7 @@ export interface ActionNodeDefinition extends NodeDefinition {
      */
     type: "action";
     /**
-     * The name of the agent function or registered function to invoke.
+     * The name of the agent function or globally registered function to invoke.
      */
     call: string;
     /**
@@ -103,7 +103,7 @@ export interface ConditionNodeDefinition extends NodeDefinition {
      */
     type: "condition";
     /**
-     * The name of the agent function or registered function to invoke.
+     * The name of the agent function or globally registered function to invoke.
      */
     call: string;
     /**
@@ -120,6 +120,9 @@ export interface WaitNodeDefinition extends NodeDefinition {
      * The node type.
      */
     type: "wait";
+    /**
+     * The duration to wait in milliseconds if defined as a single integer, or the lower and upper duration bounds if defined as an array containing two integer values.
+     */
     duration?: number | [number, number];
 }
 
@@ -189,6 +192,9 @@ export interface RepeatNodeDefinition extends DecoratorNodeDefinition {
      * The node type.
      */
     type: "repeat";
+    /**
+     * The number of iterations to make if defined as a single number, or the lower and upper iteration bounds if defined as an array containing two integer values.
+     */
     iterations?: number | [number, number];
 }
 
@@ -200,6 +206,9 @@ export interface RetryNodeDefinition extends DecoratorNodeDefinition {
      * The node type.
      */
     type: "retry";
+    /**
+     * The number of attempts to make if defined as a single number, or the lower and upper attempt bounds if defined as an array containing two integer values.
+     */
     attempts?: number | [number, number];
 }
 

src/BehaviourTreeOptions.ts

@@ -3,13 +3,18 @@
  */
 export interface BehaviourTreeOptions {
     /**
-     * Gets a delta time in seconds that is used to calculate the elapsed duration of any wait nodes.
+     * Gets 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.prototype.getTime()` will be used instead by default.
      * @returns The delta time to use in seconds.
      */
     getDeltaTime?(): number;
 
     /**
-     * Gets a pseudo-random floating-point number between 0 (inclusive) and 1 (exclusive) for use in the selection of active children for any lotto nodes.
+     * Gets a pseudo-random floating-point number between 0 (inclusive) and 1 (exclusive) for use in operations such as:
+     *  - The selection of active children for any `lotto` nodes.
+     *  - The selection of durations for `wait` nodes,
+     *  - The selection of iterations for `repeat` nodes and attempts for `retry` nodes when minimum and maximum bounds are defined.
+     * If not defined then `Math.random()` will be used instead by default.
      * @returns A floating-point number between 0 (inclusive) and 1 (exclusive)
      */
     random?(): number;

src/index.ts

@@ -1,8 +1,8 @@
 import State from "./State";
-import { validateDefinition } from "./BehaviourTreeDefinitionValidator";
-import { convertMDSLToJSON } from "./mdsl/MDSLDefinitionParser";
 import { BehaviourTree, FlattenedTreeNode } from "./BehaviourTree";
 import { BehaviourTreeOptions } from "./BehaviourTreeOptions";
+import { validateDefinition } from "./BehaviourTreeDefinitionValidator";
+import { convertMDSLToJSON } from "./mdsl/MDSLDefinitionParser";
 
 export { BehaviourTree, State, convertMDSLToJSON, validateDefinition };
 export type { FlattenedTreeNode, BehaviourTreeOptions };