All Superinterfaces:: ScriptObject<T>

All Known Subinterfaces:: UserObject<T>

public interface InventoryHolderObject<T>
extends ScriptObject<T>

An object that has a single inventory or a collection of inventories. Typically a user/character.

Method Summary

Modifier and Type	Method	Description
`default boolean`	`addItem(int itemTemplateId)`	Adds a single item into this object's inventory.
`boolean`	`addItem(int itemTemplateId, int count)`	Adds an item into this objects inventory.
`boolean`	`addItemAll(int... itemTemplateId)`	Adds ALL ITEMS in the array.
`boolean`	`addItemAll(Collection<Tuple<Integer,Integer>> itemTemplateIdAndCount)`
`default boolean`	`addItemAll(Tuple<Integer,Integer>... itemTemplateIdAndCount)`	Add ALL ITEMS in the array with their count.
`default boolean`	`exchange(int money, int... itemTemplateIdAndCount)`
`default boolean`	`exchange(int money, int itemId, int itemCount)`	This is an inventory transaction that only applies changes if all actions can be completed.
`default boolean`	`exchange(int money, List<Tuple<Integer,Integer>> itemTemplateIdAndCount)`
`default boolean`	`exchange(int money, Tuple<Integer,Integer>... itemTemplateIdAndCount)`	This is an inventory transaction that only applies changes if all actions can be completed.
`default void`	`exchange(BasicScriptAction onFalse, int money, int... itemIdAndCount)`
`default void`	`exchange(BasicScriptAction onFalse, int money, int itemId, int itemCount)`
`default void`	`exchange(BasicScriptAction onTrue, BasicScriptAction onFalse, int money, int... itemIdAndCount)`
`default void`	`exchange(BasicScriptAction onTrue, BasicScriptAction onFalse, int money, int itemId, int itemCount)`
`default void`	`exchange(BasicScriptAction onTrue, BasicScriptAction onFalse, Exchange exchange)`
`default void`	`exchange(BasicScriptAction onFalse, Exchange exchange)`
`boolean`	`exchange(Exchange exchange)`
`default int`	`getHoldCount(int inventoryType)`	Retrieves the # of non-empty slots in an inventory.
`Optional<InventorySlotObject>`	`getItem(int inventoryType, short slot)`
`default Optional<InventorySlotObject>`	`getItemCash(byte slot)`
`default Optional<InventorySlotObject>`	`getItemConsume(byte slot)`
`int`	`getItemCount(int itemTemplateId)`
`default Optional<InventorySlotObject>`	`getItemEquip(short slot)`
`default Optional<InventorySlotObject>`	`getItemEtc(byte slot)`
`default Optional<InventorySlotObject>`	`getItemInstall(byte slot)`
`default Collection<InventorySlotObject>`	`getItems(int inventoryType)`
`default Collection<InventorySlotObject>`	`getItemsCash()`
`default Map<Short,InventorySlotObject>`	`getItemsCashMap()`
`default Collection<InventorySlotObject>`	`getItemsConsume()`
`default Map<Short,InventorySlotObject>`	`getItemsConsumeMap()`
`default Collection<InventorySlotObject>`	`getItemsEquip()`
`default Map<Short,InventorySlotObject>`	`getItemsEquipMap()`
`default Collection<InventorySlotObject>`	`getItemsEquipped()`
`default Collection<InventorySlotObject>`	`getItemsEtc()`
`default Map<Short,InventorySlotObject>`	`getItemsEtcMap()`
`default Collection<InventorySlotObject>`	`getItemsInstall()`
`default Map<Short,InventorySlotObject>`	`getItemsInstallMap()`
`default Map<Short,InventorySlotObject>`	`getItemsMap(int inventoryType)`
`int`	`getSlotCount(int inventoryType)`	Retrieves the # of accessible slots in an inventory.
`default boolean`	`hasItem(int itemTemplateId)`
`default boolean`	`hasItem(int itemTemplateId, int count)`
`boolean`	`increaseSlotCount(int inventoryType, int howMany)`	Increases the # of usable slots in an inventory tab based on an Inventory Type enumeration.
`default boolean`	`increaseSlotCountForCash(int howMany)`
`default boolean`	`increaseSlotCountForEquip(int howMany)`
`default boolean`	`increaseSlotCountForEtc(int howMany)`
`default boolean`	`increaseSlotCountForSetup(int howMany)`
`default boolean`	`increaseSlotCountForUse(int howMany)`
`boolean`	`removeItem(int itemTemplateId)`	Remove ALL INSTANCES where an item matches the item id.
`boolean`	`removeItem(int itemTemplateId, int count)`	Removes an amount of items where the item matches the item id.
`boolean`	`removeItemAll(int... itemTemplateId)`	Remove ALL INSTANCES where an item matches the item id.
`boolean`	`removeItemAll(Collection<Tuple<Integer,Integer>> itemTemplateIdAndCount)`
`default boolean`	`removeItemAll(Tuple<Integer,Integer>... itemTemplateIdAndCount)`	Removes ALL ITEMS in the array with their count.
`boolean`	`removeSlot(int tab, short position)`	Remove ALL ITEMS at the specified slot position.
`default boolean`	`removeSlotCash(short position)`
`default boolean`	`removeSlotEquip(short position)`
`default boolean`	`removeSlotEtc(short position)`
`default boolean`	`removeSlotSetup(short position)`
`default boolean`	`removeSlotUse(short position)`
`Stream<InventorySlotObject>`	`streamItems(int inventoryType)`
`default Stream<InventorySlotObject>`	`streamItems(int inventoryType, Predicate<InventorySlotObject> filter)`
`default Stream<InventorySlotObject>`	`streamItemsEquipped()`

