Skip to main content

ODConsoleMessage class

under construction

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

Overview​

This is an Open Ticket console message.

It is used to create beautiful & styled logs in the console with a prefix, message & parameters. It also has full color support using ansis and parameters are parsed for you!

View Source

Properties​

Methods​

Other​

Properties​

color type ➜ api.ODValidConsoleColor​

The color of the prefix of this message

View Source

message string ➜ string​

The main message sent in the console

View Source

params array ➜ api.ODConsoleMessageParam[]​

An array of all the parameters in this message

View Source

prefix string ➜ string​

The prefix of this message (!uppercase recommended!)

View Source

Methods​

constructor() function ➜ api.ODConsoleMessage​

(no description)

View Parameters (4)

View Source

createParamsString() function ➜ string​

Render the parameters of this message in a specific color.

View Parameters (1)

View Source

render() function ➜ boolean​

Render this message to the console using console.log! Returns false when something went wrong.

View Source

setColor() function ➜ api.ODConsoleMessage​

Set the prefix color

View Parameters (1)

View Source

setMessage() function ➜ api.ODConsoleMessage​

Set the message

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

View Source

setParams() function ➜ api.ODConsoleMessage​

Set the params

View Parameters (1)

View Source

setPrefix() function ➜ api.ODConsoleMessage​

Set the prefix

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

View Source

toDebugString() function ➜ string​

Create a more-detailed, non-colored version of this message to store it in the otdebug.txt file!

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!