Calamity.Commands.Utils

Command handler utilities

Documentation

addCommands :: (BotC r, Typeable c, CommandContext c, Members [ParsePrefix Message, ConstructContext (Message, User, Maybe Member) c IO ()] r) => Sem (DSLState c r) a -> Sem r (Sem r (), CommandHandler c, a)

Construct commands and groups from a command DSL, then registers an event handler on the bot that manages running those commands.

Returns an action to remove the event handler, and the CommandHandler that was constructed.

Command Resolution

To determine if a command was invoked, and if so which command was invoked, the following happens:

1. parsePrefix is invoked, if no prefix is found: stop here.
2. The input is read a word at a time until a matching command is found, fire the "command-not-found" event if not.
3. A Context is built, and the command invoked.

Custom Events

This will fire the following events:

1. CtxCommandError

   Fired when a command returns an error.

2. CommandNotFound

   Fired when a valid prefix is used, but the command is not found.

3. CommandInvoked

   Fired when a command is successfully invoked.

useConstantPrefix :: Text -> Sem (ParsePrefix Message ': r) a -> Sem r a

A default interpretation for ParsePrefix that uses a single constant prefix.

data CmdInvokeFailReason c

Constructors

NoContext

NotFound [Text]

CommandInvokeError c CommandError

data CtxCommandError c

Constructors

CtxCommandError

Fields

• ctx :: c
• err :: CommandError

Instances

(k ~ A_Lens, a ~ c1, b ~ c2) => LabelOptic "ctx" k (CtxCommandError c1) (CtxCommandError c2) a b

Defined in Calamity.Commands.Utils

Methods

labelOptic :: Optic k NoIx (CtxCommandError c1) (CtxCommandError c2) a b

(k ~ A_Lens, a ~ CommandError, b ~ CommandError) => LabelOptic "err" k (CtxCommandError c) (CtxCommandError c) a b

Defined in Calamity.Commands.Utils

Methods

labelOptic :: Optic k NoIx (CtxCommandError c) (CtxCommandError c) a b

Show c => Show (CtxCommandError c)

Defined in Calamity.Commands.Utils

Methods

showsPrec :: Int -> CtxCommandError c -> ShowS

show :: CtxCommandError c -> String

showList :: [CtxCommandError c] -> ShowS

data CommandNotFound

Constructors

CommandNotFound

Fields

• msg :: Message
• user :: User
• member :: Maybe Member
• path :: [Text]

  The groups that were successfully parsed

Instances

Show CommandNotFound

Defined in Calamity.Commands.Utils

Methods

showsPrec :: Int -> CommandNotFound -> ShowS

show :: CommandNotFound -> String

showList :: [CommandNotFound] -> ShowS

(k ~ A_Lens, a ~ Maybe Member, b ~ Maybe Member) => LabelOptic "member" k CommandNotFound CommandNotFound a b

Defined in Calamity.Commands.Utils

Methods

labelOptic :: Optic k NoIx CommandNotFound CommandNotFound a b

(k ~ A_Lens, a ~ Message, b ~ Message) => LabelOptic "msg" k CommandNotFound CommandNotFound a b

Defined in Calamity.Commands.Utils

Methods

labelOptic :: Optic k NoIx CommandNotFound CommandNotFound a b

(k ~ A_Lens, a ~ [Text], b ~ [Text]) => LabelOptic "path" k CommandNotFound CommandNotFound a b

Defined in Calamity.Commands.Utils

Methods

labelOptic :: Optic k NoIx CommandNotFound CommandNotFound a b

(k ~ A_Lens, a ~ User, b ~ User) => LabelOptic "user" k CommandNotFound CommandNotFound a b

Defined in Calamity.Commands.Utils

Methods

labelOptic :: Optic k NoIx CommandNotFound CommandNotFound a b

newtype CommandInvoked c

Constructors

CommandInvoked

Fields

• ctx :: c

Instances

(k ~ An_Iso, a ~ c1, b ~ c2) => LabelOptic "ctx" k (CommandInvoked c1) (CommandInvoked c2) a b

Defined in Calamity.Commands.Utils

Methods

labelOptic :: Optic k NoIx (CommandInvoked c1) (CommandInvoked c2) a b

Show c => Show (CommandInvoked c)

Defined in Calamity.Commands.Utils

Methods

showsPrec :: Int -> CommandInvoked c -> ShowS

show :: CommandInvoked c -> String

showList :: [CommandInvoked c] -> ShowS