c

ackcord.commands

StructuredPrefixParser

case class StructuredPrefixParser(needsMention: (CacheSnapshot, Message) => Future[Boolean], symbols: (CacheSnapshot, Message) => Future[Seq[String]], aliases: (CacheSnapshot, Message) => Future[Seq[String]], caseSensitive: (CacheSnapshot, Message) => Future[Boolean] = (_, _) => Future.successful(false), canExecute: (CacheSnapshot, Message) => Future[Boolean] = (_, _) => Future.successful(true), mentionOrPrefix: (CacheSnapshot, Message) => Future[Boolean] = (_, _) => Future.successful(true)) extends PrefixParser with Product with Serializable

Represents information about how a command can be invoked in a structural way.

needsMention

If the command needs a mention

symbols

The valid prefix symbols for the command

aliases

The aliases for the command

caseSensitive

If the aliases should be case sensitive

canExecute

A early precheck if the command can execute at all

mentionOrPrefix

If true allows one to use a mention in place of a prefix. If needsMention is also true, skips the symbol check.

Source
prefixParser.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StructuredPrefixParser
  2. Serializable
  3. Product
  4. Equals
  5. PrefixParser
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new StructuredPrefixParser(needsMention: (CacheSnapshot, Message) => Future[Boolean], symbols: (CacheSnapshot, Message) => Future[Seq[String]], aliases: (CacheSnapshot, Message) => Future[Seq[String]], caseSensitive: (CacheSnapshot, Message) => Future[Boolean] = (_, _) => Future.successful(false), canExecute: (CacheSnapshot, Message) => Future[Boolean] = (_, _) => Future.successful(true), mentionOrPrefix: (CacheSnapshot, Message) => Future[Boolean] = (_, _) => Future.successful(true))

    needsMention

    If the command needs a mention

    symbols

    The valid prefix symbols for the command

    aliases

    The aliases for the command

    caseSensitive

    If the aliases should be case sensitive

    canExecute

    A early precheck if the command can execute at all

    mentionOrPrefix

    If true allows one to use a mention in place of a prefix. If needsMention is also true, skips the symbol check.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val aliases: (CacheSnapshot, Message) => Future[Seq[String]]
  5. def apply(message: Message)(implicit c: CacheSnapshot, ec: ExecutionContext): Future[MessageParser[Unit]]
    Definition Classes
    StructuredPrefixParserPrefixParser
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val canExecute: (CacheSnapshot, Message) => Future[Boolean]
  8. val caseSensitive: (CacheSnapshot, Message) => Future[Boolean]
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. val mentionOrPrefix: (CacheSnapshot, Message) => Future[Boolean]
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. val needsMention: (CacheSnapshot, Message) => Future[Boolean]
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. val symbols: (CacheSnapshot, Message) => Future[Seq[String]]
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from PrefixParser

Inherited from AnyRef

Inherited from Any

Ungrouped