c

ackcord.commands

CommandDescription

case class CommandDescription(name: String, description: String, usage: String = "", extra: Map[String, String] = Map.empty) extends Product with Serializable

Represents non essential information about a command intended to be displayed to an end user.

name

The display name of a command.

description

The description of what a command does.

usage

How to use the command. Does not include the name or prefix.

extra

Extra stuff about the command that you yourself decide on.

Source
command.scala
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CommandDescription
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CommandDescription(name: String, description: String, usage: String = "", extra: Map[String, String] = Map.empty)

    name

    The display name of a command.

    description

    The description of what a command does.

    usage

    How to use the command. Does not include the name or prefix.

    extra

    Extra stuff about the command that you yourself decide on.

Value Members

  1. val description: String
  2. val extra: Map[String, String]
  3. val name: String
  4. def productElementNames: Iterator[String]
    Definition Classes
    Product
  5. val usage: String