Skip to content

Latest commit

 

History

History
26 lines (19 loc) · 1.34 KB

File metadata and controls

26 lines (19 loc) · 1.34 KB

Option

Declares a method parameter as a user-supplied command option.

use Tempcord\Attributes\Option;

Applies to: parameter

Parameters

Name Type Default Description
description string required shown beneath the option in Discord's picker
name ?string null defaults to the parameter's own name
autocomplete Autocomplete|string|null null suggests values as the user types; mutually exclusive with choices. Given a class name it is built by the container, so it may take dependencies; given an object it is used as it stands. Suggestions that belong to one command are usually better written as a method carrying #[Autocomplete].
choices array [] the only values Discord will accept. A map uses its keys as the labels users see; a list shows each value as its own label. Mutually exclusive with autocomplete.
minValue int|float|null null smallest accepted number
maxValue int|float|null null largest accepted number
minLength ?int null shortest accepted string
maxLength ?int null longest accepted string
channelTypes array [] restricts which channels may be picked, for a Channel option