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

pumpkin_api/wit/wit_world/imports/player.py

@@ -0,0 +1,350 @@
+# This file is automatically generated by componentize-py
+# It is not intended for manual editing.
+"""
+Represents a player connected to the Minecraft server.
+"""
+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 common
+from ..imports import permission
+from ..imports import text
+from ..imports import gui
+from ..imports import world
+
+@dataclass
+class PlayerAbilities:
+    """
+    Various abilities a player can have.
+    """
+    invulnerable: bool
+    flying: bool
+    allow_flying: bool
+    creative: bool
+    allow_modify_world: bool
+    fly_speed: float
+    walk_speed: float
+
+class Player:
+    """
+    A handle to a player on the server.
+    """
+    
+    def get_id(self) -> str:
+        """
+        Returns the player's unique UUID as a string.
+        """
+        raise NotImplementedError
+    def get_name(self) -> str:
+        """
+        Returns the player's username.
+        """
+        raise NotImplementedError
+    def get_position(self) -> Tuple[float, float, float]:
+        """
+        Basic state
+        Returns the player's current position in the world.
+        """
+        raise NotImplementedError
+    def get_yaw(self) -> float:
+        """
+        Returns the player's current yaw (horizontal rotation).
+        """
+        raise NotImplementedError
+    def get_pitch(self) -> float:
+        """
+        Returns the player's current pitch (vertical rotation).
+        """
+        raise NotImplementedError
+    def get_world(self) -> world.World:
+        """
+        Returns the world the player is currently in.
+        """
+        raise NotImplementedError
+    def get_gamemode(self) -> common.GameMode:
+        """
+        Returns the player's current game mode.
+        """
+        raise NotImplementedError
+    def set_gamemode(self, mode: common.GameMode) -> bool:
+        """
+        Changes the player's game mode. Returns true if successful.
+        """
+        raise NotImplementedError
+    def get_locale(self) -> str:
+        """
+        Returns the player's locale (e.g., "en_us").
+        """
+        raise NotImplementedError
+    def get_ping(self) -> int:
+        """
+        Returns the player's current ping in milliseconds.
+        """
+        raise NotImplementedError
+    def get_permission_level(self) -> permission.PermissionLevel:
+        """
+        Permissions & metadata
+        Returns the player's permission level (0-4).
+        """
+        raise NotImplementedError
+    def set_permission_level(self, level: permission.PermissionLevel) -> None:
+        """
+        Sets the player's permission level.
+        """
+        raise NotImplementedError
+    def has_permission(self, node: str) -> bool:
+        """
+        Checks if the player has a specific permission node.
+        """
+        raise NotImplementedError
+    def get_display_name(self) -> text.TextComponent:
+        """
+        Returns the player's display name, which may include formatting.
+        """
+        raise NotImplementedError
+    def send_system_message(self, text: text.TextComponent, overlay: bool) -> None:
+        """
+        Messaging & titles
+        Sends a system message to the player's chat.
+        """
+        raise NotImplementedError
+    def show_title(self, text: text.TextComponent) -> None:
+        """
+        Shows a large title on the player's screen.
+        """
+        raise NotImplementedError
+    def show_subtitle(self, text: text.TextComponent) -> None:
+        """
+        Shows a smaller subtitle on the player's screen.
+        """
+        raise NotImplementedError
+    def show_actionbar(self, text: text.TextComponent) -> None:
+        """
+        Shows a message in the action bar area.
+        """
+        raise NotImplementedError
+    def send_title_animation(self, fade_in: int, stay: int, fade_out: int) -> None:
+        """
+        Sets the fade-in, stay, and fade-out times for titles.
+        """
+        raise NotImplementedError
+    def teleport(self, position: Tuple[float, float, float], yaw: Optional[float], pitch: Optional[float], world: world.World) -> None:
+        """
+        Teleport & kick
+        Teleports the player to a position in a world.
+        """
+        raise NotImplementedError
+    def teleport_world(self, world_ref: world.World, position: Tuple[float, float, float], yaw: Optional[float], pitch: Optional[float]) -> None:
+        """
+        Teleports the player to another world at a specific position.
+        """
+        raise NotImplementedError
+    def kick(self, message: text.TextComponent) -> None:
+        """
+        Kicks the player from the server with the specified reason.
+        """
+        raise NotImplementedError
+    def respawn(self) -> None:
+        """
+        Forces the player to respawn.
+        """
+        raise NotImplementedError
+    def open_gui(self, gui_ref: gui.Gui) -> None:
+        """
+        Opens a GUI for the player.
+        """
+        raise NotImplementedError
+    def ban(self, reason: Optional[text.TextComponent]) -> None:
+        """
+        Bans the player with an optional reason.
+        """
+        raise NotImplementedError
+    def ban_ip(self, reason: Optional[text.TextComponent]) -> None:
+        """
+        Bans the player's IP address with an optional reason.
+        """
+        raise NotImplementedError
+    def get_selected_slot(self) -> int:
+        """
+        Inventory
+        Returns the index of the currently selected hotbar slot (0-8).
+        """
+        raise NotImplementedError
+    def get_item_in_hand(self, hand: common.Hand) -> Optional[common.ItemStack]:
+        """
+        Returns the item currently in the specified hand.
+        """
+        raise NotImplementedError
+    def get_inventory_item(self, slot: int) -> Optional[common.ItemStack]:
+        """
+        Returns the item in the specified inventory slot.
+        """
+        raise NotImplementedError
+    def get_health(self) -> float:
+        """
+        Status
+        Returns the player's current health.
+        """
+        raise NotImplementedError
+    def set_health(self, health: float) -> None:
+        """
+        Sets the player's current health.
+        """
+        raise NotImplementedError
+    def get_max_health(self) -> float:
+        """
+        Returns the player's maximum health.
+        """
+        raise NotImplementedError
+    def set_max_health(self, max_health: float) -> None:
+        """
+        Sets the player's maximum health.
+        """
+        raise NotImplementedError
+    def get_food_level(self) -> int:
+        """
+        Returns the player's food level (0-20).
+        """
+        raise NotImplementedError
+    def set_food_level(self, food_level: int) -> None:
+        """
+        Sets the player's food level.
+        """
+        raise NotImplementedError
+    def get_saturation(self) -> float:
+        """
+        Returns the player's food saturation level.
+        """
+        raise NotImplementedError
+    def set_saturation(self, saturation: float) -> None:
+        """
+        Sets the player's food saturation level.
+        """
+        raise NotImplementedError
+    def get_exhaustion(self) -> float:
+        """
+        Returns the player's food exhaustion level.
+        """
+        raise NotImplementedError
+    def set_exhaustion(self, exhaustion: float) -> None:
+        """
+        Sets the player's food exhaustion level.
+        """
+        raise NotImplementedError
+    def get_absorption(self) -> float:
+        """
+        Returns the player's current absorption amount.
+        """
+        raise NotImplementedError
+    def set_absorption(self, absorption: float) -> None:
+        """
+        Sets the player's current absorption amount.
+        """
+        raise NotImplementedError
+    def get_experience_level(self) -> int:
+        """
+        Returns the player's total experience level.
+        """
+        raise NotImplementedError
+    def get_experience_progress(self) -> float:
+        """
+        Returns the player's progress toward the next level (0.0 to 1.0).
+        """
+        raise NotImplementedError
+    def get_experience_points(self) -> int:
+        """
+        Returns the total experience points the player has.
+        """
+        raise NotImplementedError
+    def set_experience_level(self, level: int) -> None:
+        """
+        Sets the player's total experience level.
+        """
+        raise NotImplementedError
+    def set_experience_progress(self, progress: float) -> None:
+        """
+        Sets the player's progress toward the next level.
+        """
+        raise NotImplementedError
+    def set_experience_points(self, points: int) -> None:
+        """
+        Sets the player's total experience points.
+        """
+        raise NotImplementedError
+    def add_experience_levels(self, levels: int) -> None:
+        """
+        Adds experience levels to the player.
+        """
+        raise NotImplementedError
+    def add_experience_points(self, points: int) -> None:
+        """
+        Adds experience points to the player.
+        """
+        raise NotImplementedError
+    def is_sneaking(self) -> bool:
+        """
+        Returns whether the player is currently sneaking.
+        """
+        raise NotImplementedError
+    def set_sneaking(self, sneaking: bool) -> None:
+        """
+        Sets whether the player is currently sneaking.
+        """
+        raise NotImplementedError
+    def is_sprinting(self) -> bool:
+        """
+        Returns whether the player is currently sprinting.
+        """
+        raise NotImplementedError
+    def set_sprinting(self, sprinting: bool) -> None:
+        """
+        Sets whether the player is currently sprinting.
+        """
+        raise NotImplementedError
+    def is_on_ground(self) -> bool:
+        """
+        Returns whether the player is currently on the ground.
+        """
+        raise NotImplementedError
+    def is_flying(self) -> bool:
+        """
+        Returns whether the player is currently flying.
+        """
+        raise NotImplementedError
+    def set_flying(self, flying: bool) -> None:
+        """
+        Sets whether the player should be flying.
+        """
+        raise NotImplementedError
+    def get_abilities(self) -> PlayerAbilities:
+        """
+        Returns the player's current abilities.
+        """
+        raise NotImplementedError
+    def set_abilities(self, abilities: PlayerAbilities) -> None:
+        """
+        Updates the player's abilities.
+        """
+        raise NotImplementedError
+    def get_ip(self) -> str:
+        """
+        Returns the player's IP address.
+        """
+        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/wit_world/imports/scheduler.py

