The following describes the Inventory class and its properties and methods.
Can be set by users.
Controls the strings used in the default interface. The value is an object containing a property for each string.
The object can contain the following properties:
inspect(string) not used in the default interface, since the user clicks on the names of items to see their descriptions, however, a link for inspecting items may be needed in the future or by users. Default:"Inspect"drop(string) appears as link text when users can drop items in the interface. Default:"Drop"take(string) can appear as link text when users can transfer items in the interface. Default:"Take"give(string) can appear as link text when users can transfer items in the interface. Default:"Give"use(string) link text for the action allowing consumables to be used. Default:"Use"stack(string) the text used to refer to an item stack when dropping or transferring whole stacks in the default interface. Default:"stack"stackPre(string) string appears before the item stack counts. Default:" × "(that is, × )stackPost(string) string appears after the item stack counts. Default:" "
Can be set by users.
Controls whether or not to confirm certain inventory actions with the player before proceeding. Only applies to the default user-interfaces. Defaults to false.
"all"(string) set to"all"and only Drop/Give/Take all commands will require confirmation."stack"(string) set to"stack"and both Drop/Give/Take stack and Drop/Give/Take all commands will require confirmation.true(boolean) every drop/give/take action, including the all commands, will require confirmation.false(boolean) never require confirmation.
Can be set by users.
Controls the message displayed by an inventory when it's empty. Only applies to the default user-interfaces.
Can be set to any string value. By default is a horizontal ellipsis (…).
Inventory.create([data] [, tags]);
Creates and returns an inventory instance.
data(object) (optional) a plain object of item/amount pairs to place in the inventorytags(string array) (optional) an array of tags to associate with the inventory. Tags have no meaning to the simple inventory itself and are purely for storing user metadata.
Returns the created inventory instance.
Inventory.is(thing);
Determines whether the passed thing is an inventory instance.
thing(any) anything
Cannot be set by users.
An array of items in the inventory. This array only includes one entry type of item, regardless of quantity.
Cannot be set by users.
An array of items in the inventory. This array includes duplicates, including an additional entry for each item in a stack.
Cannot be set by users.
A generic object made up of item/stack pairs.
Cannot be set by users.
Returns the number of items in the inventory, including all duplicates.
Cannot be set by users.
Returns the number of unique items in the inventory. Each type of item is only counted once, regardless of the quantity.
Cannot be set by users.
Returns the array of tags.
<inventory>.count(item);
Returns the number of the items with the given ID in the inventory.
item(string) an item ID
<inventory>.isEmpty();
Returns whether the inventory is empty (has no items).
<inventory>.has(item [, amount]);
Returns true if the given number of items of with the given ID are in the inventory.
item(string) an item IDamount(number) (optional) the number of items to check for, defaults to1is not specified.
<inventory>.hasAll(item [, item ...]);
Returns true if the inventory contains at least one of all the indicated items.
item(string) a list of item IDs to check for
<inventory>.hasAny(item [, item ...]);
Returns true if the inventory contains at least one of any of the indicated items.
item(string) a list of item IDs to check for
<inventory>.compare(itemset);
Returns whether the inventory contains all of the items in the itemset, in the quantities listed or greater.
itemset(inventory | object) an inventory instance or a generic object containing itemID/amount pairs.
<inventory>.merge(itemset);
Merges the indicated itemset into the inventory, adding all the items in the specified quantities.
itemset(inventory | object) an inventory instance or a generic object containing itemID/amount pairs.
Returns the delta, which in this case is simply the itemset's data.
<inventory>.unmerge(itemset);
Compares the inventory to the given itemset. Any items the two have in common are dropped.
Warning
If you attempt to remove an item or items that aren't present in the inventory, nothing happens and no errors or warnings will be displayed.
itemset(inventory | object) an inventory instance or a generic object containing itemID/amount pairs.
Returns the delta, which is the itemset less any items the inventory instance didn't contain that couldnt be dropped.
<inventory>.pickup(item, amount [, item, amount ...]);
Adds the indicated items, passed as itemID/amount pairs of arguments, to the inventory. All item IDs must be paired with a number.
Warning
Note the change in capitalization (pickup() rather than pickUp()) compared to v2.
item(string) an item IDamount(number) the number of items to add
Can be chained.
<inventory>.drop(item, amount [, item, amount ...]);
Removes the indicated items, passed as itemID/amount pairs of arguments, from the inventory. All item IDs must be paired with a number.
Warning
If you attempt to remove an item or items that aren't present in the inventory, nothing happens and no errors or warnings will be displayed.
item(string) an item IDamount(number) the number of items to add
Can be chained.
<inventory>.empty();
Removes all items from the inventory.
Warning
If you attempt to remove an item or items that aren't present in the inventory, nothing happens and no errors or warnings will be displayed.
Can be chained.
<inventory>.transfer(target, item, amount [, item, amount ...]);
Removes the indicated items, passed as itemID/amount pairs of arguments, from the inventory. All items that are successfully removed are added to the indicated target inventory. Items that could not be removed from the giving inventory, for example, if they don't exist, are not passed to the target inventory.
Warning
If you attempt to remove an item or items that aren't present in the inventory, nothing happens and no errors or warnings will be displayed.
target(inventory) an inventory instance to receive the transferred itemsitem(string) an item IDamount(number) the number of items to add
Can be chained.
<inventory>.iterate( function (item, amount) {
// code
});
Iterates over the inventory's items, calling the provided callback on each. The callback can accept two arguments, the item and the current quantity.
callback(function) a function to run on every iteration
item(string) the current item's IDamount(number) the number of items
Can be chained.
<inventory>.use(item)
"Uses" the given item, if it is a consumable. This calls the handler code associated with the item, removes one of the items from the inventory, and fires the use event.
item(string) an item ID
Can be chained.
<inventory>.hasTag(tag)
tag(string) a tag to check for
Returns whether the inventory has the indicated tag.
<inventory>.hasAllTags(tagList)
tagList(string | string array) a list of tags to check for; can be strings passed as individual arguments, an array of strings, or any combination thereof
Returns whether the inventory has all of the indicated tag(s).
<inventory>.hasAnyTags(tagList)
tagList(string | string array) a list of tags to check for; can be strings passed as individual arguments, an array of strings, or any combination thereof
Returns whether the inventory has any of the indicated tag(s).
<inventory>.clone()
Returns a deep copy of the inventory.