Package group.worldstandard.pudel.api.annotation

package group.worldstandard.pudel.api.annotation

Annotations for declaring plugin metadata, commands, and event handlers.

This package contains all annotations used to declaratively define plugin behavior. Using annotations is the preferred approach for plugin development as it simplifies registration and lifecycle management.

Plugin Declaration:

• Plugin - Marks a class as a plugin entrypoint

Command Annotations:

• Choice - Defines predefined choices for command options
• CommandOption - Defines command options/parameters
• ContextMenu - Declares a context menu handler
• SlashCommand - Declares a slash command handler
• Subcommand - Defines subcommands for slash commands
• TextCommand - Declares a text (prefix) command handler

Interaction Handler Annotations:

• ButtonHandler - Handles button interactions
• ModalHandler - Handles modal submissions
• SelectMenuHandler - Handles select menu interactions

Lifecycle Annotations:

• OnDisable - Called when plugin is disabled
• OnEnable - Called when plugin is enabled
• OnShutdown - Called when bot is shutting down

Example Usage:

@Plugin(name = "MyPlugin", version = "1.0.0", author = "Author")
public class MyPlugin {

    @OnEnable
    public void onEnable(PluginContext context) {
        // Plugin initialization
    }

    @SlashCommand(name = "ping", description = "Check latency")
    public void ping(SlashCommandInteractionEvent event) {
        event.reply("Pong!").queue();
    }
}

Since:

2.3.0

Related Packages

Package	Description
group.worldstandard.pudel.api	Core API for the Pudel Plugin Development Kit (PDK).

Annotation Interfaces

Class	Description
ButtonHandler	Marks a method as a button interaction handler.
Choice	Defines a choice for command options.
CommandOption	Defines a command option for slash commands.
ContextMenu	Marks a method as a context menu handler.
ModalHandler	Marks a method as a modal submission handler.
OnDisable	Marks a method to be called when the plugin is disabled.
OnEnable	Marks a method to be called when the plugin is enabled.
OnShutdown	Marks a method to be called when the plugin is being unloaded/shutdown.
Plugin	Marks a class as a Pudel plugin.
SelectMenuHandler	Marks a method as a select menu handler.
SlashCommand	Marks a method as a slash command handler.
Subcommand	Defines a subcommand for slash commands.
TextCommand	Marks a method as a text command handler.