abstract class HelpCommand extends CommandController

The basic structure for a help command. Only accepts commands that use StructuredPrefixParser.

Source
HelpCommand.scala
Linear Supertypes
CommandController, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HelpCommand
  2. CommandController
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new HelpCommand(requests: requests.Requests)

Abstract Value Members

  1. abstract def createReplyAll(message: Message, page: Int)(implicit c: CacheSnapshot): Future[CreateMessageData]

    Create a reply for all the commands tracked by this help command.

    Create a reply for all the commands tracked by this help command.

    page

    The page to use. Starts at 0.

    returns

    Data to create a message describing the commands tracked by this help command.

  2. abstract def createSearchReply(message: Message, query: String, matches: Seq[HelpCommandProcessedEntry])(implicit c: CacheSnapshot): Future[CreateMessageData]

    Create a reply for a search result

    Create a reply for a search result

    matches

    All the commands that matched the arguments

    returns

    Data to create a message describing the search

Concrete Value Members

  1. val Command: CommandBuilder[UserCommandMessage, NotUsed]

    The default command builder you will use to create most of your commands.

    The default command builder you will use to create most of your commands. By default blocks bots from using the commands.

    Definition Classes
    CommandController
  2. val GuildCommand: CommandBuilder[GuildMemberCommandMessage, NotUsed]

    Another default command builder for you to use.

    Another default command builder for you to use. Can only be used in guilds, and includes the guild, guild channel and user of the command.

    Definition Classes
    CommandController
  3. val GuildVoiceCommand: CommandBuilder[VoiceGuildMemberCommandMessage, NotUsed]

    A command builder that only accepts users that are in a voice channel.

    A command builder that only accepts users that are in a voice channel.

    Definition Classes
    CommandController
  4. val baseCommandBuilder: CommandBuilder[CommandMessage, NotUsed]

    The base command builder that you can build off if you don't like the default provided builder.

    The base command builder that you can build off if you don't like the default provided builder.

    Definition Classes
    CommandController
  5. val command: ComplexCommand[Option[Args], NotUsed]
  6. def defaultMentionOrPrefix: Boolean

    Determines the default value for mention or prefix when creating a named command.

    Determines the default value for mention or prefix when creating a named command.

    Definition Classes
    CommandController
  7. def defaultMustMention: Boolean

    Determines the default value for if a mention should required.

    Determines the default value for if a mention should required.

    Definition Classes
    CommandController
  8. implicit val ec: ExecutionContext
    Definition Classes
    CommandController
  9. implicit def findCache[A](implicit message: CommandMessage[A]): CacheSnapshot
    Definition Classes
    CommandController
  10. def registerCommand(prefix: StructuredPrefixParser, description: CommandDescription, done: Future[Done]): Unit
  11. val requestHelper: requests.RequestsHelper
    Definition Classes
    CommandController
  12. val requests: requests.Requests
    Definition Classes
    CommandController
  13. def unknownCmd(command: String): Option[CreateMessageData]