ODPluginManager class
We are still working the API Reference! This page might be incomplete or doesn't contain all details!
Overview
This is an Open Ticket plugin manager.
It manages all active plugins in the bot!
It also contains all "plugin classes" which are managers registered by plugins.
These are accessible via the opendiscord.plugins.classes global.
Use isPluginLoaded() to check if a plugin has been loaded.
Properties
classes class ➜ api.ODPluginClassManager
A manager for all custom managers registered by plugins.
inherited redirects class ➜ api.ODManagerRedirectHelper
Handle all redirects in this ODManager
unknownCrashedPlugins array ➜ api.ODUnknownCrashedPlugin[]
A list of basic details from all plugins that crashed while loading the plugin.json file.
Methods
constructor() function ➜ api.ODPluginManager
(no description)
View Parameters (1)
debug: class ➜api.ODDebugger- 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.ODPlugin|(api.ODPlugin[])- 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.
inherited exists() function ➜ boolean
Check if data that matches the ODId exists. Returns a boolean.
View Parameters (1)
id: type ➜api.ODValidId- Parameter Description Lorem Ipsum.
inherited get() function ➜ null|api.ODPlugin
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.ODPlugin[]
Get all data inside this manager
inherited getFiltered() function ➜ api.ODPlugin[]
Get all data that matches inside the filter function
View Parameters (1)
predicate: function ➜(value:api.ODPlugin, index:number, array:api.ODPlugin[]) => 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.ODPlugin[]
Get all data that matches the regex
View Parameters (1)
regex: type ➜RegExp- Parameter Description Lorem Ipsum.
isPluginLoaded() function ➜ boolean
Check if a plugin has been loaded successfully and is available for usage.
View Parameters (1)
id: type ➜api.ODValidId- 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.ODPlugin, 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.
inherited remove() function ➜ null|api.ODPlugin
Remove data that matches the ODId. Returns the removed data.
View Parameters (1)
id: type ➜api.ODValidId- Parameter Description Lorem Ipsum.
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!