Skip to main content
Version: Current

Common

  • AttachDebuggerOptions​

    Defines an interface that contains options for attaching a debugger.

    Members​

    • tagNameMapper? TagMapper​

      Gets the tag name mapper that should be used. This is useful for ensuring that the debugger objects utilize different tag names for the front end.

  • DebuggerCallFrame​

    Defines an interface that contains information about a single call stack frame.

    Members​

    • location DebuggerFunctionLocation​

      The location that was last evaluated in this frame.

    • listVariables(): DebuggerVariable[]​

      Gets the list of variables that are avaiable from this frame.

    • setVariableValue(variableName: string, value: any): void​

      Sets the given variable name to the given value.

      The first parameter is a string and is the name of the variable to set.

      The second parameter is a any and is the value to set in the variable.

  • DebuggerFunctionLocation​

    Defines an interface that represents a location in a debugger.

    Members​

    • botId? string​

      The ID of the bot that this function is defined in.

    • columnNumber? number​

      The column number that this function is defined at.

    • lineNumber? number​

      The line number that this function is defined at.

    • name? string​

      The name of the function.

    • tag? string​

      The name of the tag that this function is defined in.

  • DebuggerOptions​

    Defines an interface that contains options for an aux debugger.

    Members​

    • allowAsynchronousScripts boolean​

      Whether to allow scripts to be asynchronous. If false, then all scripts will be forced to be synchronous. Defaults to true.

    • configBot (Bot | Tags)​

      The data that the configBot should be created from. Can be a mod or another bot.

    • pausable boolean​

      Whether the debugger should be pausable.

    • useRealUUIDs boolean​

      Whether to use "real" UUIDs instead of predictable ones.

  • DebuggerPause​

    Defines an interface that contains information about the current debugger pause state.

    Members​

    • callStack DebuggerCallFrame[]​

      The call stack that the debugger currently has.

    • pauseId (string | number)​

      The ID of the pause.

    • result? any​

      The result of the node evaluation.

    • state ("before" | "after")​

      The state of the pause. Indicates whether the pause is before or after the node was executed.

    • trigger PauseTrigger​

      The pause trigger that started this pause.

  • DebuggerTagMaskUpdate​

    Defines an interface for a debugger trace that represents when a tag mask was updated.

    Members​

    • botId string​

      The ID of the bot that was updated.

    • newValue any​

      The new value for the tag.

    • oldValue any​

      The old value of the tag.

    • space string​

      The space of the tag mask.

    • tag string​

      The tag that was updated.

  • DebuggerTagUpdate​

    Defines an interface for a debugger trace that represents when a tag was updated.

    Members​

    • botId string​

      The ID of the bot that was updated.

    • newValue any​

      The new value for the tag.

    • oldValue any​

      The old value of the tag.

    • tag string​

      The tag that was updated.

  • DebuggerVariable​

    Defines an interface that represents a debugger variable.

    Members​

    • initialized? boolean​

      Whether this variable has been initialized.

    • name string​

      The name of the variable.

    • scope ("block" | "frame" | "closure")​

      The scope that the variable exists in.

      "block" indicates that the variable was defined in and exists only in the current block. "frame" indicates that the variable was defined in and exists in the current stack frame. "closure" indicates that the variable was inherited from a parent stack frame.

    • value any​

      The value contained by the variable.

    • writable boolean​

      Whether the variable value can be overwriten.

  • NormalDebuggerOptions​

    Defines an interface that contains options for a normal debugger. That is, a debugger that is not pausable.

    Members​

    • allowAsynchronousScripts? boolean​

      Whether to allow scripts to be asynchronous. If false, then all scripts will be forced to be synchronous. Defaults to true.

    • configBot? (Bot | Tags)​

      The data that the configBot should be created from. Can be a mod or another bot.

    • pausable? false​

    • useRealUUIDs? boolean​

      Whether to use "real" UUIDs instead of predictable ones.

  • PausableDebuggerOptions​

    Defines an interface that contains options for a pausable debugger. That is, a debugger that is pausable.

    Members​

    • allowAsynchronousScripts? boolean​

      Whether to allow scripts to be asynchronous. If false, then all scripts will be forced to be synchronous. Defaults to true.

    • configBot? (Bot | Tags)​

      The data that the configBot should be created from. Can be a mod or another bot.

    • pausable true​

    • useRealUUIDs? boolean​

      Whether to use "real" UUIDs instead of predictable ones.

  • PauseTrigger​

    Defines an interface that represents a pause trigger.

    Members​

    • botId string​

      The ID of the bot that the trigger is set on.

    • columnNumber number​

      The column number that the trigger starts at.

    • enabled? boolean​

      Whether the trigger is enabled. Defaults to true.

    • lineNumber number​

      The line number that the trigger starts at.

    • states? ("before" | "after")[]​

      The states that the trigger should use. Defaults to ["before"] if not specified.

    • tag string​

      The tag that the trigger is set on.

    • triggerId string​

      The ID of the trigger.

  • PauseTriggerOptions​

    Defines an interface that contains options for a pause trigger.

    Members​

    • columnNumber number​

      The column number that the trigger starts at.

    • enabled? boolean​

      Whether the trigger is enabled. Defaults to true.

    • lineNumber number​

      The line number that the trigger starts at.

    • states? ("before" | "after")[]​

      The states that the trigger should use. Defaults to ["before"] if not specified.

  • PossiblePauseTriggerLocation​

    Defines an interface for a possible pause trigger location.

    Members​

    • columnNumber number​

      The column number that the trigger would pause the debugger at.

    • lineNumber number​

      The line number that the trigger would pause the debugger at.

    • possibleStates PossiblePauseTriggerStates​

      The states that are reasonable for this pause trigger to stop at.

  • PossiblePauseTriggerStates​

    The possible states that a pause trigger can be set to.

    A PossiblePauseTriggerStates can be one of the following values:

    • [("before" | "after")]
    • ["before", "after"]