youys
/
Discord.Net
Not watched
1
0
Fork 0
Code
Releases 34 Wiki Activity
Issues 0 Pull Requests 0 Datasets Model Cloudbrain
You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tree: ea82c2537e
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'ea82c2537e'
${ noResults }
Discord.Net/docs/guides/commands/preconditions.md

2.0 kB
Raw Blame History

Preconditions

Preconditions serve as a permissions system for your Commands. Keep in
mind, however, that they are not limited to just permissions and can
be as complex as you want them to be.

There are two types of Preconditions you can use:

  • PreconditionAttribute can be applied to Modules, Groups, or Commands.
  • ParameterPreconditionAttribute can be applied to Parameters.

You may visit their respective API documentation to find out more.

Bundled Preconditions

@Discord.Commands ships with several bundled Preconditions for you
to use.

Custom Preconditions

To write your own Precondition, create a new class that inherits from
either PreconditionAttribute or ParameterPreconditionAttribute
depending on your use.

In order for your Precondition to function, you will need to override
the CheckPermissionsAsync method.

If the context meets the required parameters, return
PreconditionResult.FromSuccess, otherwise return
PreconditionResult.FromError and include an error message if
necessary.

[!NOTE]
Visual Studio can help you implement missing members
from the abstract class by using the "Implement Abstract Class"
IntelliSense hint.

Example - Creating a Custom Precondition

[!code-csharpCustom Precondition]