ODHelpMenuCategory_DefaultGeneral class
We are still working the API Reference! This page might be incomplete or doesn't contain all details!
Overview
This is a special class that adds type definitions & typescript to the ODHelpMenuManager class. It doesn't add any extra features!
This default class is made for the opendiscord:general category in opendiscord.helpmenu!
Methods
Properties
inherited id class ➜ api.ODId
The id of this category.
inherited name string ➜ string
The name of this category. (can include emoji's)
inherited newPage boolean ➜ boolean
When enabled, it automatically starts this category on a new page.
inherited priority number ➜ number
The priority of this category. The higher, the earlier it will appear in the menu.
inherited redirects class ➜ api.ODManagerRedirectHelper
Handle all redirects in this ODManager
Methods
constructor() function ➜ api.ODHelpMenuCategory_DefaultGeneral
(no description)
View Parameters (4)
id: type ➜api.ODValidId- Parameter Description Lorem Ipsum.priority: number ➜number- Parameter Description Lorem Ipsum.name: string ➜string- Parameter Description Lorem Ipsum.newPage: boolean ➜boolean- Parameter Description Lorem Ipsum.
inherited protected _change() function ➜ void
Trigger an onChange() event in the parent ODManager of this class.
inherited add() function ➜ boolean
Add data to the manager. The id will be fetched from the data class! You can optionally select to overwrite existing data!
View Parameters (2)
data: type ➜api.ODHelpMenuComponent|(api.ODHelpMenuComponent[])- Parameter Description Lorem Ipsum.overwrite: boolean ➜boolean- Parameter Description Lorem Ipsum.
inherited changed() function ➜ void
(❌ SYSTEM ONLY!!) Set the callback executed when a value inside this class changes.
exists() function ➜ boolean
Check if data that matches the ODId exists. Returns a boolean.
View Parameters (1)
id: type ➜keyof api.ODHelpMenuManagerCategoryIds_DefaultGeneral- Parameter Description Lorem Ipsum.
get() function ➜ null|api.ODHelpMenuComponent
Get data that matches the ODId. Returns the found data.
View Parameters (1)
id: type ➜api.ODValidId- Parameter Description Lorem Ipsum.
inherited getAll() function ➜ api.ODHelpMenuComponent[]
Get all data inside this manager
inherited getFiltered() function ➜ api.ODHelpMenuComponent[]
Get all data that matches inside the filter function
View Parameters (1)
predicate: function ➜(value:api.ODHelpMenuComponent, index:number, array:api.ODHelpMenuComponent[]) => unknown- Parameter Description Lorem Ipsum.
inherited getIds() function ➜ api.ODId[]
Get a list of all the ids inside this manager
inherited getLength() function ➜ number
Get the length of the data inside this manager
inherited getRegex() function ➜ api.ODHelpMenuComponent[]
Get all data that matches the regex
View Parameters (1)
regex: type ➜RegExp- Parameter Description Lorem Ipsum.
inherited loopAll() function ➜ Promise
Run an iterator over all data in this manager. This method also supports async-await behaviour!
View Parameters (1)
cb: function ➜(data:api.ODHelpMenuComponent, id:api.ODId) => api.ODPromiseVoid- Parameter Description Lorem Ipsum.
inherited onAdd() function ➜ void
Listen for when data is added to this manager.
View Parameters (1)
callback: type ➜api.ODManagerAddCallback- Parameter Description Lorem Ipsum.
inherited onChange() function ➜ void
Listen for when data is changed in this manager.
View Parameters (1)
callback: type ➜api.ODManagerCallback- Parameter Description Lorem Ipsum.
inherited onRemove() function ➜ void
Listen for when data is removed from this manager.
View Parameters (1)
callback: type ➜api.ODManagerCallback- Parameter Description Lorem Ipsum.
remove() function ➜ null|api.ODHelpMenuComponent
Remove data that matches the ODId. Returns the removed data.
View Parameters (1)
id: type ➜api.ODValidId- Parameter Description Lorem Ipsum.
inherited render() function ➜ Promise
Render this category and it's components.
View Parameters (3)
inherited useDebug() function ➜ void
Use the Open Ticket debugger in this manager for logs
View Parameters (2)
debug: class ➜api.ODDebugger- Parameter Description Lorem Ipsum.debugname: string ➜string- Parameter Description Lorem Ipsum.
Defaults
We're still working on this part of the documentation!
Examples
We're still working on this part of the documentation!