# Text Option

<figure><img src="/files/MhqkVaZVg6O2fAX3z1Xo" alt=""><figcaption></figcaption></figure>

This block is a plain text option which allows you input a text value when entering your command on Discord.

<figure><img src="/files/H4ckxNLRZcyHX7DNMsd3" alt=""><figcaption></figcaption></figure>

You can retrieve the variable of the option via the **Clipboard** or the block itself. The format of the variable is `{option_optionname}`, where `optionname` is the [name](#option-name) of the option.

<figure><img src="/files/iyIq294cdupFYaMMFZEs" alt=""><figcaption></figcaption></figure>

## Option Name

This field requires an input for your unique option name. The designated name will then be the reference for your option variable.

<figure><img src="/files/3CSNborifAyHIUcDdi6e" alt=""><figcaption></figcaption></figure>

## Option Description

The option description field allows you to assign a custom description to your option. It is useful to describe what the option is used for.

<figure><img src="/files/mc5P9K1YsepjDNjeMMFM" alt=""><figcaption></figcaption></figure>

## Set Required

With this switch you are able to toggle if the option should be required or not in order to execute the command.

<figure><img src="/files/JCz4oPZ6cI4XvtFWD7cL" alt=""><figcaption></figcaption></figure>

## Add Choices

This is an optional section is where you can add choices into your option. Choices allow the user to select something from a fixed set of values. There is a maximum number of 25 choices.

<figure><img src="/files/RZJKwtAzydjFOdowJEPc" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/ZTvHS5YPhmirqHzI6ZfR" alt=""><figcaption></figcaption></figure>

## Autocomplete

Autocomplete is a feature for slash command text options that shows users a list of suggestions as they type. It makes commands easier to use, reduces typing errors, and creates a smoother experience.

Unlike [choices](#add-choices), the autocomplete feature will add choices to the action that are not required to be the same, meaning you can follow them, but it's not mandatory.

<figure><img src="/files/WLmJodT18AWQBH8X8RiJ" alt=""><figcaption></figcaption></figure>

Autocomplete can be configured by pressing the "Configure Autocomplete" button located in the settings of the text option.&#x20;

<figure><img src="/files/D1DUkKfqSKWvytSObno8" alt=""><figcaption></figcaption></figure>

{% tabs %}
{% tab title="Basic Mode" %}
The basic settings have been enabled by default when you start to configure autocomplete.&#x20;

<figure><img src="/files/31Gmobez3mdxRx7zOM0n" alt="" width="474"><figcaption></figcaption></figure>

### Choices

Choices can be addded by pressing the "Add Autocomplete Choice" in the image above.&#x20;

#### Label

The label is what's shown as choice to the user when they use the command.&#x20;

<figure><img src="/files/WLmJodT18AWQBH8X8RiJ" alt=""><figcaption></figcaption></figure>

#### Value

The value is what is returned as the `{option_optionname}` variable. The value is not visible to the user and can be something else than the label.&#x20;
{% endtab %}

{% tab title="Bulk Mode" %}
To access bulk mode, you have to enable it in the top of the autocomplete configuration.

<figure><img src="/files/V8C7sO4Z7XacILUMG8oW" alt="" width="473"><figcaption></figcaption></figure>

### Bulk Choices

Bulk choices can be added by pasting the lable and value seperated with a comma. An example can be found below:

```
label1,value1
label2,value2
label3,value3
```

When you have added the choices, simple press the "Parse and Replace Choices" button below the field. The choices will then also be visible when in Basic Mode.&#x20;
{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://documentation.botghost.com/custom-commands-and-events/options/text-option.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
