Struct ContainerHandleRef 

pub struct ContainerHandleRef { /* private fields */ }

A handle to a container that may be open.

This does not close the container when it’s dropped. See ContainerHandle if that behavior is desired.

Implementations

impl ContainerHandleRef

pub fn new(id: i32, client: Client) -> Self

pub fn close(&self)

pub fn id(&self) -> i32

Get the ID of the container.

If this is 0, that means it’s the player’s inventory. Otherwise, the number isn’t really meaningful since only one container can be open at a time.

pub fn menu(&self) -> Option<Menu>

Returns the menu of the container.

If the container is closed, this will return None.

Note that any modifications you make to the Menu you’re given will not actually cause any packets to be sent. If you’re trying to modify your inventory, use Self::click instead

pub fn contents(&self) -> Option<Vec<ItemStack>>

Returns the item slots in the container, not including the player’s inventory.

If the container is closed, this will return None.

Examples found in repository

azalea/examples/steal.rs (line 77)

async fn steal(bot: Client, state: State) -> anyhow::Result<()> {
    {
        let mut is_stealing = state.is_stealing.lock();
        if *is_stealing {
            bot.chat("Already stealing");
            return Ok(());
        }
        *is_stealing = true;
    }

    state.checked_chests.lock().clear();

    loop {
        let chest_block = bot
            .world()
            .read()
            .find_blocks(bot.position(), &BlockKind::Chest.into())
            .find(
                // find the closest chest that hasn't been checked
                |block_pos| !state.checked_chests.lock().contains(block_pos),
            );
        let Some(chest_block) = chest_block else {
            break;
        };

        state.checked_chests.lock().push(chest_block);

        bot.goto(RadiusGoal::new(chest_block.center(), 3.)).await;

        let Some(chest) = bot.open_container_at(chest_block).await else {
            println!("Couldn't open chest at {chest_block:?}");
            continue;
        };

        println!("Getting contents of chest at {chest_block:?}");
        for (index, slot) in chest.contents().unwrap_or_default().iter().enumerate() {
            println!("Checking slot {index}: {slot:?}");
            let ItemStack::Present(item) = slot else {
                continue;
            };
            if item.kind == ItemKind::Diamond {
                println!("clicking slot ^");
                chest.click(QuickMoveClick::Left { slot: index as u16 });
            }
        }
    }

    bot.chat("Done");

    *state.is_stealing.lock() = false;

    Ok(())
}

pub fn slots(&self) -> Option<Vec<ItemStack>>

Return the contents of the menu, including the player’s inventory.

If the container is closed, this will return None.

pub fn title(&self) -> Option<FormattedText>

Returns the title of the container, or None if no container is open.

let inventory = bot.get_inventory();
let inventory_title = inventory.title().unwrap_or_default().to_string();
// would be true if an unnamed chest is open
assert_eq!(inventory_title, "Chest");

pub fn left_click(&self, slot: impl Into<usize>)

A shortcut for Self::click with PickupClick::Left.

pub fn shift_click(&self, slot: impl Into<usize>)

A shortcut for Self::click with QuickMoveClick::Left.

pub fn right_click(&self, slot: impl Into<usize>)

A shortcut for Self::click with PickupClick::Right.

pub fn click(&self, operation: impl Into<ClickOperation>)

Simulate a click in the container and send the packet to perform the action.

Examples found in repository

azalea/examples/steal.rs (line 84)

async fn steal(bot: Client, state: State) -> anyhow::Result<()> {
    {
        let mut is_stealing = state.is_stealing.lock();
        if *is_stealing {
            bot.chat("Already stealing");
            return Ok(());
        }
        *is_stealing = true;
    }

    state.checked_chests.lock().clear();

    loop {
        let chest_block = bot
            .world()
            .read()
            .find_blocks(bot.position(), &BlockKind::Chest.into())
            .find(
                // find the closest chest that hasn't been checked
                |block_pos| !state.checked_chests.lock().contains(block_pos),
            );
        let Some(chest_block) = chest_block else {
            break;
        };

        state.checked_chests.lock().push(chest_block);

        bot.goto(RadiusGoal::new(chest_block.center(), 3.)).await;

        let Some(chest) = bot.open_container_at(chest_block).await else {
            println!("Couldn't open chest at {chest_block:?}");
            continue;
        };

        println!("Getting contents of chest at {chest_block:?}");
        for (index, slot) in chest.contents().unwrap_or_default().iter().enumerate() {
            println!("Checking slot {index}: {slot:?}");
            let ItemStack::Present(item) = slot else {
                continue;
            };
            if item.kind == ItemKind::Diamond {
                println!("clicking slot ^");
                chest.click(QuickMoveClick::Left { slot: index as u16 });
            }
        }
    }

    bot.chat("Done");

    *state.is_stealing.lock() = false;

    Ok(())
}

Trait Implementations

impl Debug for ContainerHandleRef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.