Calamity.Commands.Context

Command invokation context

Documentation

class CommandContext c => CalamityCommandContext c where

Methods

ctxChannelID :: c -> Snowflake Channel

The id of the channel that invoked this command

ctxGuildID :: c -> Maybe (Snowflake Guild)

The id of the guild the command was invoked in, if in a guild

ctxUserID :: c -> Snowflake User

The id of the user that invoked this command

ctxMessage :: c -> Message

The message that triggered this command

Instances

CalamityCommandContext FullContext

Defined in Calamity.Commands.Context

Methods

ctxChannelID :: FullContext -> Snowflake Channel

ctxGuildID :: FullContext -> Maybe (Snowflake Guild)

ctxUserID :: FullContext -> Snowflake User

ctxMessage :: FullContext -> Message

CalamityCommandContext LightContext

Defined in Calamity.Commands.Context

Methods

ctxChannelID :: LightContext -> Snowflake Channel

ctxGuildID :: LightContext -> Maybe (Snowflake Guild)

ctxUserID :: LightContext -> Snowflake User

ctxMessage :: LightContext -> Message

data FullContext

Invokation context for commands

Constructors

FullContext

Fields

• message :: Message

  The message that the command was invoked from

• guild :: Maybe Guild

  If the command was sent in a guild, this will be present

• member :: Maybe Member

  The member that invoked the command, if in a guild

  Note: If discord sent a member with the message, this is used; otherwise we try to fetch the member from the cache.

• channel :: Channel

  The channel the command was invoked from

• user :: User

  The user that invoked the command

• command :: Command FullContext

  The command that was invoked

• prefix :: Text

  The prefix that was used to invoke the command

• unparsedParams :: Text

  The message remaining after consuming the prefix

Instances

Show FullContext

Defined in Calamity.Commands.Context

Methods

showsPrec :: Int -> FullContext -> ShowS

show :: FullContext -> String

showList :: [FullContext] -> ShowS

CalamityCommandContext FullContext

Defined in Calamity.Commands.Context

Methods

ctxChannelID :: FullContext -> Snowflake Channel

ctxGuildID :: FullContext -> Maybe (Snowflake Guild)

ctxUserID :: FullContext -> Snowflake User

ctxMessage :: FullContext -> Message

Tellable FullContext

Defined in Calamity.Commands.Context

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member (Error RestError) r) => FullContext -> Sem r (Snowflake Channel)

TextShow FullContext

Defined in Calamity.Commands.Context

Methods

showbPrec :: Int -> FullContext -> Builder

showb :: FullContext -> Builder

showbList :: [FullContext] -> Builder

showtPrec :: Int -> FullContext -> Text

showt :: FullContext -> Text

showtList :: [FullContext] -> Text

showtlPrec :: Int -> FullContext -> Text

showtl :: FullContext -> Text

showtlList :: [FullContext] -> Text

HasID Channel FullContext

Defined in Calamity.Commands.Context

Methods

getID :: FullContext -> Snowflake Channel

HasID Message FullContext

Defined in Calamity.Commands.Context

Methods

getID :: FullContext -> Snowflake Message

HasID User FullContext

Defined in Calamity.Commands.Context

Methods

getID :: FullContext -> Snowflake User

CommandContext IO FullContext ()

Defined in Calamity.Commands.Context

Methods

ctxPrefix :: FullContext -> Text

ctxCommand :: FullContext -> Command IO FullContext ()

ctxUnparsedParams :: FullContext -> Text

(k ~ A_Lens, a ~ Channel, b ~ Channel) => LabelOptic "channel" k FullContext FullContext a b

Defined in Calamity.Commands.Context

Methods

labelOptic :: Optic k NoIx FullContext FullContext a b

(k ~ A_Lens, a ~ Command FullContext, b ~ Command FullContext) => LabelOptic "command" k FullContext FullContext a b

Defined in Calamity.Commands.Context

Methods

labelOptic :: Optic k NoIx FullContext FullContext a b

(k ~ A_Lens, a ~ Maybe Guild, b ~ Maybe Guild) => LabelOptic "guild" k FullContext FullContext a b

Defined in Calamity.Commands.Context

Methods

labelOptic :: Optic k NoIx FullContext FullContext a b

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

Defined in Calamity.Commands.Context

Methods

labelOptic :: Optic k NoIx FullContext FullContext a b

(k ~ A_Lens, a ~ Message, b ~ Message) => LabelOptic "message" k FullContext FullContext a b

Defined in Calamity.Commands.Context

Methods

labelOptic :: Optic k NoIx FullContext FullContext a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "prefix" k FullContext FullContext a b

Defined in Calamity.Commands.Context

Methods

labelOptic :: Optic k NoIx FullContext FullContext a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "unparsedParams" k FullContext FullContext a b

Defined in Calamity.Commands.Context

Methods

labelOptic :: Optic k NoIx FullContext FullContext a b

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

Defined in Calamity.Commands.Context

Methods

labelOptic :: Optic k NoIx FullContext FullContext a b

useFullContext :: Member CacheEff r => Sem (ConstructContext (Message, User, Maybe Member) FullContext IO () ': r) a -> Sem r a

data LightContext

A lightweight context that doesn't need any cache information

Constructors

LightContext

Fields

• message :: Message

  The message that the command was invoked from

• guildID :: Maybe (Snowflake Guild)

  If the command was sent in a guild, this will be present

• channelID :: Snowflake Channel

  The channel the command was invoked from

• user :: User

  The user that invoked the command

• member :: Maybe Member

  The member that triggered the command.

  Note: Only sent if discord sent the member object with the message.

• command :: Command LightContext

  The command that was invoked

• prefix :: Text

  The prefix that was used to invoke the command

• unparsedParams :: Text

  The message remaining after consuming the prefix

Instances

Show LightContext

Defined in Calamity.Commands.Context

Methods

showsPrec :: Int -> LightContext -> ShowS

show :: LightContext -> String

showList :: [LightContext] -> ShowS

CalamityCommandContext LightContext

Defined in Calamity.Commands.Context

Methods

ctxChannelID :: LightContext -> Snowflake Channel

ctxGuildID :: LightContext -> Maybe (Snowflake Guild)

ctxUserID :: LightContext -> Snowflake User

ctxMessage :: LightContext -> Message

Tellable LightContext

Defined in Calamity.Commands.Context

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member (Error RestError) r) => LightContext -> Sem r (Snowflake Channel)

TextShow LightContext

Defined in Calamity.Commands.Context

Methods

showbPrec :: Int -> LightContext -> Builder

showb :: LightContext -> Builder

showbList :: [LightContext] -> Builder

showtPrec :: Int -> LightContext -> Text

showt :: LightContext -> Text

showtList :: [LightContext] -> Text

showtlPrec :: Int -> LightContext -> Text

showtl :: LightContext -> Text

showtlList :: [LightContext] -> Text

HasID Channel LightContext

Defined in Calamity.Commands.Context

Methods

getID :: LightContext -> Snowflake Channel

HasID Message LightContext

Defined in Calamity.Commands.Context

Methods

getID :: LightContext -> Snowflake Message

HasID User LightContext

Defined in Calamity.Commands.Context

Methods

getID :: LightContext -> Snowflake User

CommandContext IO LightContext ()

Defined in Calamity.Commands.Context

Methods

ctxPrefix :: LightContext -> Text

ctxCommand :: LightContext -> Command IO LightContext ()

ctxUnparsedParams :: LightContext -> Text

(k ~ A_Lens, a ~ Snowflake Channel, b ~ Snowflake Channel) => LabelOptic "channelID" k LightContext LightContext a b

Defined in Calamity.Commands.Context

Methods

labelOptic :: Optic k NoIx LightContext LightContext a b

(k ~ A_Lens, a ~ Command LightContext, b ~ Command LightContext) => LabelOptic "command" k LightContext LightContext a b

Defined in Calamity.Commands.Context

Methods

labelOptic :: Optic k NoIx LightContext LightContext a b

(k ~ A_Lens, a ~ Maybe (Snowflake Guild), b ~ Maybe (Snowflake Guild)) => LabelOptic "guildID" k LightContext LightContext a b

Defined in Calamity.Commands.Context

Methods

labelOptic :: Optic k NoIx LightContext LightContext a b

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

Defined in Calamity.Commands.Context

Methods

labelOptic :: Optic k NoIx LightContext LightContext a b

(k ~ A_Lens, a ~ Message, b ~ Message) => LabelOptic "message" k LightContext LightContext a b

Defined in Calamity.Commands.Context

Methods

labelOptic :: Optic k NoIx LightContext LightContext a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "prefix" k LightContext LightContext a b

Defined in Calamity.Commands.Context

Methods

labelOptic :: Optic k NoIx LightContext LightContext a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "unparsedParams" k LightContext LightContext a b

Defined in Calamity.Commands.Context

Methods

labelOptic :: Optic k NoIx LightContext LightContext a b

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

Defined in Calamity.Commands.Context

Methods

labelOptic :: Optic k NoIx LightContext LightContext a b

useLightContext :: Sem (ConstructContext (Message, User, Maybe Member) LightContext IO () ': r) a -> Sem r a