Pumpkin/pumpkin-plugin-wit/v0.1/plugin.wit

/// The main entry point for a Pumpkin plugin.
/// This world defines the exports that the plugin must provide to the host
/// and the imports that the host provides to the plugin.
package pumpkin:plugin@0.1.0;

world plugin {
    use context.{context};
    use event.{event};
    use server.{server as server-instance};
    use command.{command-sender, consumed-args, command-error};

    // --- Host-provided imports ---

    /// Provides logging capabilities to the plugin.
    import logging;
    /// Provides GUI creation and management.
    import gui;
    /// Provides scoreboard management.
    import scoreboard;
    /// Provides global server information and player lookup.
    import server;
    /// Provides text component building and formatting.
    import text;
    /// Provides command registration and argument parsing.
    import command;
    /// Provides the plugin execution context.
    import context;
    /// Provides internationalization and translation support.
    import i18n;
    /// Provides task scheduling for delayed or repeating logic.
    import scheduler;
    /// Provides world information and block manipulation.
    import %world;
    /// Provides entity types and manipulation.
    import entity;
    /// Provides boss bar creation and management.
    import boss-bar;

    // --- Plugin-provided exports ---

    /// Called by the host once to initialize the plugin.
    /// Internal use only; plugins should use the `register_plugin!` macro.
    export init-plugin: func();

    /// Called when the plugin is being loaded.
    /// Use this to register commands, events, and perform initial setup.
    export on-load: func(context: context) -> result<_, string>;

    /// Called when the plugin is being unloaded.
    /// Use this to save data and clean up resources.
    export on-unload: func(context: context) -> result<_, string>;

    /// Provides plugin metadata (name, version, etc.) to the host.
    export metadata;

    /// Dispatches an event to the plugin for handling.
    export handle-event: func(event-id: u32, server: server-instance, event: event) -> event;

    /// Dispatches a command execution to the plugin.
    export handle-command: func(command-id: u32, sender: command-sender, server: server-instance, args: consumed-args) -> result<s32, command-error>;

    /// Dispatches a scheduled task execution to the plugin.
    export handle-task: func(handler-id: u32, server: server-instance);
}