Methods inherited from interface moe.maple.api.script.model.object.ScriptObject

get

Method Details
- exchange
  
  boolean exchange(Exchange exchange)
- exchange
  
  default boolean exchange(int money, int itemId, int itemCount)
  
  This is an inventory transaction that only applies changes if all actions can be completed.
  
  Parameters:
  
  money - - The +/- meso amount to increase/decrease by
  
  itemId - - The .wz id of the item to add or remove
  
  itemCount - - The +/- amount to increase/decrease by
  
  Returns:
  
  true if all actions were completed
- exchange
  
  default void exchange(BasicScriptAction onTrue, BasicScriptAction onFalse, int money, int itemId, int itemCount)
- exchange
  
  default void exchange(BasicScriptAction onFalse, int money, int itemId, int itemCount)
- exchange
  
  default void exchange(BasicScriptAction onTrue, BasicScriptAction onFalse, Exchange exchange)
- exchange
  
  default void exchange(BasicScriptAction onFalse, Exchange exchange)
- exchange
  
  default boolean exchange(int money, Tuple<Integer,Integer>... itemTemplateIdAndCount)
  
  This is an inventory transaction that only applies changes if all actions can be completed.
  
  Parameters:
  
  money - - The +/- meso amount to increase/decrease by
  
  itemTemplateIdAndCount - - An array of Tuples. Left parameter should be the .wz id of the item. Right parameter should be the amount to add or remove.
  
  Returns:
  
  true if all actions were completed
- exchange
  
  default boolean exchange(int money, List<Tuple<Integer,Integer>> itemTemplateIdAndCount)
- exchange
  
  default boolean exchange(int money, int... itemTemplateIdAndCount)
- exchange
  
  default void exchange(BasicScriptAction onTrue, BasicScriptAction onFalse, int money, int... itemIdAndCount)
- exchange
  
  default void exchange(BasicScriptAction onFalse, int money, int... itemIdAndCount)
- addItem
  
  boolean addItem(int itemTemplateId, int count)
  
  Adds an item into this objects inventory.
  
  Parameters:
  
  itemTemplateId - - The .wz id of the item
  
  count - - The amount to add.
  
  Returns:
  
  true if the item and the correct amount were added.
- addItem
  
  default boolean addItem(int itemTemplateId)
  
  Adds a single item into this object's inventory.
  
  Parameters:
  
  itemTemplateId - - The .wz id of the item
  
  Returns:
  
  true if single item was added
