mistreevous/dist/attributes/callbacks/Callback.d.ts

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

import { Agent } from "../../Agent";
import Attribute, { AttributeDetails } from "../Attribute";
/**
 * Details of a node callback attribute.
 */
export type CallbackAttributeDetails = {
    /** The name of the agent function that is called. */
    calls: string;
} & AttributeDetails;
/**
 * A base node callback attribute.
 */
export default abstract class Callback extends Attribute<CallbackAttributeDetails> {
    private functionName;
    /**
     * @param type The node attribute type.
     * @param args The array of decorator argument definitions.
     * @param functionName The name of the agent function to call.
     */
    constructor(type: string, args: any[], functionName: string);
    /**
     * Gets the name of the agent function to call.
     */
    getFunctionName: () => string;
    /**
     * Gets the attribute details.
     */
    getDetails(): CallbackAttributeDetails;
    /**
     * Attempt to call the agent function that this callback refers to.
     * @param agent The agent.
     */
    abstract callAgentFunction: (agent: Agent, isSuccess: boolean, isAborted: boolean) => void;
}