mistreevous/dist/Lookup.d.ts

A library to declaratively define, build and execute behaviour trees, written in TypeScript for Node and browsers

import { ActionResult, Agent, GlobalFunction } from "./Agent";
import { RootNodeDefinition } from "./BehaviourTreeDefinition";
export type InvokerFunction = (args: any[]) => ActionResult | boolean;
/**
 * A singleton used to store and lookup registered functions and subtrees.
 */
export default class Lookup {
    /**
     * The object holding any registered functions keyed on function name.
     */
    private static registeredFunctions;
    /**
     * The object holding any registered subtree root node definitions keyed on tree name.
     */
    private static registeredSubtrees;
    /**
     * Gets the function with the specified name.
     * @param name The name of the function.
     * @returns The function with the specified name.
     */
    static getFunc(name: string): GlobalFunction;
    /**
     * Sets the function with the specified name for later lookup.
     * @param name The name of the function.
     * @param func The function.
     */
    static setFunc(name: string, func: GlobalFunction): void;
    /**
     * Gets the function invoker for the specified agent and function name.
     * If a function with the specified name exists on the agent object then it will
     * be returned, otherwise we will then check the registered functions for a match.
     * @param agent The agent instance that this behaviour tree is modelling behaviour for.
     * @param name The function name.
     * @returns The function invoker for the specified agent and function name.
     */
    static getFuncInvoker(agent: Agent, name: string): InvokerFunction | null;
    /**
     * Gets all registered subtree root node definitions.
     */
    static getSubtrees(): {
        [key: string]: RootNodeDefinition;
    };
    /**
     * Sets the subtree with the specified name for later lookup.
     * @param name The name of the subtree.
     * @param subtree The subtree.
     */
    static setSubtree(name: string, subtree: RootNodeDefinition): void;
    /**
     * Removes the registered function or subtree with the specified name.
     * @param name The name of the registered function or subtree.
     */
    static remove(name: string): void;
    /**
     * Remove all registered functions and subtrees.
     */
    static empty(): void;
}