| Name | Type | Deprecated | Secure | Description |
|---|---|---|---|---|
| Command.Item.Destroy | function | Destroys an item. Be careful: this really does destroy an item. There is no confirmation dialog a... | ||
| Command.Item.Move | function | Moves an item from one location to another. This cannot move items directly between equipment, wa... | ||
| Command.Item.Split | function | Splits a number of items off a stack. | ||
| Command.Item.Standard.Drag | function | Behaves in the same way that the addon system does when an inventory icon is dragged. | ||
| Command.Item.Standard.Drop | function | Behaves in the same way that the addon system does when an inventory icon is dropped. | ||
| Command.Item.Standard.Left | function | Behaves in the same way that the addon system does when an inventory icon is left-clicked. | ||
| Command.Item.Standard.Right | function | Behaves in the same way that the addon system does when an inventory icon is right-clicked. | ||
| Event.Item.Slot | Signals that the contents of an item slot have changed. | |||
| Event.Item.Update | Signals that an item has changed. | |||
| Inspect.Item.Detail | function | Provides detailed information about items. | ||
| Inspect.Item.Find | function | Finds a slot specifier based on an item ID. | ||
| Inspect.Item.List | function | Generate a list of item IDs from a slot specifier or set of slot specifiers. | ||
| Utility.Item.Slot.All | function | Generates a slot specifier for all known items. | ||
| Utility.Item.Slot.Bank | function | Generates a slot specifier for the player's bank. | ||
| Utility.Item.Slot.Equipment | function | Generates a slot specifier for the player's equipment. | ||
| Utility.Item.Slot.Guild | function | Generates a slot specifier for the player's guild bank. | ||
| Utility.Item.Slot.Inventory | function | Generates a slot specifier for the player's inventory. | ||
| Utility.Item.Slot.Parse | function | Parses a slot specifier, returning information on what it represents. | ||
| Utility.Item.Slot.Quest | function | Generates a slot specifier for the player's quest bag. | ||
| Utility.Item.Slot.Wardrobe | function | Generates a slot specifier for the player's wardrobe. |
Destroys an item. Be careful: this really does destroy an item. There is no confirmation dialog and the process is irreversible. This cannot destroy items directly out of the guild bank.
Interaction category: item
Throttled.
| Command.Item.Destroy(target) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| target | parameter | item | The item ID of the item to destroy. |
Moves an item from one location to another. This cannot move items directly between equipment, wardrobe, or guild bank - you'll have to stop off in the inventory first.
Interaction category: item
Throttled.
| Command.Item.Move(source, destination) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| destination | parameter | slot | The location to move the item. May attempt to stack or swap if there is already an item here. |
| source | parameter | item, slot | The item to move. Must be a slot specifier that refers to an actual item. |
Splits a number of items off a stack.
Interaction category: item
Throttled.
| Command.Item.Split(source, stack) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| source | parameter | item, slot | The item to split. May be a slot specifier or an item ID. |
| stack | parameter | number | The number of items to move into the new stack. Must be a positive integer. |
Behaves in the same way that the addon system does when an inventory icon is dragged.
Interaction category: item
| Command.Item.Standard.Drag(target) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| target | parameter | item, slot | The item or slot to be targeted. |
Behaves in the same way that the addon system does when an inventory icon is dropped.
Interaction category: item
| Command.Item.Standard.Drop(target) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| target | parameter | item, slot | The item or slot to be targeted. |
Behaves in the same way that the addon system does when an inventory icon is left-clicked.
Interaction category: item
| Command.Item.Standard.Left(target) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| target | parameter | item, slot | The item or slot to be targeted. |
Behaves in the same way that the addon system does when an inventory icon is right-clicked.
Interaction category: item
| Command.Item.Standard.Right(target) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| target | parameter | item, slot | The item or slot to be targeted. |
Signals that the contents of an item slot have changed.
| Event.Item.Slot(updates) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| updates | parameter | variant | Table of changes. Key is the slot identifier, value is an item ID, false if the slot is now empty, or the string "nil" if the slot no longer exists. |
Signals that an item has changed.
| Event.Item.Update(updates) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| updates | parameter | variant | Table of changes. Key is the slot identifier, value is an item ID, false if the slot is now empty, or the string "nil" if the slot no longer exists. |
Provides detailed information about items.
| item = Inspect.Item.Detail(item) | |||
| item = Inspect.Item.Detail(itemtype) | |||
| item = Inspect.Item.Detail(slot) | |||
| items = Inspect.Item.Detail(slot) | |||
| items = Inspect.Item.Detail(elements) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| elements | parameter | table | A table of slot specifiers, item IDs, or item types. |
| item | parameter | item, table | Detail table for a single item. |
| itemtype | parameter | itemtype | A single item type. |
| slot | parameter | slot | A single slot specifier. |
| item | result | item, table | Detail table for a single item. |
| items | result | table | Detail tables for all requested items. The key is the string used to lookup, the value is the item's detail table. |
| bind | The item's binding type. May be "equip", "use", "pickup", or "account". |
|---|---|
| bound | The item's bound flag. |
| category | The item's type category. |
| coin | The amount of silver this item represents. |
| cooldown | The cooldown for using this item. |
| cooldownBegin | The time the current cooldown started, in the context of Inspect.Time.Frame. |
| cooldownDuration | Duration of the current cooldown the item is influenced by, in seconds. |
| cooldownExpired | Number of seconds the current cooldown is past its expiration time. Generally indicates lag. |
| cooldownRemaining | Time remaining in the item's current cooldown, in seconds. |
| crafter | The name of the player who crafted this item. |
| damageDelay | If a weapon, the delay between autoattacks using this weapon. |
| damageMax | If a weapon, the maximum damage done by a single hit with this item. |
| damageMin | If a weapon, the minimum damage done by a single hit with this item. |
| damageType | If a weapon, the damage type done by autoattacks. Values include "life", "death", "air", "earth", "fire", and "water". |
| description | The description of this item. |
| flavor | The flavor text for this item. |
| icon | Resource filename of the item's icon. |
| id | The ID of the requested element. |
| lootable | Indicates that the item contains loot. |
| name | The item's name. |
| range | If a ranged weapon, the maximum range of this item. |
| rarity | The item's rarity. Values include "sellable", "uncommon", "rare", "epic", "relic", "transcendant", or "quest". Common items have a rarity of nil. |
| requiredCalling | Space-delimited list of the required callings to use this item. |
| requiredFaction | The ID of the faction required to use this item. |
| requiredFactionLevel | The faction notoriety required to use this item. |
| requiredLevel | The level required to use this item. |
| requiredPrestige | The prestige rank required to use this item. |
| requiredSkill | The skill required to use this item. |
| requiredSkillLevel | The skill level required to use this item. |
| sell | The sell value of this item, in silver. |
| slots | If a container, the number of slots that this item can contain. |
| stack | The size of this item stack. |
| stackMax | The maximum size of this item stack. |
| stats | The base stats of this item. Members may include "armor", "block", "critAttack", "critPower", "critSpell", "deflect", "dexterity", "dodge", "endurance", "energyMax", "energyRegen", "hit", "intelligence", "manaMax", "manaRegen", "movement", "parry", "powerAttack", "powerMax", "powerRegen", "powerSpell", "resistAir", "resistAll", "resistDeath", "resistEarth", "resistFire", "resistLife", "resistWater", "stealth", "stealthDetect", "strength", "wisdom", "valor", "toughness", and "vengeance". |
| statsRune | The added rune stats of this item. May contain the same members as stats. |
| statsRuneTemporary | The added temporary rune stats of this item. May contain the same members as stats. |
| type | The item's type specifier. |
Finds a slot specifier based on an item ID.
| slot = Inspect.Item.Find(item) | |||
| slots = Inspect.Item.Find(items) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| item | parameter | item | A single item ID. |
| items | parameter | table | A table of item IDs. |
| slot | result | slot | A slot specifier for that item. |
| slots | result | table | Slot specifiers for all requested items. The key is the string used to lookup, the value is the slot specifier. |
Generate a list of item IDs from a slot specifier or set of slot specifiers.
| items = Inspect.Item.List() | |||
| item = Inspect.Item.List(slot) | |||
| items = Inspect.Item.List(slot) | |||
| items = Inspect.Item.List(slots) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| slot | parameter | slot | A single slot specifier. |
| slots | parameter | table | A table of slot specifiers. |
| item | result | item | A single item ID. This will be returned only if the input is a single fully-specified slot specifier. |
| items | result | table | A table of item IDs. The key is the slot specifier, the value is the item ID. |
Generates a slot specifier for all known items.
| slot = Utility.Item.Slot.All() | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| slot | result | slot | The requested slot specifier. |
Generates a slot specifier for the player's bank.
| slot = Utility.Item.Slot.Bank() | |||
| slot = Utility.Item.Slot.Bank(segment) | |||
| slot = Utility.Item.Slot.Bank(segment, slot) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| segment | parameter | number, string | Segment to inspect. Use "main" for the main bank area, "bag" for the bank bags, or a number starting at 1 for the contents of a specific bank bag. |
| slot | parameter | number, slot | The requested slot specifier. |
| slot | result | number, slot | The requested slot specifier. |
Generates a slot specifier for the player's equipment.
| slot = Utility.Item.Slot.Equipment() | |||
| slot = Utility.Item.Slot.Equipment(slot) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| slot | parameter | string, slot | The requested slot specifier. |
| slot | result | string, slot | The requested slot specifier. |
Generates a slot specifier for the player's guild bank.
| slot = Utility.Item.Slot.Guild() | |||
| slot = Utility.Item.Slot.Guild(vault) | |||
| slot = Utility.Item.Slot.Guild(vault, slot) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| slot | parameter | number, slot | The requested slot specifier. |
| vault | parameter | number | The vault ID to inspect. Starts at 1. |
| slot | result | number, slot | The requested slot specifier. |
Generates a slot specifier for the player's inventory.
| slot = Utility.Item.Slot.Inventory() | |||
| slot = Utility.Item.Slot.Inventory(bag) | |||
| slot = Utility.Item.Slot.Inventory(bag, slot) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| bag | parameter | number, string | The number of the bag whose contents should be inspected, starting at 1, or "bag" to inspect the actual inventory bags. |
| slot | parameter | number, slot | The requested slot specifier. |
| slot | result | number, slot | The requested slot specifier. |
Parses a slot specifier, returning information on what it represents.
| type, parameter, parameter = Utility.Item.Slot.Parse(slot) | |||
| type, parameter = Utility.Item.Slot.Parse(slot) | |||
| type = Utility.Item.Slot.Parse(slot) | |||
| Utility.Item.Slot.Parse(slot) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| slot | parameter | slot | The slot ID, starting at 1. |
| parameter | result | variant | A parameter for this slot type. Actual meaning depends on the type. |
| type | result | string | The type of this element. |
Generates a slot specifier for the player's quest bag.
| slot = Utility.Item.Slot.Quest() | |||
| slot = Utility.Item.Slot.Quest(slot) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| slot | parameter | number, slot | The requested slot specifier. |
| slot | result | number, slot | The requested slot specifier. |
Generates a slot specifier for the player's wardrobe.
| slot = Utility.Item.Slot.Wardrobe() | |||
| slot = Utility.Item.Slot.Wardrobe(costume) | |||
| slot = Utility.Item.Slot.Wardrobe(costume, slot) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| costume | parameter | number | The number of the wardrobe costume to inspect, starting at 1. |
| slot | parameter | string, slot | The requested slot specifier. |
| slot | result | string, slot | The requested slot specifier. |