SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias BotLiveState

    BotLiveState: Message<"soulfire.v1.BotLiveState"> & {
        dimension: string;
        experienceLevel: number;
        experienceProgress: number;
        foodLevel: number;
        gameMode: GameMode;
        health: number;
        inventory: InventorySlot[];
        maxHealth: number;
        saturationLevel: number;
        selectedHotbarSlot: number;
        skinTextureHash?: string;
        x: number;
        xRot: number;
        y: number;
        yRot: number;
        z: number;
    }

    Real-time state of a connected bot. Contains position, health, inventory, and other live game data.

    Type Declaration

    • dimension: string

      The dimension the player is currently in. Format: namespaced identifier (e.g., "minecraft:overworld", "minecraft:the_nether", "minecraft:the_end"). Custom dimensions will use their server-defined namespace.

      from field: string dimension = 12;

    • experienceLevel: number

      Player's current experience level (the number shown on the XP bar). Range: 0 to theoretically unlimited (typically 0-30+ for enchanting).

      from field: int32 experience_level = 13;

    • experienceProgress: number

      Progress towards the next experience level. Range: 0.0 (just reached current level) to 1.0 (about to level up).

      from field: float experience_progress = 14;

    • foodLevel: number

      Current hunger/food level. Range: 0 (starving) to 20 (full). 1 point = half a drumstick in the UI. Below 6, the player cannot sprint. At 0, health starts draining.

      from field: int32 food_level = 8;

    • gameMode: GameMode

      Current game mode of the player. Determines available actions (breaking blocks, flying, taking damage, etc.).

      from field: soulfire.v1.GameMode game_mode = 16;

    • health: number

      Current health points. Range: 0 (dead) to max_health. 1 point = half a heart in the UI.

      from field: float health = 6;

    • inventory: InventorySlot[]

      Inventory slots containing items (only non-empty slots are included). For list views (GetBotList), this will be empty for performance. For detail views (GetBotInfo), contains all non-empty slots from the player inventory.

      from field: repeated soulfire.v1.InventorySlot inventory = 10;

    • maxHealth: number

      Maximum health points the player can have. Default is 20 (10 hearts). Can be modified by effects or attributes.

      from field: float max_health = 7;

    • saturationLevel: number

      Current saturation level. Range: 0 to food_level. Acts as a buffer before hunger depletes. When saturation is above 0, hunger bar doesn't decrease while performing actions.

      from field: float saturation_level = 9;

    • selectedHotbarSlot: number

      Currently selected hotbar slot index. Range: 0 to 8, corresponding to hotbar slots 1-9 in the UI.

      from field: int32 selected_hotbar_slot = 11;

    • OptionalskinTextureHash?: string

      Skin texture hash for avatar rendering. This is the hash extracted from the texture URL in the player's game profile. Can be used with services like mc-heads.net: https://mc-heads.net/body/ Will be absent if the player has no custom skin or skin data is unavailable.

      from field: optional string skin_texture_hash = 15;

    • x: number

      X coordinate in the Minecraft world (east/west axis). East is positive, West is negative.

      from field: double x = 1;

    • xRot: number

      Vertical rotation (pitch) in degrees. Range: -90 (looking straight up) to 90 (looking straight down). 0 is looking at the horizon.

      from field: float xRot = 4;

    • y: number

      Y coordinate in the Minecraft world (vertical axis). Increases upward. Sea level is typically around 63.

      from field: double y = 2;

    • yRot: number

      Horizontal rotation (yaw) in degrees. Range: -180 to 180. 0 = South, 90 = West, -90 = East, +/-180 = North.

      from field: float yRot = 5;

    • z: number

      Z coordinate in the Minecraft world (north/south axis). South is positive, North is negative.

      from field: double z = 3;

    from message soulfire.v1.BotLiveState