SelectMenuOption

Implementation of discords Option object as a Luau builder.

https://discord.com/developers/docs/interactions/message-components#Options

Summary

Properties

SelectMenuOption.label :: string?SelectMenuOption.value :: string?SelectMenuOption.description :: string?SelectMenuOption.emoji :: Builders.Emoji?SelectMenuOption.default :: boolean?

Methods

SelectMenuOption:setLabel(label: string) → OptionSelectMenuOption:setValue(value: string) → OptionSelectMenuOption:setDescription(description: string) → OptionSelectMenuOption:setEmoji(emoji: emoji.JSON) → OptionSelectMenuOption:setDefault(default: boolean) → OptionSelectMenuOption:build() → JSON

Functions

SelectMenuOption.new(resource: { label: string?, value: string?, description: string?, emoji: emoji.JSON?, default: boolean?, }) → Option

Properties

label

SelectMenuOption.label  :: string?

---

The user-facing name of the option.

value

SelectMenuOption.value  :: string?

---

The dev-defined value of the option.

description

SelectMenuOption.description  :: string?

---

An additional description of the option.

emoji

SelectMenuOption.emoji  :: Emoji?

---

The emoji to display alongside the option.

default

SelectMenuOption.default  :: boolean?

---

Whether this option is selected by default.

Methods

setLabel

SelectMenuOption : setLabel ( label )  -> Option

Sets the user-facing name of the option.

Parameters

label: string

Returns

Option

setValue

SelectMenuOption : setValue ( value )  -> Option

Sets the dev-defined value of the option.

Parameters

value: string

Returns

Option

setDescription

SelectMenuOption : setDescription ( description )  -> Option

Sets an additional description of the option.

Parameters

description: string

Returns

Option

setEmoji

SelectMenuOption : setEmoji ( emoji )  -> Option

Sets an emoji to display alongside the option.

Parameters

emoji: JSON

Returns

Option

setDefault

SelectMenuOption : setDefault ( default )  -> Option

Sets whether this option is selected by default.

Parameters

default: boolean

Returns

Option

build

SelectMenuOption : build ( )  -> JSON

Responsible for building the Option JSON that can be parsed by the Discord API.

Returns

JSON

Functions

new

SelectMenuOption . new ( resource )  -> Option

Responsible for creating a new Option.

local option = Option.new({
  label = "My Option",
  value = "option_value",
  description = "A description",
  default = false
})

Parameters

resource: { label: string?, value: string?, description: string?, emoji: emoji.JSON?, default: boolean?, }

Returns

Option