Skip to main content

ODConfig 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 config helper. This class doesn't do anything at all, it just gives a template & basic methods for a config. Use ODJsonConfig instead!

You can use this class if you want to create your own config implementation (e.g. yml, xml,...)!

View Source

Properties​

Methods​

Other​

Properties​

data type ➜ any​

An object/array of the entire config file! Variables inside it can be edited while the bot is running!

View Source

file string ➜ string​

The name of the file with extension.

View Source

inherited id class ➜ api.ODId​

The id of this data.

View Source

path string ➜ string​

The path to the file relative to the main directory.

View Source

Methods​

constructor() function ➜ api.ODConfig​

(no description)

View Parameters (2)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • data: type ➜ any - 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

init() function ➜ api.ODPromiseVoid​

Init the config.

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!