Class DiagnosticsManager

Readonlytabs

addTab

• addTab(tab: DiagnosticsTab): void

  Parameters

  • tab: DiagnosticsTab

    The DiagnosticsTab instance to add to the display.

  Returns void

  Remarks

  Adds an existing DiagnosticsTab instance to the live diagnostics display in the debugger

containsTab

• containsTab(tab: DiagnosticsTab): boolean

  Parameters

  • tab: DiagnosticsTab

  Returns boolean

  Remarks

  Returns whether the given tab is currently registered and used in the live diagnostics display.

containsView

• containsView(view: DiagnosticsView): boolean

  Parameters

  • view: DiagnosticsView

  Returns boolean

  Remarks

  Returns whether the given view is currently registered and used by any tab in the live diagnostics display.

createTab

• createTab(tabName: string): DiagnosticsTab

  Parameters

  • tabName: string

    The name of the tab for creation and display.

  Returns DiagnosticsTab

  Remarks

  Creates a new DiagnosticsTab and adds it to the live diagnostics display in the debugger

  Throws

  This function can throw errors.

  DiagnosticsError

createView

• createView(
      statName: string,
      options?: DiagnosticsChartViewOptions | DiagnosticsTableViewOptions,
  ): DiagnosticsView

  Parameters

  • statName: string

    The name of the stats data for creation and display.

  • Optionaloptions: DiagnosticsChartViewOptions | DiagnosticsTableViewOptions

    An optional set of either chart or table options to be used for modifying the display.

  Returns DiagnosticsView

  The newly created DiagnosticsView instance.

  Remarks

  Creates a new DiagnosticsView. This view will not be added to the live diagnostics display automatically, please use DiagnosticsTab.addView to do so.

  Throws

  This function can throw errors.

  DiagnosticsError

removeTab

• removeTab(tab: DiagnosticsTab): void

  Parameters

  • tab: DiagnosticsTab

  Returns void

  Remarks

  Removes a previously registered tab from the live diagnostics display in the debugger