ODStartScreenComponent 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 startscreen component.
This component can be rendered to the start screen of the bot. An optional priority can be specified to choose the location of the component.
It's recommended to use pre-built components except if you really need a custom one.
Properties
Properties
inherited id class ➜ api.ODId
The id of this data.
priority number ➜ number
The priority of this component.
render type ➜ api.ODStartScreenComponentRenderCallback
The render function which will render the contents of this component.
renderAfter type ➜ null|api.ODStartScreenComponentRenderCallback
An optional render function which will be inserted behind the default renderer.
renderBefore type ➜ null|api.ODStartScreenComponentRenderCallback
An optional render function which will be inserted before the default renderer.
Methods
constructor() function ➜ api.ODStartScreenComponent
(no description)
View Parameters (3)
id: type ➜api.ODValidId- Parameter Description Lorem Ipsum.priority: number ➜number- Parameter Description Lorem Ipsum.render: type ➜api.ODStartScreenComponentRenderCallback- 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.
renderAll() function ➜ Promise
Render this component and combine it with the renderBefore & renderAfter contents.
View Parameters (1)
location: number ➜number- 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!