/form¶
Tip
This command requires the administrator permission by default.
To learn how to change this, please check the faq command.
Creating forms users can fill out.
/form create¶
Tip
This command requires the administrator permission by default.
To learn how to change this, please check the faq command.
Creates a button which opens up a form with questions. Once answered, the response will be forwarded to a different channel.
Tip
When deciding on what kind of question to ask, consider the following:
- short is a single line text input.
- long is a multi-line text input.
- select is a dropdown menu where users can select one or more options, depending on what you state in Maximum length.
The options should be separated by a new line in the Placeholder field and there can only be 25 options per dropdown.
-
user_selectis a dropdown menu where users can select one or more users from the server, depending on what you state inMaximum length. This will automatically populate the menu with your entire server's userlist. Note that Discord limits these to max 25 per selection. -
role_selectis a dropdown menu where users can select one or more roles from the server, depending on what you state inMaximum length. This will automatically populate the menu with your entire server's rolelist. Note that Discord limits these to max 25 per selection. -
channel_selectis a dropdown menu where users can select one or more channels from the server, depending on what you state inMaximum length. This will automatically populate the menu with all channels visible to the person clicking the button. Note that Discord limits these to max 25 per selection. -
fileallows users to upload one or more files, depending on what you state inMaximum length. Note that Discord limits file uploads to 10 files per upload.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
form_title
|
Range[str, 1, 45]
|
The title of your form. |
required |
forward_channel
|
TextChannel
|
The channel answers should be sent to. |
required |
amount_of_questions
|
Range[int, 1, 100]
|
The amount of questions you'd like to ask, 1 - 100. |
required |
embed_title
|
Transform[str, TextTransformer]
|
The title you'd like the embed to have. |
None
|
embed_description
|
Transform[str, TextTransformer]
|
A description for the embed. |
None
|
add_reactions
|
bool
|
Whether reactions should be added to responses. Thumbs up / down / shrug. |
False
|
threads
|
bool
|
Whether a thread should be created automatically for responses. |
False
|
button_label
|
Range[str, 0, 20]
|
The text you'd like to appear on the button. Requires T1 Patreon. |
None
|
button_emoji
|
Transform[str, PartialEmojiTransformer]
|
The emoji you'd like the button to have. Requires T1 Patreon. |
None
|
anonymous
|
bool
|
whether the form should be anonymous or not. Defaults to not being anonymous. |
False
|
/form edit¶
Tip
This command requires the administrator permission by default.
To learn how to change this, please check the faq command.
Edits a form that was created with the /form create command.
Once answered, the response will be forwarded to a different channel.
Tip
When deciding on what kind of question to ask, consider the following:
- short is a single line text input.
- long is a multi-line text input.
- select is a dropdown menu where users can select one or more options, depending on what you state in Maximum length.
The options should be separated by a new line in the Placeholder field and there can only be 25 options per dropdown.
-
user_selectis a dropdown menu where users can select one or more users from the server, depending on what you state inMaximum length. This will automatically populate the menu with your entire server's userlist. Note that Discord limits these to max 25 per selection. -
role_selectis a dropdown menu where users can select one or more roles from the server, depending on what you state inMaximum length. This will automatically populate the menu with your entire server's rolelist. Note that Discord limits these to max 25 per selection. -
channel_selectis a dropdown menu where users can select one or more channels from the server, depending on what you state inMaximum length. This will automatically populate the menu with all channels visible to the person clicking the button. Note that Discord limits these to max 25 per selection. -
fileallows users to upload one or more files, depending on what you state inMaximum length. Note that Discord limits file uploads to 10 files per upload.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message
|
Transform[Message, MessageTransformer]
|
The message that contains the form button to edit. |
required |
form_title
|
Range[str, 1, 45] | None
|
The title of your form. |
None
|
forward_channel
|
TextChannel | None
|
The channel answers should be sent to. |
None
|
amount_of_questions
|
Range[int, 1, 100] | None
|
Change the amount of questions you'd like to ask, 1 - 100. Defaults to the amount of questions already set. |
None
|
embed_title
|
Transform[str, TextTransformer] | None
|
The title you'd like the embed to have. |
None
|
embed_description
|
Transform[str, TextTransformer] | None
|
A description for the embed. |
None
|
add_reactions
|
bool | None
|
Whether reactions should be added to responses. Thumbs up / down / shrug. |
None
|
threads
|
bool | None
|
Whether a thread should be created automatically for responses. |
None
|
button_label
|
Range[str, 0, 20] | None
|
The text you'd like to appear on the button. Requires T1 Patreon. |
None
|
button_emoji
|
Transform[str, PartialEmojiTransformer] | None
|
The emoji you'd like the button to have. Requires T1 Patreon. |
None
|