@@ -0,0 +1,44 @@
+# This file is automatically generated by componentize-py
+# It is not intended for manual editing.
+"""
+Provides functionality to schedule tasks to be executed later on the server.
+"""
+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
+
+
+
+def schedule_delayed_task(handler_id: int, delay_ticks: int) -> int:
+    """
+    Schedules a task to be executed once after the specified number of ticks.
+    
+    * `handler-id`: The unique ID of the handler to call when the task executes.
+    * `delay-ticks`: The number of game ticks to wait before execution (20 ticks = 1 second).
+    
+    Returns a unique task ID that can be used to cancel the task.
+    """
+    raise NotImplementedError
+def schedule_repeating_task(handler_id: int, delay_ticks: int, period_ticks: int) -> int:
+    """
+    Schedules a task to be executed repeatedly.
+    
+    * `handler-id`: The unique ID of the handler to call when the task executes.
+    * `delay-ticks`: The number of game ticks to wait before the first execution.
+    * `period-ticks`: The number of game ticks between subsequent executions.
+    
+    Returns a unique task ID that can be used to cancel the task.
+    """
+    raise NotImplementedError
+def cancel_task(task_id: int) -> None:
+    """
+    Cancels a scheduled task if it hasn't finished yet.
+    
+    * `task-id`: The ID of the task to cancel.
+    """
+    raise NotImplementedError

