Choice

Implementation of the Application Command Option Choice Structure in Luau.

https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-choice-structure

Summary

Properties

Choice.name :: stringChoice.nameLocalizations :: { [apiTypes.LanguageLocales]: string }Choice.value :: string | number

Methods

Choice:setName(name: string) → ChoiceChoice:setNameLocalization(localization: apiTypes.LanguageLocales, name: string) → ChoiceChoice:setValue(value: string | number) → ChoiceChoice:build() → JSON

Functions

Choice.new(resource: { name: string?, nameLocalizations: { [apiTypes.LanguageLocales]: string }?, value: string | number?, }?) → Choice

Properties

name

Choice.name  :: string

---

The name of the choice that is displayed to users.

nameLocalizations

Choice.nameLocalizations  :: {
{ [apiTypes.LanguageLocales]: string } }

---

Dictionary of localization entries for the choice name.

value

Choice.value  :: string | number

---

The value that is sent to your application when this choice is selected.

Methods

setName

Choice : setName ( name )  -> Choice

Responsible for setting the name of the choice. Name must be kebab case, with 1-100 characters.

Parameters

name: string

Returns

Choice

setNameLocalization

Choice : setNameLocalization ( localization ,  name )  -> Choice

Adding localization to the Name of the choice, enabling developers to create milti-language support.

Parameters

localization: LanguageLocales
name: string

Returns

Choice

setValue

Choice : setValue ( value )  -> Choice

Set the value of the choice, value can only be either a string or number.

Parameters

value: string | number

Returns

Choice

build

Choice : build ( )  -> JSON

Responsible for buillding the default reaction object that the Discord API can understand.

Returns

JSON

Functions

new

Choice . new ( resource )  -> Choice

Constructor for the Discord Default Reaction Builder.

local defaultReaction = Choice.new({
  name = "example-choice",
  value = "example-value",
}):build()

Parameters

resource: { name: string?, nameLocalizations: { [apiTypes.LanguageLocales], }

Returns

Choice