pumpkin-api-py 0.1.0.dev0__py3-none-any.whl

pumpkin_api/wit/wit_world/imports/world.py

@@ -0,0 +1,215 @@
+# This file is automatically generated by componentize-py
+# It is not intended for manual editing.
+from typing import TypeVar, Generic, Union, Optional, Protocol, Tuple, List, Any, Self, Callable
+from types import TracebackType
+from enum import Flag, Enum, auto
+from dataclasses import dataclass
+from abc import abstractmethod
+import weakref
+
+from componentize_py_types import Result, Ok, Err, Some
+from ..imports import text
+from ..imports import scoreboard
+
+class PistonBehavior(Enum):
+    """
+    Defines how a block reacts when pushed by a piston.
+    """
+    NORMAL = 0
+    DESTROY = 1
+    BLOCK = 2
+    IGNORE = 3
+    PUSH_ONLY = 4
+
+class SoundCategory(Enum):
+    """
+    Categories for sounds to control their volume independently.
+    """
+    MASTER = 0
+    MUSIC = 1
+    RECORDS = 2
+    WEATHER = 3
+    BLOCKS = 4
+    HOSTILE = 5
+    NEUTRAL = 6
+    PLAYERS = 7
+    AMBIENT = 8
+    VOICE = 9
+
+class ExplosionInteraction(Enum):
+    """
+    Defines how an explosion interacts with blocks in the world.
+    """
+    NONE = 0
+    BLOCK = 1
+    MOB = 2
+    TNT = 3
+    TRIGGER = 4
+
+class BlockFlags(Flag):
+    """
+    Flags used to control block updates and notifications.
+    """
+    NOTIFY_NEIGHBORS = auto()
+    NOTIFY_LISTENERS = auto()
+    FORCE_STATE = auto()
+    SKIP_DROPS = auto()
+    MOVED = auto()
+    SKIP_REDSTONE_WIRE_STATE_REPLACEMENT = auto()
+    SKIP_BLOCK_ENTITY_REPLACED_CALLBACK = auto()
+    SKIP_BLOCK_ADDED_CALLBACK = auto()
+
+@dataclass
+class BlockState:
+    """
+    Detailed information about a block's state.
+    """
+    id: int
+    luminance: int
+    opacity: int
+    hardness: float
+    is_air: bool
+    is_liquid: bool
+    is_solid: bool
+    is_full_cube: bool
+    piston_behavior: PistonBehavior
+    has_random_ticks: bool
+
+@dataclass
+class BlockStateId:
+    """
+    A simple wrapper for a block state ID.
+    """
+    id: int
+
+@dataclass
+class BlockPos:
+    """
+    A position in the world grid.
+    """
+    x: int
+    y: int
+    z: int
+
+class World:
+    """
+    Represents a Minecraft world (dimension).
+    """
+    
+    def get_id(self) -> str:
+        """
+        Returns the unique identifier of this world.
+        """
+        raise NotImplementedError
+    def get_block_state_id(self, pos: BlockPos) -> int:
+        """
+        Gets the block state ID at the specified position.
+        """
+        raise NotImplementedError
+    def get_block_state(self, pos: BlockPos) -> BlockState:
+        """
+        Gets detailed block state information at the specified position.
+        """
+        raise NotImplementedError
+    def set_block_state(self, pos: BlockPos, state: int, update_flags: BlockFlags) -> None:
+        """
+        Sets the block state at the specified position.
+        """
+        raise NotImplementedError
+    def get_time_of_day(self) -> int:
+        """
+        Returns the current time of day in ticks.
+        """
+        raise NotImplementedError
+    def set_time_of_day(self, time: int) -> None:
+        """
+        Sets the current time of day in ticks.
+        """
+        raise NotImplementedError
+    def get_world_age(self) -> int:
+        """
+        Returns the total age of the world in ticks.
+        """
+        raise NotImplementedError
+    def get_dimension(self) -> str:
+        """
+        Returns the dimension type (e.g., "minecraft:overworld").
+        """
+        raise NotImplementedError
+    def get_top_block_y(self, x: int, z: int) -> int:
+        """
+        Gets the highest non-air block Y coordinate at the specified X and Z.
+        """
+        raise NotImplementedError
+    def get_motion_blocking_height(self, x: int, z: int) -> int:
+        """
+        Gets the highest motion-blocking block Y coordinate.
+        """
+        raise NotImplementedError
+    def is_raining(self) -> bool:
+        """
+        Returns whether it is currently raining or snowing.
+        """
+        raise NotImplementedError
+    def set_raining(self, raining: bool) -> None:
+        """
+        Sets whether it should be raining or snowing.
+        """
+        raise NotImplementedError
+    def is_thundering(self) -> bool:
+        """
+        Returns whether there is currently a thunderstorm.
+        """
+        raise NotImplementedError
+    def set_thundering(self, thundering: bool) -> None:
+        """
+        Sets whether there should be a thunderstorm.
+        """
+        raise NotImplementedError
+    def broadcast_system_message(self, message: text.TextComponent, overlay: bool) -> None:
+        """
+        Broadcasts a system message to all players in this world.
+        """
+        raise NotImplementedError
+    def get_scoreboard(self) -> scoreboard.Scoreboard:
+        """
+        Returns the scoreboard associated with this world.
+        """
+        raise NotImplementedError
+    def play_sound(self, sound: str, category: SoundCategory, pos: Tuple[float, float, float], volume: float, pitch: float) -> None:
+        """
+        Plays a sound at the specified position for all players in the world.
+        """
+        raise NotImplementedError
+    def spawn_particle(self, particle: str, pos: Tuple[float, float, float], offset: Tuple[float, float, float], max_speed: float, count: int) -> None:
+        """
+        Spawns particles at the specified position.
+        """
+        raise NotImplementedError
+    def create_explosion(self, pos: Tuple[float, float, float], power: float, create_fire: bool, interaction: ExplosionInteraction) -> None:
+        """
+        Creates an explosion at the specified position.
+        """
+        raise NotImplementedError
+    def get_sea_level(self) -> int:
+        """
+        Returns the sea level of this world.
+        """
+        raise NotImplementedError
+    def get_min_y(self) -> int:
+        """
+        Returns the minimum Y coordinate (bottom of the world).
+        """
+        raise NotImplementedError
+    def __enter__(self) -> Self:
+        """Returns self"""
+        return self
+                                
+    def __exit__(self, exc_type: type[BaseException] | None, exc_value: BaseException | None, traceback: TracebackType | None) -> bool | None:
+        """
+        Release this resource.
+        """
+        raise NotImplementedError
+
+
+

