Class Button

A clickable button that can appear in a message. Buttons will automatically be shown to players if used in a Player.prompt.click(button).

Hierarchy

Button

Implements

ITextEmbeddable

Index

Constructors

Properties

Methods

renderTextEmbed

Constructors

constructor

new Button(label): Button
Create a clickable button that can appear in a message.
Parameters
- label: string
  
  Text displayed on this button.
Returns Button

Properties

`Readonly` label

label: string

Text displayed on this button.

Methods

renderTextEmbed

renderTextEmbed(ctx): TextEmbedView
Renders the object for embedding in text.
Parameters
- ctx: RenderContext
  
  Information about the visibility of the object, and who's viewing it.
Returns TextEmbedView

Implementation of ITextEmbeddable.renderTextEmbed

Generated using TypeDoc