pumpkin_api/wit/wit_world/imports/scoreboard.py

@@ -0,0 +1,95 @@
+# 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 common
+from ..imports import text
+
+class RenderType(Enum):
+    INTEGER = 0
+    HEARTS = 1
+
+class DisplaySlot(Enum):
+    PLAYER_LIST = 0
+    SIDEBAR = 1
+    BELOW_NAME = 2
+    SIDEBAR_TEAM_BLACK = 3
+    SIDEBAR_TEAM_DARK_BLUE = 4
+    SIDEBAR_TEAM_DARK_GREEN = 5
+    SIDEBAR_TEAM_DARK_AQUA = 6
+    SIDEBAR_TEAM_DARK_RED = 7
+    SIDEBAR_TEAM_DARK_PURPLE = 8
+    SIDEBAR_TEAM_GOLD = 9
+    SIDEBAR_TEAM_GRAY = 10
+    SIDEBAR_TEAM_DARK_GRAY = 11
+    SIDEBAR_TEAM_BLUE = 12
+    SIDEBAR_TEAM_GREEN = 13
+    SIDEBAR_TEAM_AQUA = 14
+    SIDEBAR_TEAM_RED = 15
+    SIDEBAR_TEAM_LIGHT_PURPLE = 16
+    SIDEBAR_TEAM_YELLOW = 17
+    SIDEBAR_TEAM_WHITE = 18
+
+class NametagVisibility(Enum):
+    ALWAYS = 0
+    NEVER = 1
+    HIDE_FOR_OTHER_TEAMS = 2
+    HIDE_FOR_OWN_TEAM = 3
+
+class CollisionRule(Enum):
+    ALWAYS = 0
+    NEVER = 1
+    PUSH_OTHER_TEAMS = 2
+    PUSH_OWN_TEAM = 3
+
+@dataclass
+class TeamSettings:
+    display_name: text.TextComponent
+    friendly_fire: bool
+    see_friendly_invisibles: bool
+    nametag_visibility: NametagVisibility
+    collision_rule: CollisionRule
+    color: common.NamedColor
+    prefix: text.TextComponent
+    suffix: text.TextComponent
+
+class Scoreboard:
+    
+    def add_objective(self, name: str, display_name: text.TextComponent, render_type: RenderType) -> None:
+        raise NotImplementedError
+    def remove_objective(self, name: str) -> None:
+        raise NotImplementedError
+    def set_display_slot(self, slot: DisplaySlot, objective_name: str) -> None:
+        raise NotImplementedError
+    def update_score(self, entity_name: str, objective_name: str, value: int) -> None:
+        raise NotImplementedError
+    def remove_score(self, entity_name: str, objective_name: str) -> None:
+        raise NotImplementedError
+    def create_team(self, name: str, settings: TeamSettings) -> None:
+        raise NotImplementedError
+    def remove_team(self, name: str) -> None:
+        raise NotImplementedError
+    def update_team(self, name: str, settings: TeamSettings) -> None:
+        raise NotImplementedError
+    def add_player_to_team(self, team_name: str, player_name: str) -> None:
+        raise NotImplementedError
+    def remove_player_from_team(self, team_name: str, player_name: str) -> None:
+        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/wit_world/imports/server.py