pumpkin_api/wit_files/command.wit

@@ -0,0 +1,189 @@
+interface command {
+    use player.{player};
+    use %world.{%world};
+    use entity.{command-block-entity, entity};
+    use common.{position, block-position, locale};
+    use server.{server, difficulty};
+    use text.{text-component};
+
+    enum gamemode {
+        survival,
+        creative,
+        adventure,
+        spectator,
+    }
+
+    enum bossbar-color {
+        pink,
+        blue,
+        red,
+        green,
+        yellow,
+        purple,
+        white,
+    }
+
+    enum bossbar-style {
+        no-division,
+        notches6,
+        notches10,
+        notches12,
+        notches20,
+    }
+
+    enum sound-category {
+        master,
+        music,
+        records,
+        weather,
+        blocks,
+        hostile,
+        neutral,
+        players,
+        ambient,
+        voice,
+        ui,
+    }
+
+    enum entity-anchor {
+        feet,
+        eyes,
+    }
+
+    variant number {
+        float64(f64),
+        float32(f32),
+        int32(s32),
+        int64(s64),
+    }
+
+    variant not-in-bounds {
+        lower-bound(tuple<number, number>),
+        upper-bound(tuple<number, number>),
+    }
+
+    variant arg {
+        entities(list<entity>),
+        entity(entity),
+        players(list<player>),
+        block-pos(block-position),
+        pos3d(position),
+        pos2d(tuple<f64, f64>),
+        rotation(tuple<f32, bool, f32, bool>),
+        game-mode(gamemode),
+        difficulty(difficulty),
+        item(string),
+        item-predicate(string),
+        resource-location(string),
+        block(string),
+        block-predicate(string),
+        bossbar-color(bossbar-color),
+        bossbar-style(bossbar-style),
+        particle(string),
+        msg(string),
+        text-component(text-component),
+        time(s32),
+        num(result<number, not-in-bounds>),
+        %bool(bool),
+        simple(string),
+        sound-category(sound-category),
+        damage-type(string),
+        effect(string),
+        enchantment(string),
+        entity-anchor(entity-anchor),
+    }
+
+    resource consumed-args {
+        get-value: func(key: string) -> arg;
+    }
+
+    variant command-sender-type {
+        rcon,
+        console,
+        player(player),
+        command-block(tuple<command-block-entity, %world>),
+        dummy,
+    }
+
+    enum permission-level {
+        zero,
+        one,
+        two,
+        three,
+        four,
+    }
+
+    resource command-sender {
+        get-command-sender-type: func() -> command-sender-type;
+        send-message: func(text: text-component);
+        set-success-count: func(count: s32);
+        is-player: func() -> bool;
+        is-console: func() -> bool;
+        as-player: func() -> option<player>;
+        permission-level: func() -> permission-level;
+        has-permission-level: func(level: permission-level) -> bool;
+        has-permission: func(server: borrow<server>, node: string) -> bool;
+        position: func() -> option<position>;
+        %world: func() -> option<%world>;
+        get-locale: func() -> locale;
+        should-receive-feedback: func() -> bool;
+        should-broadcast-console-to-ops: func() -> bool;
+        should-track-output: func() -> bool;
+    }
+
+    enum string-type {
+        single-word,
+        quotable,
+        greedy,
+    }
+
+    variant argument-type {
+        %bool,
+        float(tuple<option<f32>, option<f32>>),
+        double(tuple<option<f64>, option<f64>>),
+        integer(tuple<option<s32>, option<s32>>),
+        long(tuple<option<s64>, option<s64>>),
+        %string(string-type),
+        entities,
+        entity,
+        %players,
+        game-profile,
+        block-pos,
+        position3d,
+        position2d,
+        block-state,
+        block-predicate,
+        item,
+        item-predicate,
+        component,
+        rotation,
+        %resource-location,
+        entity-anchor,
+        gamemode,
+        difficulty,
+        time(s32),
+        %resource(string),
+    }
+
+    variant command-error {
+        invalid-consumption(option<string>),
+        invalid-requirement,
+        permission-denied,
+        command-failed(text-component),
+    }
+
+    resource command-node {
+        literal: static func(name: string) -> command-node;
+        argument: static func(name: string, arg-type: argument-type) -> command-node;
+        then: func(node: command-node);
+        execute-with-handler-id: func(handler-id: u32);
+        require-with-handler-id: func(handler-id: u32);
+    }
+
+    resource command {
+        /// First name is primary, rest are aliases
+        constructor(names: list<string>, description: string);
+        then: func(node: command-node);
+        execute-with-handler-id: func(handler-id: u32);
+    }
+}

