Struct InventoryOperations 

pub struct InventoryOperations { /* private fields */ }

The device for the inventory operations module

OC2 Docs

Implementations

impl InventoryOperations

pub fn drop( &self, count: u32, side: Option<RobotSide>, ) -> Result<u32, HlapiClientError>

Tries to drop the given number of items to the specified side, defaulting to RobotSide::Front. Items are dropped into the world if there is no inventory to that side. Returns the actual number of items dropped.

pub fn drop_into( &self, slot: u32, count: u32, side: Option<RobotSide>, ) -> Result<u32, HlapiClientError>

Tries to drop the given number of items into the given slot of the inventory to the specified side, defaulting to RobotSide::Front. Returns the actual number of items dropped.

pub fn get_item_slot_count( &self, side: Option<RobotSide>, ) -> Result<Option<NonZeroU32>, HlapiClientError>

Gets the number of slots in the inventory to the specified side, defaulting to RobotSide::Front. Returns None if there is no inventory to that side.

pub fn get_item_slot_limit( &self, slot: u32, side: Option<RobotSide>, ) -> Result<u32, HlapiClientError>

Gets the number of items the given slot in the inventory to the specified side, defaulting to RobotSide::Front, can hold.

pub fn get_item_stack_in_slot( &self, slot: u32, side: Option<RobotSide>, ) -> Result<Option<ItemStack>, HlapiClientError>

Gets the contents of the given slot in the inventory to the specified side, defaulting to RobotSide::Front. Returns None if the slot is empty.

pub fn move_internal( &self, from: u32, into: u32, max_count: u32, ) -> Result<u32, HlapiClientError>

Moves up to the given number of items from one internal inventory slot to another, returning the actual count of items moved.

pub fn move_from( &self, into: u32, max_count: u32, ) -> Result<u32, HlapiClientError>

Moves up to the given number of items from the container in the selected slot to the given internal slot, returning the actual count of items moved.

pub fn move_into( &self, from: u32, max_count: u32, ) -> Result<u32, HlapiClientError>

Moves up to the given number of items from the given internal slot to the container in the selected slot, returning the actual count of items moved.

pub fn take( &self, max_count: u32, side: Option<RobotSide>, ) -> Result<u32, HlapiClientError>

Tries to take up to the given number of items from the specified side, defaulting to RobotSide::Front. Items are taken from the world if there is no inventory to that side. Returns the actual count of items taken.

pub fn take_from( &self, slot: u32, max_count: u32, side: Option<RobotSide>, ) -> Result<u32, HlapiClientError>

Tries to take up to the given number of items from the given slot of the inventory to the specified side, defaulting to RobotSide::Front. Returns the actual count of items taken.

Trait Implementations

impl Clone for InventoryOperations

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InventoryOperations

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

Formats the value using the given formatter.

impl DeviceBase for InventoryOperations

const TYPE: &'static str = "inventory_operations"

The device’s type string

type Event = !

The event type for this device’s events. Should be set to Infallible if parse_event is not implemented.

fn new(client: HlapiClient, uuid: Uuid) -> Result<Self, HlapiClientError>

Create a device wrapper

fn uuid_base(&self) -> Uuid

Gets the UUID of this device

fn client(&self) -> &HlapiClient

Gets the client associated with this device

fn call<R: DeserializeOwned>( &self, method: &str, args: &[&dyn ErasedSerialize], blobs: &[&[u8]], ) -> Result<(R, Vec<Vec<u8>>), HlapiClientError>

Call a method on this device

fn parse_event( _typ: &str, _data: &JsonValue, ) -> Result<Self::Event, Box<dyn Error + Send + Sync>>

Parses a device event from a type and a raw JSON value