Skip to main content

ODStartScreenLogoComponent 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 startscreen logo component.

This component will render an ASCII art logo (from an array) to the startscreen. Every property in the array is another row. An optional priority can be specified to choose the location of the component.

View Source

Properties​

Methods​

Other​

Properties​

bottomPadding boolean ➜ boolean​

When enabled, the component will add a new line below the logo.

View Source

inherited id class ➜ api.ODId​

The id of this data.

View Source

The ASCII logo contents.

View Source

logoHexColor string ➜ string​

The color of the logo in hex format.

View Source

inherited priority number ➜ number​

The priority of this component.

View Source

inherited render type ➜ api.ODStartScreenComponentRenderCallback​

The render function which will render the contents of this component.

View Source

inherited renderAfter type ➜ null|api.ODStartScreenComponentRenderCallback​

An optional render function which will be inserted behind the default renderer.

View Source

inherited renderBefore type ➜ null|api.ODStartScreenComponentRenderCallback​

An optional render function which will be inserted before the default renderer.

View Source

topPadding boolean ➜ boolean​

When enabled, the component will add a new line above the logo.

View Source

Methods​

constructor() function ➜ api.ODStartScreenLogoComponent​

(no description)

View Parameters (6)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • priority: number ➜ number - Parameter Description Lorem Ipsum.
  • logo: array ➜ string[] - Parameter Description Lorem Ipsum.
  • topPadding: boolean ➜ boolean - Parameter Description Lorem Ipsum.
  • bottomPadding: boolean ➜ boolean - Parameter Description Lorem Ipsum.
  • logoHexColor: string ➜ string - 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

inherited renderAll() function ➜ Promise​

Render this component and combine it with the renderBefore & renderAfter contents.

View Parameters (1)
  • location: number ➜ number - 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!