@@ -0,0 +1,75 @@
+# 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 player
+
+class Difficulty(Enum):
+    """
+    Represents the difficulty setting of a Minecraft server.
+    """
+    PEACEFUL = 0
+    EASY = 1
+    NORMAL = 2
+    HARD = 3
+
+class Server:
+    """
+    Represents the global server instance.
+    """
+    
+    def get_difficulty(self) -> Difficulty:
+        """
+        Returns the current difficulty level of the server.
+        """
+        raise NotImplementedError
+    def get_player_count(self) -> int:
+        """
+        Returns the total number of players currently connected to the server.
+        """
+        raise NotImplementedError
+    def get_mspt(self) -> float:
+        """
+        Returns the rolling average Milliseconds Per Tick (MSPT).
+        A value below 50.0 is required for a stable 20 TPS.
+        """
+        raise NotImplementedError
+    def get_tps(self) -> float:
+        """
+        Returns the effective Ticks Per Second (TPS).
+        Ideal value is 20.0.
+        """
+        raise NotImplementedError
+    def get_all_players(self) -> List[player.Player]:
+        """
+        Returns a list of all online players across all worlds.
+        """
+        raise NotImplementedError
+    def get_player_by_name(self, name: str) -> Optional[player.Player]:
+        """
+        Searches for a player by their exact name.
+        """
+        raise NotImplementedError
+    def get_player_by_uuid(self, id: str) -> Optional[player.Player]:
+        """
+        Searches for a player by their UUID string.
+        """
+        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/wit_world/imports/text.py

@@ -0,0 +1,89 @@
+# 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 common
+
+class TextComponent:
+    
+    @classmethod
+    def text(cls, plain: str) -> Self:
+        raise NotImplementedError
+    @classmethod
+    def translate(cls, key: str, with_: List[Self]) -> Self:
+        raise NotImplementedError
+    def add_child(self, child: Self) -> None:
+        raise NotImplementedError
+    def add_text(self, text: str) -> None:
+        raise NotImplementedError
+    def get_text(self) -> str:
+        raise NotImplementedError
+    def encode(self) -> bytes:
+        raise NotImplementedError
+    def color_named(self, color: common.NamedColor) -> None:
+        """
+        Style
+        """
+        raise NotImplementedError
+    def color_rgb(self, color: common.RgbColor) -> None:
+        raise NotImplementedError
+    def bold(self, value: bool) -> None:
+        raise NotImplementedError
+    def italic(self, value: bool) -> None:
+        raise NotImplementedError
+    def underlined(self, value: bool) -> None:
+        raise NotImplementedError
+    def strikethrough(self, value: bool) -> None:
+        raise NotImplementedError
+    def obfuscated(self, value: bool) -> None:
+        raise NotImplementedError
+    def insertion(self, text: str) -> None:
+        """
+        Text inserted into chat when shift-clicked
+        """
+        raise NotImplementedError
+    def font(self, font: str) -> None:
+        raise NotImplementedError
+    def shadow_color(self, color: common.ArgbColor) -> None:
+        raise NotImplementedError
+    def click_open_url(self, url: str) -> None:
+        """
+        Click events
+        """
+        raise NotImplementedError
+    def click_run_command(self, command: str) -> None:
+        raise NotImplementedError
+    def click_suggest_command(self, command: str) -> None:
+        raise NotImplementedError
+    def click_copy_to_clipboard(self, text: str) -> None:
+        raise NotImplementedError
+    def hover_show_text(self, text: Self) -> None:
+        """
+        Hover events
+        """
+        raise NotImplementedError
+    def hover_show_item(self, item: str) -> None:
+        """
+        Item data as SNBT string
+        """
+        raise NotImplementedError
+    def hover_show_entity(self, entity_type: str, id: str, name: Optional[Self]) -> None:
+        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
+
+
+