Skip to content

SelectMenu

Implementation of discords SelectMenu object as a Luau builder.

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

Properties

The SelectMenu instance has no set properties!

Methods

The SelectMenu instance has no set methods!

Functions

setType

SelectMenu . setType (

     self: SelectMenu
     selectMenuType: apiTypes.SelectMenuType
)  -> ()

Sets the type of select menu component to be created.

setCustomId

SelectMenu . setCustomId (

     self: SelectMenu
     customId: string
)  -> ()

Sets a developer-defined identifier for the select menu.

setPlaceholder

SelectMenu . setPlaceholder (

     self: SelectMenu
     placeholder: string
)  -> ()

Sets custom placeholder text shown when no option is selected.

setMinValues

SelectMenu . setMinValues (

     self: SelectMenu
     minValueCount: number
)  -> ()

Sets the minimum number of items that must be selected.

setMaxValues

SelectMenu . setMaxValues (

     self: SelectMenu
     maxValueCount: number
)  -> ()

Sets the maximum number of items that can be selected.

setDisabled

SelectMenu . setDisabled (

     self: SelectMenu
     disabled: boolean
)  -> ()

Sets whether the select menu is disabled or not.

addDefaultValue

SelectMenu . addDefaultValue (

     self: SelectMenu
     defaultValue: defaultValue.JSON
)  -> ()

Adds a default value to the select menu.

addChannelType

SelectMenu . addChannelType (

     self: SelectMenu
     channelType: apiTypes.ChannelType
)  -> ()

Adds a channel type that can be selected in the menu.

addOption

SelectMenu . addOption (

     self: SelectMenu
     option: option.JSON
)  -> ()

Adds an option to the select menu.

build

SelectMenu . build (

     self: SelectMenu
)  -> ()

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

new

SelectMenu . new (

     resource: {
       type: apiTypes.SelectMenuType?,
       customId: string?,
       options: { option.JSON,
    }
)  -> ()

Responsible for creating a new SelectMenu.