Calamity.Commands.Command

Commands and stuff

Documentation

data Command

A command

Constructors

forall a. Command

Fields

• names :: NonEmpty Text
• parent :: Maybe Group
• hidden :: Bool

  If this command is hidden

• checks :: [Check]

  A list of checks that must pass for this command to be invoked

• params :: [Text]

  A list of the parameters the command takes, only used for constructing help messages.

• help :: Context -> Text

  A function producing the 'help' for the command.

• parser :: Context -> IO (Either CommandError a)

  A function that parses the context for the command, producing the input a for the command.

• callback :: (Context, a) -> IO (Maybe Text)

  A function that given the context and the input (a) of the command, performs the action of the command.

Instances

Show Command

Defined in Calamity.Commands.Command

Methods

showsPrec :: Int -> Command -> ShowS

show :: Command -> String

showList :: [Command] -> ShowS

TextShow Command

Defined in Calamity.Commands.Command

Methods

showbPrec :: Int -> Command -> Builder

showb :: Command -> Builder

showbList :: [Command] -> Builder

showtPrec :: Int -> Command -> Text

showt :: Command -> Text

showtList :: [Command] -> Text

showtlPrec :: Int -> Command -> Text

showtl :: Command -> Text

showtlList :: [Command] -> Text