- addItemAll
  
  boolean addItemAll(int... itemTemplateId)
  
  Adds ALL ITEMS in the array. This should ONLY ADD ITEMS IF ALL CAN BE ADDED.
  
  Parameters:
  
  itemTemplateId -
  
  Returns:
  
  true if ALL ITEMS were added
- addItemAll
  
  default boolean addItemAll(Tuple<Integer,Integer>... itemTemplateIdAndCount)
  
  Add ALL ITEMS in the array with their count. This should ONLY ADD ITEMS IF ALL CAN BE ADDED.
  
  Parameters:
  
  itemTemplateIdAndCount - - An array of Tuples. Left parameter should be the .wz id of the item. Right parameter should be the amount to add.
  
  Returns:
  
  true if ALL ITEMS were added
- addItemAll
  
  boolean addItemAll(Collection<Tuple<Integer,Integer>> itemTemplateIdAndCount)
- removeItem
  
  boolean removeItem(int itemTemplateId)
  
  Remove ALL INSTANCES where an item matches the item id.
  
  Parameters:
  
  itemTemplateId - - The .wz id of the item
  
  Returns:
  
  true if at least one was removed
- removeItem
  
  boolean removeItem(int itemTemplateId, int count)
  
  Removes an amount of items where the item matches the item id. This should ONLY REMOVE AN ITEM if you can remove THE CORRECT AMOUNT.
  
  Parameters:
  
  itemTemplateId - - The .wz id of the item
  
  count -
  
  Returns:
  
  true if THE COUNT WAS REMOVED
- removeItemAll
  
  boolean removeItemAll(int... itemTemplateId)
  
  Remove ALL INSTANCES where an item matches the item id. This should ONLY REMOVE AN ITEM IF ALL CAN BE REMOVED.
  
  Parameters:
  
  itemTemplateId - - The .wz id of the item
  
  Returns:
  
  true if ALL ITEMS WERE REMOVED
- removeItemAll
  
  default boolean removeItemAll(Tuple<Integer,Integer>... itemTemplateIdAndCount)
  
  Removes ALL ITEMS in the array with their count. This should ONLY ADD ITEMS IF ALL CAN BE REMOVED.
  
  Parameters:
  
  itemTemplateIdAndCount - - An array of Tuples. Left parameter should be the .wz id of the item. Right parameter should be the amount to add.
  
  Returns:
  
  true if ALL WERE REMOVED
- removeItemAll
  
  boolean removeItemAll(Collection<Tuple<Integer,Integer>> itemTemplateIdAndCount)
- removeSlot
  
  boolean removeSlot(int tab, short position)
  
  Remove ALL ITEMS at the specified slot position.
  
  Parameters:
  
  tab - An Inventory index as an int
  
  position - A Short slot position
  
  Returns:
  
  true if the item was removed successfully.
- removeSlotEquip
  
  default boolean removeSlotEquip(short position)
- removeSlotUse
  
  default boolean removeSlotUse(short position)
- removeSlotSetup
  
  default boolean removeSlotSetup(short position)
- removeSlotEtc
  
  default boolean removeSlotEtc(short position)
- removeSlotCash
  
  default boolean removeSlotCash(short position)
- getItemCount
  
  int getItemCount(int itemTemplateId)
  
  Parameters:
  
  itemTemplateId - - The .wz id of the item
  
  Returns:
  
  the total count of the itemTemplateId
- getHoldCount
  
  default int getHoldCount(int inventoryType)
  
  Retrieves the # of non-empty slots in an inventory.
  
  Parameters:
  
  inventoryType -
  
  Returns:
  
  # of filled slots
- getSlotCount
  
  int getSlotCount(int inventoryType)
  
  Retrieves the # of accessible slots in an inventory. (Default is typically 24)
  
  Parameters:
  
  inventoryType -
  
  Returns:
  
  # of filled slots
- hasItem
  
  default boolean hasItem(int itemTemplateId, int count)
  
  Returns:
  
  true if this object holds the total count
