Skip to main content

ODManualProgressBar 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 manual console progress bar.

It is used to create a simple manual progress bar in the console. You can update the progress manually using update().

View Source

Properties​

Methods​

Other​

Properties​

inherited 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

inherited initialValue number ➜ number​

The initial value of the progress bar.

View Source

inherited max number ➜ number​

The maximum value of the progress bar.

View Source

inherited min number ➜ number​

The minimum value of the progress bar.

View Source

inherited prefix type ➜ null|string​

The prefix displayed in the progress bar.

View Source

inherited renderer class ➜ api.ODProgressBarRenderer​

The renderer of this progress bar.

View Source

inherited suffix type ➜ null|string​

The prefix displayed in the progress bar.

View Source

inherited protected value number ➜ number​

The current value of the progress bar.

View Source

Methods​

constructor() function ➜ api.ODManualProgressBar​

(no description)

View Parameters (6)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • renderer: class ➜ api.ODProgressBarRenderer - Parameter Description Lorem Ipsum.
  • amount: 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

decrease() function ➜ void​

Decrease the value of the progress bar.

View Parameters (2)
  • amount: number ➜ number - Parameter Description Lorem Ipsum.
  • stop: boolean ➜ boolean - Parameter Description Lorem Ipsum.

View Source

inherited finished() function ➜ Promise​

Wait for the progress bar to finish.

View Source

get() function ➜ number​

Get the current value of the progress bar.

View Source

increase() function ➜ void​

Increase the value of the progress bar.

View Parameters (2)
  • amount: number ➜ number - Parameter Description Lorem Ipsum.
  • stop: boolean ➜ boolean - Parameter Description Lorem Ipsum.

View Source

set() function ➜ void​

Set the value of the progress bar.

View Parameters (2)
  • value: number ➜ number - Parameter Description Lorem Ipsum.
  • stop: boolean ➜ boolean - Parameter Description Lorem Ipsum.

View Source

inherited start() function ➜ boolean​

Start showing this progress bar in the console.

View Source

inherited 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!