Skip to main content

ODProgressBarRenderer_Default 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 renderer.

It is used to render a progress bar in the console of the bot.

There are already a lot of default options available if you just want an easy progress bar!

View Source

Properties


inherited id class api.ODId

The id of this data.

View Source


inherited settings interface api.ODProgressBarRenderer_DefaultSettings

(no description)

View Source


Methods


constructor() function api.ODProgressBarRenderer_Default

(no description)

View Parameters (2)

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


inherited render() function string

Render a progress bar using this renderer.

View Parameters (5)
  • min: number number - Parameter Description Lorem Ipsum.
  • max: number number - Parameter Description Lorem Ipsum.
  • value: number number - Parameter Description Lorem Ipsum.
  • prefix: type null|string - Parameter Description Lorem Ipsum.
  • suffix: type null|string - Parameter Description Lorem Ipsum.

View Source


inherited withAdditionalSettings() function api.ODProgressBarRenderer

(no description)

View Parameters (1)
  • settings: type Partial - 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!