- hasItem
  
  default boolean hasItem(int itemTemplateId)
- increaseSlotCount
  
  boolean increaseSlotCount(int inventoryType, int howMany)
  
  Increases the # of usable slots in an inventory tab based on an Inventory Type enumeration. Valid inventory types for incrementation are 1 through 5 (EQUIP, CONSUME, INSTALL, ETC, CASH respectively).
  
  Parameters:
  
  inventoryType - Inventory Type as an integer.
  
  howMany - How many slots to add.
  
  Returns:
  
  true if the operation was successful.
- increaseSlotCountForEquip
  
  default boolean increaseSlotCountForEquip(int howMany)
- increaseSlotCountForUse
  
  default boolean increaseSlotCountForUse(int howMany)
- increaseSlotCountForSetup
  
  default boolean increaseSlotCountForSetup(int howMany)
- increaseSlotCountForEtc
  
  default boolean increaseSlotCountForEtc(int howMany)
- increaseSlotCountForCash
  
  default boolean increaseSlotCountForCash(int howMany)
- getItems
  
  default Collection<InventorySlotObject> getItems(int inventoryType)
  
  Parameters:
  
  inventoryType - Inventory Type as an integer, increaseSlotCount(int, int)
  
  Returns:
  
  An immutable inventory collection
- getItem
  
  Optional<InventorySlotObject> getItem(int inventoryType, short slot)
  
  Parameters:
  
  inventoryType - Inventory Type as an integer, increaseSlotCount(int, int)
  
  slot - the inventory slot position
  
  Returns:
  
  an item at this slot, if it exists
- getItemEquip
  
  default Optional<InventorySlotObject> getItemEquip(short slot)
- getItemConsume
  
  default Optional<InventorySlotObject> getItemConsume(byte slot)
- getItemInstall
  
  default Optional<InventorySlotObject> getItemInstall(byte slot)
- getItemEtc
  
  default Optional<InventorySlotObject> getItemEtc(byte slot)
- getItemCash
  
  default Optional<InventorySlotObject> getItemCash(byte slot)
- getItemsMap
  
  default Map<Short,InventorySlotObject> getItemsMap(int inventoryType)
  
  Parameters:
  
  inventoryType - Inventory Type as an integer, increaseSlotCount(int, int)
  
  Returns:
  
  an inventory's slot : item map
- getItemsEquipMap
  
  default Map<Short,InventorySlotObject> getItemsEquipMap()
- getItemsConsumeMap
  
  default Map<Short,InventorySlotObject> getItemsConsumeMap()
- getItemsInstallMap
  
  default Map<Short,InventorySlotObject> getItemsInstallMap()
- getItemsEtcMap
  
  default Map<Short,InventorySlotObject> getItemsEtcMap()
- getItemsCashMap
  
  default Map<Short,InventorySlotObject> getItemsCashMap()
- getItemsEquip
  
  default Collection<InventorySlotObject> getItemsEquip()
- getItemsConsume
  
  default Collection<InventorySlotObject> getItemsConsume()
- getItemsInstall
  
  default Collection<InventorySlotObject> getItemsInstall()
- getItemsEtc
  
  default Collection<InventorySlotObject> getItemsEtc()
- getItemsCash
  
  default Collection<InventorySlotObject> getItemsCash()
- streamItems
  
  Stream<InventorySlotObject> streamItems(int inventoryType)
  
  Parameters:
  
  inventoryType - Inventory Type as an integer, increaseSlotCount(int, int)
  
  Returns:
  
  A stream of InventorySlotObject
- streamItems
  
  default Stream<InventorySlotObject> streamItems(int inventoryType, Predicate<InventorySlotObject> filter)
- streamItemsEquipped
  
  default Stream<InventorySlotObject> streamItemsEquipped()
- getItemsEquipped
  
  default Collection<InventorySlotObject> getItemsEquipped()

Interface InventoryHolderObject<T>

Method Summary

Methods inherited from interface moe.maple.api.script.model.object.ScriptObject

Method Details