Skip to main content

ODFlag 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 flag.

A flag is a boolean that can be specified by a parameter in the console. It's useful for small settings that are only required once in a while.

Flags can also be enabled manually by plugins!

View Source

Properties​

Methods​

Other​

Properties​

aliases array ➜ string[]​

A list of aliases for the parameter in the console.

View Source

description string ➜ string​

The description of this flag. Visible to the user.

View Source

inherited id class ➜ api.ODId​

The id of this data.

View Source

method type ➜ null|"manual"|"param"​

The method that has been used to set the value of this flag. (null when not set)

View Source

name string ➜ string​

The name of this flag. Visible to the user.

View Source

param string ➜ string​

The name of the parameter in the console. (e.g. --test)

View Source

value boolean ➜ boolean​

The value of this flag.

View Source

Methods​

constructor() function ➜ api.ODFlag​

(no description)

View Parameters (6)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • name: string ➜ string - Parameter Description Lorem Ipsum.
  • description: string ➜ string - Parameter Description Lorem Ipsum.
  • param: string ➜ string - Parameter Description Lorem Ipsum.
  • aliases: array ➜ string[] - Parameter Description Lorem Ipsum.
  • initialValue: boolean ➜ boolean - 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

detectProcessParams() function ➜ void​

Detect if the process contains the param or aliases & set the value. Use force to overwrite a manually set value.

View Parameters (1)
  • force: boolean ➜ boolean - Parameter Description Lorem Ipsum.

View Source

setValue() function ➜ void​

Set the value of this flag.

View Parameters (2)
  • value: boolean ➜ boolean - Parameter Description Lorem Ipsum.
  • method: type ➜ "manual"|"param" - 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!