Skip to main content

ODProgressBar 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 progress bar.

It is used to create a simple or advanced progress bar in the console of the bot. These progress bars are not visible in the otdebug.txt file and should only be used as extra visuals.

Use other classes as existing templates or create your own progress bar from scratch using this class.

View Source

Properties​

Methods​

Other​

Properties​

autoStop type ➜ null|"min"|"max"​

Enable automatic stopping when reaching min or max.

View Source

inherited id class ➜ api.ODId​

The id of this data.

View Source

initialValue number ➜ number​

The initial value of the progress bar.

View Source

max number ➜ number​

The maximum value of the progress bar.

View Source

min number ➜ number​

The minimum value of the progress bar.

View Source

prefix type ➜ null|string​

The prefix displayed in the progress bar.

View Source

renderer class ➜ api.ODProgressBarRenderer​

The renderer of this progress bar.

View Source

suffix type ➜ null|string​

The prefix displayed in the progress bar.

View Source

protected value number ➜ number​

The current value of the progress bar.

View Source

Methods​

constructor() function ➜ api.ODProgressBar​

(no description)

View Parameters (8)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • renderer: class ➜ api.ODProgressBarRenderer - Parameter Description Lorem Ipsum.
  • min: number ➜ number - Parameter Description Lorem Ipsum.
  • max: number ➜ number - Parameter Description Lorem Ipsum.
  • value: number ➜ number - Parameter Description Lorem Ipsum.
  • autoStop: type ➜ null|"min"|"max" - Parameter Description Lorem Ipsum.
  • prefix: type ➜ null|string - Parameter Description Lorem Ipsum.
  • suffix: type ➜ null|string - Parameter Description Lorem Ipsum.

View Source

inherited protected _change() function ➜ void​

Trigger an onChange() event in the parent ODManager of this class.

View Source

inherited changed() function ➜ void​

(❌ SYSTEM ONLY!!) Set the callback executed when a value inside this class changes.

View Parameters (1)
  • callback: type ➜ null|(() => void) - Parameter Description Lorem Ipsum.

View Source

finished() function ➜ Promise​

Wait for the progress bar to finish.

View Source

start() function ➜ boolean​

Start showing this progress bar in the console.

View Source

protected update() function ➜ boolean​

Update this progress bar while active. (will automatically update the progress bar in the console)

View Parameters (2)
  • value: number ➜ number - Parameter Description Lorem Ipsum.
  • stop: boolean ➜ boolean - 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!