ODEvent 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 event.
This class is made to work with the ODEventManager to handle events.
The function of this specific class is to manage all listeners for a specifc event!
Properties
Properties
inherited id class ➜ api.ODId
The id of this data.
listenerLimit number ➜ number
The max listener limit before a possible memory leak will be announced
listeners array ➜ Function[]
The list of permanent listeners.
oncelisteners array ➜ Function[]
The list of one-time listeners. List is cleared every time the event is emitted.
Methods
constructor() function ➜ api.ODEvent
(no description)
View Parameters (1)
id: type ➜api.ODValidId- Parameter Description Lorem Ipsum.
inherited protected _change() function ➜ void
Trigger an onChange() event in the parent ODManager of this class.
inherited changed() function ➜ void
(❌ SYSTEM ONLY!!) Set the callback executed when a value inside this class changes.
emit() function ➜ Promise
Emit this event to all listeners. You are required to provide all parameters of the event!
View Parameters (1)
params: array ➜any[]- Parameter Description Lorem Ipsum.
listen() function ➜ void
Add a permanent callback to this event. This will stay as long as the bot is running!
View Parameters (1)
callback: type ➜Function- Parameter Description Lorem Ipsum.
listenOnce() function ➜ void
Add a one-time-only callback to this event. This will only trigger the callback once!
View Parameters (1)
callback: type ➜Function- Parameter Description Lorem Ipsum.
setListenerLimit() function ➜ void
Edit the listener limit
View Parameters (1)
limit: number ➜number- Parameter Description Lorem Ipsum.
useDebug() function ➜ void
Use the Open Ticket debugger in this manager for logs
View Parameters (1)
debug: type ➜null|api.ODDebugger- Parameter Description Lorem Ipsum.
wait() function ➜ Promise
Wait until this event is fired! Be carefull with it, because it could block the entire bot when wrongly used!
Defaults
We're still working on this part of the documentation!
Examples
We're still working on this part of the documentation!