CrafterInventory

Struct CrafterInventory 

Source
pub struct CrafterInventory<'mc>(/* private fields */);

Implementations§

Source§

impl<'mc> CrafterInventory<'mc>

Source

pub fn size(&self) -> Result<i32, Box<dyn Error>>

Returns the size of the inventory

Source

pub fn max_stack_size(&self) -> Result<i32, Box<dyn Error>>

Returns the maximum stack size for an ItemStack in this inventory.

Source

pub fn set_max_stack_size(&self, size: i32) -> Result<(), Box<dyn Error>>

This method allows you to change the maximum stack size for an inventory.

Caveats:

  • Not all inventories respect this value.
  • Stacks larger than 127 may be clipped when the world is saved.
  • This value is not guaranteed to be preserved; be sure to set it before every time you want to set a slot over the max stack size.
  • Stacks larger than the default max size for this type of inventory may not display correctly in the client.
Source

pub fn get_item( &self, index: i32, ) -> Result<Option<ItemStack<'mc>>, Box<dyn Error>>

Returns the ItemStack found in the slot at the given index

Source

pub fn set_item( &self, index: i32, item: Option<impl Into<ItemStack<'mc>>>, ) -> Result<(), Box<dyn Error>>

Stores the ItemStack at the given index of the inventory.

Source

pub fn add_item( &self, items: impl Into<ItemStack<'mc>>, ) -> Result<JavaHashMap<'mc>, Box<dyn Error>>

Stores the given ItemStacks in the inventory. This will try to fill existing stacks and empty slots as well as it can.

The returned HashMap contains what it couldn’t store, where the key is the index of the parameter, and the value is the ItemStack at that index of the varargs parameter. If all items are stored, it will return an empty HashMap.

If you pass in ItemStacks which exceed the maximum stack size for the Material, first they will be added to partial stacks where Material.getMaxStackSize() is not exceeded, up to Material.getMaxStackSize(). When there are no partial stacks left stacks will be split on Inventory.getMaxStackSize() allowing you to exceed the maximum stack size for that material.

It is known that in some implementations this method will also set the inputted argument amount to the number of that item not placed in slots.

Source

pub fn remove_item( &self, items: impl Into<ItemStack<'mc>>, ) -> Result<JavaHashMap<'mc>, Box<dyn Error>>

Removes the given ItemStacks from the inventory.

It will try to remove ‘as much as possible’ from the types and amounts you give as arguments.

The returned HashMap contains what it couldn’t remove, where the key is the index of the parameter, and the value is the ItemStack at that index of the varargs parameter. If all the given ItemStacks are removed, it will return an empty HashMap.

It is known that in some implementations this method will also set the inputted argument amount to the number of that item not removed from slots.

Source

pub fn contents(&self) -> Result<ItemStack<'mc>, Box<dyn Error>>

Returns all ItemStacks from the inventory

Source

pub fn set_contents( &self, items: impl Into<ItemStack<'mc>>, ) -> Result<(), Box<dyn Error>>

Completely replaces the inventory’s contents. Removes all existing contents and replaces it with the ItemStacks given in the array.

Source

pub fn storage_contents(&self) -> Result<ItemStack<'mc>, Box<dyn Error>>

Return the contents from the section of the inventory where items can reasonably be expected to be stored. In most cases this will represent the entire inventory, but in some cases it may exclude armor or result slots.

It is these contents which will be used for add / contains / remove methods which look for a specific stack.

Source

pub fn set_storage_contents( &self, items: impl Into<ItemStack<'mc>>, ) -> Result<(), Box<dyn Error>>

Put the given ItemStacks into the storage slots

Source

pub fn contains( &self, material: impl Into<Material<'mc>>, amount: Option<i32>, ) -> Result<bool, Box<dyn Error>>

Checks if the inventory contains any ItemStacks with the given material, adding to at least the minimum amount specified.

Source

pub fn contains_at_least( &self, item: impl Into<ItemStack<'mc>>, amount: i32, ) -> Result<bool, Box<dyn Error>>

Checks if the inventory contains ItemStacks matching the given ItemStack whose amounts sum to at least the minimum amount specified.

Source

pub fn all( &self, item: impl Into<ItemStack<'mc>>, ) -> Result<JavaHashMap<'mc>, Box<dyn Error>>

Finds all slots in the inventory containing any ItemStacks with the given ItemStack. This will only match slots if both the type and the amount of the stack match

The HashMap contains entries where, the key is the slot index, and the value is the ItemStack in that slot. If no matching ItemStack with the given Material is found, an empty map is returned.

Source

pub fn first( &self, item: impl Into<ItemStack<'mc>>, ) -> Result<i32, Box<dyn Error>>

Returns the first slot in the inventory containing an ItemStack with the given stack. This will only match a slot if both the type and the amount of the stack match

Source

pub fn first_empty(&self) -> Result<i32, Box<dyn Error>>

Returns the first empty Slot.

Source

pub fn is_empty(&self) -> Result<bool, Box<dyn Error>>

Check whether or not this inventory is empty. An inventory is considered to be empty if there are no ItemStacks in any slot of this inventory.

Source

pub fn remove( &self, item: impl Into<ItemStack<'mc>>, ) -> Result<(), Box<dyn Error>>

Removes all stacks in the inventory matching the given stack.

This will only match a slot if both the type and the amount of the stack match

Source

pub fn clear(&self, index: Option<i32>) -> Result<(), Box<dyn Error>>

Clears out a particular slot in the index.

Source

pub fn viewers(&self) -> Result<Vec<HumanEntity<'mc>>, Box<dyn Error>>

Gets a list of players viewing the inventory. Note that a player is considered to be viewing their own inventory and internal crafting screen even when said inventory is not open. They will normally be considered to be viewing their inventory even when they have a different inventory screen open, but it’s possible for customized inventory screens to exclude the viewer’s inventory, so this should never be assumed to be non-empty.

Source

pub fn get_type(&self) -> Result<InventoryType<'mc>, Box<dyn Error>>

Returns what type of inventory this is.

Source

pub fn holder(&self) -> Result<Option<InventoryHolder<'mc>>, Box<dyn Error>>

Gets the block or entity belonging to the open inventory

Source

pub fn iterator(&self) -> Result<JavaListIterator<'mc>, Box<dyn Error>>

Source

pub fn location(&self) -> Result<Option<Location<'mc>>, Box<dyn Error>>

Get the location of the block or entity which corresponds to this inventory. May return null if this container was custom created or is a virtual / subcontainer.

Source

pub fn instance_of(&self, other: impl Into<String>) -> Result<bool, Error>

Trait Implementations§

Source§

impl<'mc> Into<Inventory<'mc>> for CrafterInventory<'mc>

Source§

fn into(self) -> Inventory<'mc>

Converts this type into the (usually inferred) input type.
Source§

impl<'mc> JNIInstantiatable<'mc> for CrafterInventory<'mc>

Source§

fn from_raw( env: &SharedJNIEnv<'mc>, obj: JObject<'mc>, ) -> Result<Self, Box<dyn Error>>

Source§

impl<'mc> JNIRaw<'mc> for CrafterInventory<'mc>

Source§

fn jni_ref(&self) -> SharedJNIEnv<'mc>

Source§

fn jni_object(&self) -> JObject<'mc>

Auto Trait Implementations§

§

impl<'mc> !Freeze for CrafterInventory<'mc>

§

impl<'mc> !RefUnwindSafe for CrafterInventory<'mc>

§

impl<'mc> !Send for CrafterInventory<'mc>

§

impl<'mc> !Sync for CrafterInventory<'mc>

§

impl<'mc> Unpin for CrafterInventory<'mc>

§

impl<'mc> UnwindSafe for CrafterInventory<'mc>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more