pumpkin_api/wit_files/common.wit

@@ -0,0 +1,201 @@
+/// Provides common types and utilities used across the entire plugin API.
+interface common {
+    /// Serialized text component as a postcard byte array.
+    /// @deprecated Use the text-component resource from the text interface instead.
+    type raw-text-component = list<u8>;
+
+    /// A position in the world grid (integers).
+    type block-position = tuple<s32, s32, s32>;
+
+    /// A precise coordinate in the world (floats).
+    type position = tuple<f64, f64, f64>;
+
+    /// Represents the hands of a player.
+    enum hand {
+        left,
+        right,
+    }
+
+    /// Represents the game modes available in Minecraft.
+    enum game-mode {
+        survival,
+        creative,
+        adventure,
+        spectator,
+    }
+
+    /// The 16 base Minecraft colors.
+    enum named-color {
+        black,
+        dark-blue,
+        dark-green,
+        dark-aqua,
+        dark-red,
+        dark-purple,
+        gold,
+        gray,
+        dark-gray,
+        blue,
+        green,
+        aqua,
+        red,
+        light-purple,
+        yellow,
+        white,
+    }
+
+    /// An RGB color represented by its red, green, and blue components.
+    record rgb-color {
+        r: u8,
+        g: u8,
+        b: u8,
+    }
+
+    /// An ARGB color with alpha (transparency) channel.
+    record argb-color {
+        a: u8,
+        r: u8,
+        g: u8,
+        b: u8,
+    }
+
+    /// Represents a stack of items with its type and count.
+    record item-stack {
+        /// The unique registry key (e.g., "minecraft:diamond").
+        registry-key: string,
+        /// The number of items in the stack.
+        count: u8,
+    }
+
+    /// All Minecraft-supported locales.
+    enum locale {
+        af-za,
+        ar-sa,
+        ast-es,
+        az-az,
+        ba-ru,
+        bar,
+        be-by,
+        bg-bg,
+        br-fr,
+        brb,
+        bs-ba,
+        ca-es,
+        cs-cz,
+        cy-gb,
+        da-dk,
+        de-at,
+        de-ch,
+        de-de,
+        el-gr,
+        en-au,
+        en-ca,
+        en-gb,
+        en-nz,
+        en-pt,
+        en-ud,
+        en-us,
+        enp,
+        enws,
+        eo-uy,
+        es-ar,
+        es-cl,
+        es-ec,
+        es-es,
+        es-mx,
+        es-uy,
+        es-ve,
+        esan,
+        et-ee,
+        eu-es,
+        fa-ir,
+        fi-fi,
+        fil-ph,
+        fo-fo,
+        fr-ca,
+        fr-fr,
+        fra-de,
+        fur-it,
+        fy-nl,
+        ga-ie,
+        gd-gb,
+        gl-es,
+        haw-us,
+        he-il,
+        hi-in,
+        hr-hr,
+        hu-hu,
+        hy-am,
+        id-id,
+        ig-ng,
+        io-en,
+        is-is,
+        isv,
+        it-it,
+        ja-jp,
+        jbo-en,
+        ka-ge,
+        kk-kz,
+        kn-in,
+        ko-kr,
+        ksh,
+        kw-gb,
+        la-la,
+        lb-lu,
+        li-li,
+        lmo,
+        lo-la,
+        lol-us,
+        lt-lt,
+        lv-lv,
+        lzh,
+        mk-mk,
+        mn-mn,
+        ms-my,
+        mt-mt,
+        nah,
+        nds-de,
+        nl-be,
+        nl-nl,
+        nn-no,
+        no-no,
+        oc-fr,
+        ovd,
+        pl-pl,
+        pt-br,
+        pt-pt,
+        qya-aa,
+        ro-ro,
+        rpr,
+        ru-ru,
+        ry-ua,
+        sah-sah,
+        se-no,
+        sk-sk,
+        sl-si,
+        so-so,
+        sq-al,
+        sr-cs,
+        sr-sp,
+        sv-se,
+        sxu,
+        szl,
+        ta-in,
+        th-th,
+        tl-ph,
+        tlh-aa,
+        tok,
+        tr-tr,
+        tt-ru,
+        uk-ua,
+        val-es,
+        vec-it,
+        vi-vn,
+        yi-de,
+        yo-ng,
+        zh-cn,
+        zh-hk,
+        zh-tw,
+        zlm-arab,
+    }
+}