Class

ackcord.commands

CommandSettings

Related Doc: package commands

Permalink

case class CommandSettings[F[_]](needsMention: Boolean, prefixes: Set[String])(implicit evidence$1: Applicative[F]) extends AbstractCommandSettings[F] with Product with Serializable

A simple AbstractCommandSettings that can be used when you know in advance if commands need a mention at the start, and what prefixes are valid.

needsMention

If a mention should always be required.

prefixes

All the valid prefixes for commands.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CommandSettings
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AbstractCommandSettings
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CommandSettings(needsMention: Boolean, prefixes: Set[String])(implicit arg0: Applicative[F])

    Permalink

    needsMention

    If a mention should always be required.

    prefixes

    All the valid prefixes for commands.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  8. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  9. def getPrefix(args: Seq[String], message: Message)(implicit c: CacheSnapshot[F]): OptionT[F, (String, Seq[String])]

    Permalink

    Extracts the prefix for a command, and the remaining arguments given a message.

    Extracts the prefix for a command, and the remaining arguments given a message.

    args

    The arguments for the command. The first argument is the prefix.

    message

    The message object that sent the command.

    returns

    Some if a given prefix is valid, otherwise None. The first string in the tuple is the prefix, while the Seq[String] is the remaining arguments.

    Definition Classes
    CommandSettingsAbstractCommandSettings
  10. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def needMention(message: Message)(implicit c: CacheSnapshot[F]): F[Boolean]

    Permalink

    Checks if a given message needs a mention at the start.

    Checks if a given message needs a mention at the start.

    Definition Classes
    CommandSettingsAbstractCommandSettings
  13. val needsMention: Boolean

    Permalink

    If a mention should always be required.

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. val prefixes: Set[String]

    Permalink

    All the valid prefixes for commands.

  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  18. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AbstractCommandSettings[F]

Inherited from AnyRef

Inherited from Any

Ungrouped