Skip to main content

ODDebugFileManager class

under construction

We are still working the API Reference! This page might be incomplete or doesn't contain all details!

Overview

This is the Open Ticket debug file manager.

It manages the Open Ticket debug file (otdebug.txt) which keeps a history of all system logs. There are even internal logs that aren't logged to the console which are available in this file!

Using this class, you can change the max length of this file and some other cool things!

View Source

Properties


filename string string

The filename of the debugfile (otdebug.txt by default)

View Source


maxlines number number

The max length of the debug file.

View Source


path string string

The path to the debugfile (./otdebug.txt by default)

View Source


version class api.ODVersion

The current version of the bot used in the debug file.

View Source


Methods


constructor() function api.ODDebugFileManager

(no description)

View Parameters (4)
  • path: string string - Parameter Description Lorem Ipsum.
  • filename: string string - Parameter Description Lorem Ipsum.
  • maxlines: number number - Parameter Description Lorem Ipsum.
  • version: class api.ODVersion - Parameter Description Lorem Ipsum.

View Source


writeConsoleMessage() function void

Write an ODConsoleMessage to the debug file

View Parameters (1)

View Source


writeErrorMessage() function void

Write an ODError to the debug file

View Parameters (1)
  • error: class api.ODError - Parameter Description Lorem Ipsum.

View Source


writeNote() function void

Write a custom note to the debug file (starting with [NOTE]:)

View Parameters (1)
  • text: string string - Parameter Description Lorem Ipsum.

View Source


writeText() function void

Write custom text to the debug file

View Parameters (1)
  • text: string string - Parameter Description Lorem Ipsum.

View Source


Defaults

under construction

We're still working on this part of the documentation!

Examples

under construction

We're still working on this part of the documentation!