ChatCommandComponent class abstract
An entity that is part of a chat command tree.
You might also be interested in:
- ChatCommand and ChatGroup, the concrete implementations of elements in a chat command tree.
- Implemented types
- Implementers
Constructors
Properties
-
aliases
→ Iterable<
String> -
The aliases for this entity.
no setter
-
checks
→ Iterable<
AbstractCheck> -
The checks that should be applied to this entity.
no setterinherited
-
children
→ Iterable<
ChatCommandComponent> -
A list of all the children of this group
no setteroverride
- description → String
-
The description of this entity.
no setter
- fullName → String
-
The full name of this command.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasSlashCommand → bool
-
Whether this entity has a child entity that is a slash command or has a slash command itself.
no setter
-
localizedDescriptions
→ Map<
Locale, String> ? -
The localized descriptions of this entity.
no setter
-
localizedNames
→ Map<
Locale, String> ? -
The localized names of this child.
Since you cannot add descriptions to UserCommand and MessageCommand, can't set localized descriptions too.
no setterinherited
- name → String
-
The name of this child.
no setterinherited
-
onPostCall
→ Stream<
ChatContext> -
A stream that emits contexts after the command callback is executed.
no setterinherited
-
onPreCall
→ Stream<
ChatContext> -
A stream that emits contexts before the command callback is executed.
no setterinherited
- options → CommandOptions
-
The options to use for this entity.
no setterinherited
-
parent
↔ CommandGroup<
CommandContext> ? -
The parent of this child.
getter/setter pairinherited
- resolvedOptions → CommandOptions
-
Get the resolved options for this child.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addCommand(
covariant CommandRegisterable< ChatContext> command) → void -
Add a command to this group.
inherited
-
check(
AbstractCheck check) → void -
Add a check to this entity.
inherited
-
getCommand(
StringView view) → ChatCommand? -
Attempt to get a command from a string.
override
-
getOptions(
CommandsPlugin commands) → List< CommandOptionBuilder> -
Return the
CommandOptionBuilders that represent this entity for slash command registration. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
walkCommands(
) → Iterable< ChatCommand> -
Returns an iterable that recursively iterates over all the
Commands in this group.override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited