github/Discord.Net
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Include command contexts on docs

Browse Source
This commit is contained in:
Christopher F
2017-01-14 19:09:21 -05:00
parent fbc32b3dc4
commit 236304c1a4
1 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/guides/commands.md
View File

@@ -61,7 +61,7 @@ By now, your module should look like this:
[IoC]: https://msdn.microsoft.com/en-us/library/ff921087.aspx [IoC]: https://msdn.microsoft.com/en-us/library/ff921087.aspx
[Dependency Injection]: https://msdn.microsoft.com/en-us/library/ff921152.aspx [Dependency Injection]: https://msdn.microsoft.com/en-us/library/ff921152.aspx
[ModuleBase]: xref:Discord.Commands.ModuleBase [ModuleBase]: xref:Discord.Commands.ModuleBase-1
### Adding Commands ### Adding Commands
@@ -117,12 +117,21 @@ property on [ModuleBase]. CommandContext allows you to access the
message, channel, guild, and user that the command was invoked from, message, channel, guild, and user that the command was invoked from,
as well as the underlying discord client the command was invoked from. as well as the underlying discord client the command was invoked from.
You may need to cast these objects to their Socket counterparts (see Different types of Contexts may be specified using the generic variant
the terminology section). of [ModuleBase]. When using a [SocketCommandContext], for example,
the properties on this context will already be Socket entities. You
will not need to cast them.
To reply to messages, you may also invoke [ReplyAsync], instead of To reply to messages, you may also invoke [ReplyAsync], instead of
accessing the channel through the [Context] and sending a message. accessing the channel through the [Context] and sending a message.
[Context]: xref:Discord.Commands.ModuleBase-1#Discord_Commands_ModuleBase_1_Context
[SocketCommandContext]: Discord.Commands.SocketCommandContext
>![WARNING]
>Contexts should **NOT** be mixed! You cannot have one module that
>uses CommandContext, and another that uses SocketCommandContext.
### Example Module ### Example Module
At this point, your module should look comparable to this example: At this point, your module should look comparable to this example: