Skip to content

2_commands.md

Latest commit

 

History

History
45 lines (34 loc) · 3.12 KB

2_commands.md

File metadata and controls

45 lines (34 loc) · 3.12 KB
Raw

Commands

Aliucord offers a rich commands api which makes it easy to implement your own commands. It hooks into slash commands so all commands will be made available along with the regular slash commands.

The basics

Every plugin has its own CommandsAPI made available as commands inside your plugin class.

You can register commands using commands.registerCommand(name, description, options, callback) and unregister them later either by using commands.unregisterCommand(commandName) or via commands.unregisterAll(). Commands should be unique, so please use a meaningful command name that won't overlap with other plugins.

Commands are run on a separate thread, so you can do heavy work here, send Http Requests, etc...

Errors are caught and will be presented to the user in a nicely formatted error, but you should still make sure your command never throws errors.

The callback is a lambda function that gets the CommandContext as only argument and should return a CommandResult or null to send no reply.

Please refer to the CommandContext Javadoc for the available methods

CommandOptions

Command Options are options the user can specify. They can be used to make the user input any text, select from a selection of values, select another user, etc. These are kind of a mess and take a lot of arguments because they come from Discord. Simply pass null, Collections.emptyList() or whatever may be suitable.

Quick rundown (Note: You cannot create CommandChoices yourself, use Utils.createCommandChoice)

Utils.createCommandOption(
        type: ApplicationCommandType = ApplicationCommandType.STRING, // The type of this option, e.g. String, User or SubCommand
        name: String, // The name of this option
        description: String? = null, // This will both be shown to the user and be the key of this argument in the callback
        descriptionRes: Int? = null, // Resource ID of the description string. If discord has a string you find suitable, use this to have the description be localized, otherwise pass null
        required: Boolean = false, // Whether this option is required or not
        default: Boolean = false, // Whether this option is the default selected option
        channelTypes: List<Int?> = emptyList(), // Most likely the allowed channels this can be used in, but not certian, recommended to keep this an empty list.
        choices: List<CommandChoice> = emptyList(), // The pre-chosen options that this can be, if it is a STRING option
        subCommandOptions: List<ApplicationCommandOption> = emptyList(), // The child subcommand options if applicable
        autocomplete: Boolean = false // Currently unknown to exactly what this does, it is recommended to either pass false or ommit this parameter all together.
): ApplicationCommandOption