Interface BotLiveStateOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
BotLiveState, BotLiveState.Builder
@Generated public interface BotLiveStateOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDimension()
    The dimension the player is currently in.
    com.google.protobuf.ByteString
    getDimensionBytes()
    The dimension the player is currently in.
    int
    getExperienceLevel()
    Player's current experience level (the number shown on the XP bar).
    float
    getExperienceProgress()
    Progress towards the next experience level.
    int
    getFoodLevel()
    Current hunger/food level.
    GameMode
    getGameMode()
    Current game mode of the player.
    int
    getGameModeValue()
    Current game mode of the player.
    float
    getHealth()
    Current health points.
    InventorySlot
    getInventory(int index)
    Inventory slots containing items (only non-empty slots are included).
    int
    getInventoryCount()
    Inventory slots containing items (only non-empty slots are included).
    List<InventorySlot>
    getInventoryList()
    Inventory slots containing items (only non-empty slots are included).
    InventorySlotOrBuilder
    getInventoryOrBuilder(int index)
    Inventory slots containing items (only non-empty slots are included).
    List<? extends InventorySlotOrBuilder>
    getInventoryOrBuilderList()
    Inventory slots containing items (only non-empty slots are included).
    float
    getMaxHealth()
    Maximum health points the player can have.
    float
    getSaturationLevel()
    Current saturation level.
    int
    getSelectedHotbarSlot()
    Currently selected hotbar slot index.
    String
    getSkinTextureHash()
    Skin texture hash for avatar rendering.
    com.google.protobuf.ByteString
    getSkinTextureHashBytes()
    Skin texture hash for avatar rendering.
    double
    getX()
    X coordinate in the Minecraft world (east/west axis).
    float
    getXRot()
    Vertical rotation (pitch) in degrees.
    double
    getY()
    Y coordinate in the Minecraft world (vertical axis).
    float
    getYRot()
    Horizontal rotation (yaw) in degrees.
    double
    getZ()
    Z coordinate in the Minecraft world (north/south axis).
    boolean
    hasSkinTextureHash()
    Skin texture hash for avatar rendering.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getX

      double getX()
      X coordinate in the Minecraft world (east/west axis).
East is positive, West is negative.
      double x = 1;
      Returns:
      The x.

    • getY

      double getY()
      Y coordinate in the Minecraft world (vertical axis).
Increases upward. Sea level is typically around 63.
      double y = 2;
      Returns:
      The y.

    • getZ

      double getZ()
      Z coordinate in the Minecraft world (north/south axis).
South is positive, North is negative.
      double z = 3;
      Returns:
      The z.

    • getXRot

      float getXRot()
      Vertical rotation (pitch) in degrees.
Range: -90 (looking straight up) to 90 (looking straight down).
0 is looking at the horizon.
      float xRot = 4;
      Returns:
      The xRot.

    • getYRot

      float getYRot()
      Horizontal rotation (yaw) in degrees.
Range: -180 to 180. 0 = South, 90 = West, -90 = East, +/-180 = North.
      float yRot = 5;
      Returns:
      The yRot.

    • getHealth

      float getHealth()
      Current health points.
Range: 0 (dead) to max_health. 1 point = half a heart in the UI.
      float health = 6;
      Returns:
      The health.

    • getMaxHealth

      float getMaxHealth()
      Maximum health points the player can have.
Default is 20 (10 hearts). Can be modified by effects or attributes.
      float max_health = 7;
      Returns:
      The maxHealth.

    • getFoodLevel

      int getFoodLevel()
      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.
      int32 food_level = 8;
      Returns:
      The foodLevel.

    • getSaturationLevel

      float getSaturationLevel()
      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.
      float saturation_level = 9;
      Returns:
      The saturationLevel.

    • getInventoryList

      List<InventorySlot> getInventoryList()
      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.
      repeated .soulfire.v1.InventorySlot inventory = 10;

    • getInventory

      InventorySlot getInventory(int index)
      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.
      repeated .soulfire.v1.InventorySlot inventory = 10;

    • getInventoryCount

      int getInventoryCount()
      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.
      repeated .soulfire.v1.InventorySlot inventory = 10;

    • getInventoryOrBuilderList

      List<? extends InventorySlotOrBuilder> getInventoryOrBuilderList()
      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.
      repeated .soulfire.v1.InventorySlot inventory = 10;

    • getInventoryOrBuilder

      InventorySlotOrBuilder getInventoryOrBuilder(int index)
      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.
      repeated .soulfire.v1.InventorySlot inventory = 10;

    • getSelectedHotbarSlot

      int getSelectedHotbarSlot()
      Currently selected hotbar slot index.
Range: 0 to 8, corresponding to hotbar slots 1-9 in the UI.
      int32 selected_hotbar_slot = 11;
      Returns:
      The selectedHotbarSlot.

    • getDimension

      String getDimension()
      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.
      string dimension = 12;
      Returns:
      The dimension.

    • getDimensionBytes

      com.google.protobuf.ByteString getDimensionBytes()
      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.
      string dimension = 12;
      Returns:
      The bytes for dimension.

    • getExperienceLevel

      int getExperienceLevel()
      Player's current experience level (the number shown on the XP bar).
Range: 0 to theoretically unlimited (typically 0-30+ for enchanting).
      int32 experience_level = 13;
      Returns:
      The experienceLevel.

    • getExperienceProgress

      float getExperienceProgress()
      Progress towards the next experience level.
Range: 0.0 (just reached current level) to 1.0 (about to level up).
      float experience_progress = 14;
      Returns:
      The experienceProgress.

    • hasSkinTextureHash

      boolean hasSkinTextureHash()
      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/<hash>
Will be absent if the player has no custom skin or skin data is unavailable.
      optional string skin_texture_hash = 15;
      Returns:
      Whether the skinTextureHash field is set.

    • getSkinTextureHash

      String getSkinTextureHash()
      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/<hash>
Will be absent if the player has no custom skin or skin data is unavailable.
      optional string skin_texture_hash = 15;
      Returns:
      The skinTextureHash.

    • getSkinTextureHashBytes

      com.google.protobuf.ByteString getSkinTextureHashBytes()
      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/<hash>
Will be absent if the player has no custom skin or skin data is unavailable.
      optional string skin_texture_hash = 15;
      Returns:
      The bytes for skinTextureHash.

    • getGameModeValue

      int getGameModeValue()
      Current game mode of the player.
Determines available actions (breaking blocks, flying, taking damage, etc.).
      .soulfire.v1.GameMode game_mode = 16;
      Returns:
      The enum numeric value on the wire for gameMode.

    • getGameMode

      GameMode getGameMode()
      Current game mode of the player.
Determines available actions (breaking blocks, flying, taking damage, etc.).
      .soulfire.v1.GameMode game_mode = 16;
      Returns:
      The gameMode.