Macro API
Inputs
Data available to macro triggers.
| Trigger | Path | Type | Label | Description |
|---|---|---|---|---|
| Bank Node Reached | ctx.bank.bankKey | string | Bank | The bank reached by the adventurer. |
| Bank Node Reached | ctx.bank.timelineBankInteractionId | id | Bank interaction | The bank interaction used by deposit actions. |
| Bank Node Reached | ctx.bank.locationKey | string | Location | The large city or authored location containing the bank. |
| Bank Node Reached | ctx.player.level | number | Player level | The player level used for this macro run. |
| Bank Node Reached | ctx.player.currencyCopper | number | Currency | The player currency carried in copper. |
| Bank Node Reached | ctx.player.bag.usedSlots | number | Bag used | The number of backpack slots currently occupied. |
| Bank Node Reached | ctx.player.bag.maxSlots | number | Bag capacity | The current backpack capacity including equipped bag bonuses. |
| Bank Node Reached | ctx.player.bag.freeSlots | number | Bag free | The number of free backpack slots remaining. |
| Bank Node Reached | ctx.player.derivedStats.maxLife | number | Derived stat | A derived stat value; other stat keys are available beside maxLife. |
| Bank Node Reached | ctx.player.equipment.mainHand.itemDefinitionKey | string | Equipped item | An equipped item definition key. Replace mainHand with another equipment slot as needed. |
| Bank Node Reached | ctx.player.equipment.mainHand.rarity | string | Equipped item rarity | The rarity of an equipped item. |
| Bank Node Reached | ctx.player.equipment.mainHand.itemLevel | number | Equipped item level | The required level of an equipped item. |
| Bank Node Reached | ctx.player.equipment.mainHand.dropLevel | number | Equipped drop level | The drop level used to generate an equipped item. |
| Bank Node Reached | ctx.player.equipment.mainHand.stats.maxLife | number | Equipped item stat | A stat contribution from an equipped item; other stat keys are available beside maxLife. |
| Bank Node Reached | ctx.player.equipment.mainHand.affixes[].key | string | Equipped affix | A rolled affix key on an equipped item. |
| Battle Ended | ctx.combat.timelineEventId | id | Source event | Timeline event where the battle ended. |
| Battle Ended | ctx.player.level | number | Player level | The player level used for this macro run. |
| Battle Ended | ctx.player.currencyCopper | number | Currency | The player currency carried in copper. |
| Battle Ended | ctx.player.bag.usedSlots | number | Bag used | The number of backpack slots currently occupied. |
| Battle Ended | ctx.player.bag.maxSlots | number | Bag capacity | The current backpack capacity including equipped bag bonuses. |
| Battle Ended | ctx.player.bag.freeSlots | number | Bag free | The number of free backpack slots remaining. |
| Battle Ended | ctx.player.derivedStats.maxLife | number | Derived stat | A derived stat value; other stat keys are available beside maxLife. |
| Battle Ended | ctx.player.equipment.mainHand.itemDefinitionKey | string | Equipped item | An equipped item definition key. Replace mainHand with another equipment slot as needed. |
| Battle Ended | ctx.player.equipment.mainHand.rarity | string | Equipped item rarity | The rarity of an equipped item. |
| Battle Ended | ctx.player.equipment.mainHand.itemLevel | number | Equipped item level | The required level of an equipped item. |
| Battle Ended | ctx.player.equipment.mainHand.dropLevel | number | Equipped drop level | The drop level used to generate an equipped item. |
| Battle Ended | ctx.player.equipment.mainHand.stats.maxLife | number | Equipped item stat | A stat contribution from an equipped item; other stat keys are available beside maxLife. |
| Battle Ended | ctx.player.equipment.mainHand.affixes[].key | string | Equipped affix | A rolled affix key on an equipped item. |
| Combat Action Requested | ctx.combat.roundNumber | number | Round number | Current combat round number. |
| Combat Action Requested | ctx.combat.enemyCount | number | Enemy count | Number of active enemies. |
| Combat Action Requested | ctx.combat.self.lifeRatio | number | Self life ratio | Current life divided by maximum life. |
| Combat Action Requested | ctx.combat.self.manaRatio | number | Self mana ratio | Current mana divided by maximum mana. |
| Combat Action Requested | ctx.combat.self.hasLifeConsumable | boolean | Self has life consumable | Whether a life-restoring consumable is available. |
| Combat Action Requested | ctx.combat.self.statuses | array | Self statuses | Status keys currently active on the player. |
| Combat Action Requested | ctx.combat.self.guardReady | boolean | Guard ready | Whether Guard is currently ready and affordable. |
| Combat Action Requested | ctx.combat.self.firstReadyNonBasicAbilityKey | string | First ready non-basic ability | The first ready non-basic ability key, or null when none is ready. |
| Combat Action Requested | ctx.combat.abilities | array | Abilities | Ability readiness records with key, cooldown, and affordability. |
| Combat Action Requested | ctx.combat.ability.rend.ready | boolean | Rend ready | Whether Rend is currently ready and affordable. |
| Combat Action Requested | ctx.combat.enemies | array | Enemies | Active enemies with index, life band, tier, statuses, and intent. |
| Combat Action Requested | ctx.combat.enemies[].intent | object | Enemy intent | Current enemy intent, or null when no action is being prepared. Intent records include kind, damageType, and magnitudeBand. |
| Combat Action Requested | ctx.combat.any.enemyIntentHeavy | boolean | Any heavy intent | Whether any enemy is preparing a heavy action. |
| Combat Action Requested | ctx.combat.any.enemyCasting | boolean | Any enemy casting | Whether any enemy is preparing a cast. |
| Combat Action Requested | ctx.combat.any.enemyLow | boolean | Any enemy low | Whether any enemy is in the low life band. |
| Combat Action Requested | ctx.player.level | number | Player level | The player level used for this macro run. |
| Combat Action Requested | ctx.player.currencyCopper | number | Currency | The player currency carried in copper. |
| Combat Action Requested | ctx.player.bag.usedSlots | number | Bag used | The number of backpack slots currently occupied. |
| Combat Action Requested | ctx.player.bag.maxSlots | number | Bag capacity | The current backpack capacity including equipped bag bonuses. |
| Combat Action Requested | ctx.player.bag.freeSlots | number | Bag free | The number of free backpack slots remaining. |
| Combat Action Requested | ctx.player.derivedStats.maxLife | number | Derived stat | A derived stat value; other stat keys are available beside maxLife. |
| Combat Action Requested | ctx.player.equipment.mainHand.itemDefinitionKey | string | Equipped item | An equipped item definition key. Replace mainHand with another equipment slot as needed. |
| Combat Action Requested | ctx.player.equipment.mainHand.rarity | string | Equipped item rarity | The rarity of an equipped item. |
| Combat Action Requested | ctx.player.equipment.mainHand.itemLevel | number | Equipped item level | The required level of an equipped item. |
| Combat Action Requested | ctx.player.equipment.mainHand.dropLevel | number | Equipped drop level | The drop level used to generate an equipped item. |
| Combat Action Requested | ctx.player.equipment.mainHand.stats.maxLife | number | Equipped item stat | A stat contribution from an equipped item; other stat keys are available beside maxLife. |
| Combat Action Requested | ctx.player.equipment.mainHand.affixes[].key | string | Equipped affix | A rolled affix key on an equipped item. |
| Combat Participant Defeated | ctx.combat.timelineEventId | id | Source event | Timeline event where the defeat appeared. |
| Combat Participant Defeated | ctx.player.level | number | Player level | The player level used for this macro run. |
| Combat Participant Defeated | ctx.player.currencyCopper | number | Currency | The player currency carried in copper. |
| Combat Participant Defeated | ctx.player.bag.usedSlots | number | Bag used | The number of backpack slots currently occupied. |
| Combat Participant Defeated | ctx.player.bag.maxSlots | number | Bag capacity | The current backpack capacity including equipped bag bonuses. |
| Combat Participant Defeated | ctx.player.bag.freeSlots | number | Bag free | The number of free backpack slots remaining. |
| Combat Participant Defeated | ctx.player.derivedStats.maxLife | number | Derived stat | A derived stat value; other stat keys are available beside maxLife. |
| Combat Participant Defeated | ctx.player.equipment.mainHand.itemDefinitionKey | string | Equipped item | An equipped item definition key. Replace mainHand with another equipment slot as needed. |
| Combat Participant Defeated | ctx.player.equipment.mainHand.rarity | string | Equipped item rarity | The rarity of an equipped item. |
| Combat Participant Defeated | ctx.player.equipment.mainHand.itemLevel | number | Equipped item level | The required level of an equipped item. |
| Combat Participant Defeated | ctx.player.equipment.mainHand.dropLevel | number | Equipped drop level | The drop level used to generate an equipped item. |
| Combat Participant Defeated | ctx.player.equipment.mainHand.stats.maxLife | number | Equipped item stat | A stat contribution from an equipped item; other stat keys are available beside maxLife. |
| Combat Participant Defeated | ctx.player.equipment.mainHand.affixes[].key | string | Equipped affix | A rolled affix key on an equipped item. |
| Currency Drop Found | ctx.currencyDrop.amountCopper | number | Currency amount | The amount of currency available to claim. |
| Currency Drop Found | ctx.currencyDrop.timelineCurrencyDropId | id | Currency drop id | The currency drop row id when the runtime can expose it before commit. |
| Currency Drop Found | ctx.currencyDrop.timelineEventId | id | Source event | The game event where the currency appeared. |
| Currency Drop Found | ctx.player.level | number | Player level | The player level used for this macro run. |
| Currency Drop Found | ctx.player.currencyCopper | number | Currency | The player currency carried in copper. |
| Currency Drop Found | ctx.player.bag.usedSlots | number | Bag used | The number of backpack slots currently occupied. |
| Currency Drop Found | ctx.player.bag.maxSlots | number | Bag capacity | The current backpack capacity including equipped bag bonuses. |
| Currency Drop Found | ctx.player.bag.freeSlots | number | Bag free | The number of free backpack slots remaining. |
| Currency Drop Found | ctx.player.derivedStats.maxLife | number | Derived stat | A derived stat value; other stat keys are available beside maxLife. |
| Currency Drop Found | ctx.player.equipment.mainHand.itemDefinitionKey | string | Equipped item | An equipped item definition key. Replace mainHand with another equipment slot as needed. |
| Currency Drop Found | ctx.player.equipment.mainHand.rarity | string | Equipped item rarity | The rarity of an equipped item. |
| Currency Drop Found | ctx.player.equipment.mainHand.itemLevel | number | Equipped item level | The required level of an equipped item. |
| Currency Drop Found | ctx.player.equipment.mainHand.dropLevel | number | Equipped drop level | The drop level used to generate an equipped item. |
| Currency Drop Found | ctx.player.equipment.mainHand.stats.maxLife | number | Equipped item stat | A stat contribution from an equipped item; other stat keys are available beside maxLife. |
| Currency Drop Found | ctx.player.equipment.mainHand.affixes[].key | string | Equipped affix | A rolled affix key on an equipped item. |
| Damage Received | ctx.combat.currentLifeRatio | number | Life ratio | Current life divided by maximum life after damage. |
| Damage Received | ctx.combat.timelineEventId | id | Source event | Timeline event where damage appeared. |
| Damage Received | ctx.player.level | number | Player level | The player level used for this macro run. |
| Damage Received | ctx.player.currencyCopper | number | Currency | The player currency carried in copper. |
| Damage Received | ctx.player.bag.usedSlots | number | Bag used | The number of backpack slots currently occupied. |
| Damage Received | ctx.player.bag.maxSlots | number | Bag capacity | The current backpack capacity including equipped bag bonuses. |
| Damage Received | ctx.player.bag.freeSlots | number | Bag free | The number of free backpack slots remaining. |
| Damage Received | ctx.player.derivedStats.maxLife | number | Derived stat | A derived stat value; other stat keys are available beside maxLife. |
| Damage Received | ctx.player.equipment.mainHand.itemDefinitionKey | string | Equipped item | An equipped item definition key. Replace mainHand with another equipment slot as needed. |
| Damage Received | ctx.player.equipment.mainHand.rarity | string | Equipped item rarity | The rarity of an equipped item. |
| Damage Received | ctx.player.equipment.mainHand.itemLevel | number | Equipped item level | The required level of an equipped item. |
| Damage Received | ctx.player.equipment.mainHand.dropLevel | number | Equipped drop level | The drop level used to generate an equipped item. |
| Damage Received | ctx.player.equipment.mainHand.stats.maxLife | number | Equipped item stat | A stat contribution from an equipped item; other stat keys are available beside maxLife. |
| Damage Received | ctx.player.equipment.mainHand.affixes[].key | string | Equipped affix | A rolled affix key on an equipped item. |
| Enemy Intent Revealed | ctx.combat.timelineEventId | id | Source event | Timeline event where the enemy intent appeared. |
| Enemy Intent Revealed | ctx.combat.enemyIntent | object | Enemy intent | The revealed intent with abilityKey, kind, damageType, and magnitudeBand. |
| Enemy Intent Revealed | ctx.player.level | number | Player level | The player level used for this macro run. |
| Enemy Intent Revealed | ctx.player.currencyCopper | number | Currency | The player currency carried in copper. |
| Enemy Intent Revealed | ctx.player.bag.usedSlots | number | Bag used | The number of backpack slots currently occupied. |
| Enemy Intent Revealed | ctx.player.bag.maxSlots | number | Bag capacity | The current backpack capacity including equipped bag bonuses. |
| Enemy Intent Revealed | ctx.player.bag.freeSlots | number | Bag free | The number of free backpack slots remaining. |
| Enemy Intent Revealed | ctx.player.derivedStats.maxLife | number | Derived stat | A derived stat value; other stat keys are available beside maxLife. |
| Enemy Intent Revealed | ctx.player.equipment.mainHand.itemDefinitionKey | string | Equipped item | An equipped item definition key. Replace mainHand with another equipment slot as needed. |
| Enemy Intent Revealed | ctx.player.equipment.mainHand.rarity | string | Equipped item rarity | The rarity of an equipped item. |
| Enemy Intent Revealed | ctx.player.equipment.mainHand.itemLevel | number | Equipped item level | The required level of an equipped item. |
| Enemy Intent Revealed | ctx.player.equipment.mainHand.dropLevel | number | Equipped drop level | The drop level used to generate an equipped item. |
| Enemy Intent Revealed | ctx.player.equipment.mainHand.stats.maxLife | number | Equipped item stat | A stat contribution from an equipped item; other stat keys are available beside maxLife. |
| Enemy Intent Revealed | ctx.player.equipment.mainHand.affixes[].key | string | Equipped affix | A rolled affix key on an equipped item. |
| Enemy Spotted | ctx.combat.currentLifeRatio | number | Life ratio | Current life divided by maximum life. |
| Enemy Spotted | ctx.combat.hasLifeConsumable | boolean | Has life consumable | Whether a life-restoring consumable is available. |
| Enemy Spotted | ctx.player.level | number | Player level | The player level used for this macro run. |
| Enemy Spotted | ctx.player.currencyCopper | number | Currency | The player currency carried in copper. |
| Enemy Spotted | ctx.player.bag.usedSlots | number | Bag used | The number of backpack slots currently occupied. |
| Enemy Spotted | ctx.player.bag.maxSlots | number | Bag capacity | The current backpack capacity including equipped bag bonuses. |
| Enemy Spotted | ctx.player.bag.freeSlots | number | Bag free | The number of free backpack slots remaining. |
| Enemy Spotted | ctx.player.derivedStats.maxLife | number | Derived stat | A derived stat value; other stat keys are available beside maxLife. |
| Enemy Spotted | ctx.player.equipment.mainHand.itemDefinitionKey | string | Equipped item | An equipped item definition key. Replace mainHand with another equipment slot as needed. |
| Enemy Spotted | ctx.player.equipment.mainHand.rarity | string | Equipped item rarity | The rarity of an equipped item. |
| Enemy Spotted | ctx.player.equipment.mainHand.itemLevel | number | Equipped item level | The required level of an equipped item. |
| Enemy Spotted | ctx.player.equipment.mainHand.dropLevel | number | Equipped drop level | The drop level used to generate an equipped item. |
| Enemy Spotted | ctx.player.equipment.mainHand.stats.maxLife | number | Equipped item stat | A stat contribution from an equipped item; other stat keys are available beside maxLife. |
| Enemy Spotted | ctx.player.equipment.mainHand.affixes[].key | string | Equipped affix | A rolled affix key on an equipped item. |
| Gathering Node Found | ctx.gatheringNode.nodeTypeKey | string | Resource type | The kind of resource that can be gathered. |
| Gathering Node Found | ctx.gatheringNode.timelineEventId | id | Source event | The game event where the resource appeared. |
| Gathering Node Found | ctx.gatheringNode.locationKey | string | Region | The area where the resource was found. |
| Gathering Node Found | ctx.player.level | number | Player level | The player level used for this macro run. |
| Gathering Node Found | ctx.player.currencyCopper | number | Currency | The player currency carried in copper. |
| Gathering Node Found | ctx.player.bag.usedSlots | number | Bag used | The number of backpack slots currently occupied. |
| Gathering Node Found | ctx.player.bag.maxSlots | number | Bag capacity | The current backpack capacity including equipped bag bonuses. |
| Gathering Node Found | ctx.player.bag.freeSlots | number | Bag free | The number of free backpack slots remaining. |
| Gathering Node Found | ctx.player.derivedStats.maxLife | number | Derived stat | A derived stat value; other stat keys are available beside maxLife. |
| Gathering Node Found | ctx.player.equipment.mainHand.itemDefinitionKey | string | Equipped item | An equipped item definition key. Replace mainHand with another equipment slot as needed. |
| Gathering Node Found | ctx.player.equipment.mainHand.rarity | string | Equipped item rarity | The rarity of an equipped item. |
| Gathering Node Found | ctx.player.equipment.mainHand.itemLevel | number | Equipped item level | The required level of an equipped item. |
| Gathering Node Found | ctx.player.equipment.mainHand.dropLevel | number | Equipped drop level | The drop level used to generate an equipped item. |
| Gathering Node Found | ctx.player.equipment.mainHand.stats.maxLife | number | Equipped item stat | A stat contribution from an equipped item; other stat keys are available beside maxLife. |
| Gathering Node Found | ctx.player.equipment.mainHand.affixes[].key | string | Equipped affix | A rolled affix key on an equipped item. |
| Item Drop Found | ctx.itemDrop.timelineItemDropId | id | Item drop id | The item drop row id when the runtime can expose it before commit. |
| Item Drop Found | ctx.itemDrop.timelineEventId | id | Source event | The game event where the item appeared. |
| Item Drop Found | ctx.itemDrop.item.itemDefinitionKey | string | Drop item definition | The dropped item's definition key. |
| Item Drop Found | ctx.itemDrop.item.categoryKey | string | Drop item category | The dropped item's category key. |
| Item Drop Found | ctx.itemDrop.item.categoryFilterGroup | string | Drop item filter group | The dropped item's broad filter group. |
| Item Drop Found | ctx.itemDrop.item.rarity | string | Drop item rarity | The dropped item's rarity. |
| Item Drop Found | ctx.itemDrop.item.quantity | number | Drop item quantity | The dropped stack quantity. |
| Item Drop Found | ctx.itemDrop.item.itemLevel | number | Drop item level | The dropped item's required level. |
| Item Drop Found | ctx.itemDrop.item.dropLevel | number | Drop level | The level used to generate the item. |
| Item Drop Found | ctx.itemDrop.item.vendorValueCopper | number | Drop vendor value | The stack's vendor value in copper. |
| Item Drop Found | ctx.itemDrop.item.tags[] | array | Drop item tags | Affix group and tag labels on the dropped item. |
| Item Drop Found | ctx.itemDrop.item.isEquippable | boolean | Drop item equippable | Whether the dropped item can be equipped. |
| Item Drop Found | ctx.itemDrop.item.upgrade.slot | string | Drop upgrade slot | The equipped slot the dropped item was compared against; two-slot item types use the weaker occupied slot, or an empty slot first. |
| Item Drop Found | ctx.itemDrop.item.upgrade.isUpgradeForEquippedSlot | boolean | Drop upgrade | True when the dropped item's raw stat total is greater than the compared equipped slot, or the slot is empty. |
| Item Drop Found | ctx.itemDrop.item.upgrade.statDeltas.maxLife | number | Drop upgrade stat delta | A stat delta versus the compared equipped slot; other stat keys are available beside maxLife. |
| Item Drop Found | ctx.itemDrop.item.affixes[].key | string | Drop affix key | A rolled affix key on the dropped item. |
| Item Drop Found | ctx.itemDrop.item.affixes[].type | string | Drop affix type | Whether the rolled affix is a prefix or suffix. |
| Item Drop Found | ctx.itemDrop.item.affixes[].name | string | Drop affix name | The rolled affix display name. |
| Item Drop Found | ctx.itemDrop.item.affixes[].equipLevelRequired | number | Drop affix level | The level required by the rolled affix. |
| Item Drop Found | ctx.itemDrop.item.affixes[].modifiers[].stat | string | Drop affix modifier stat | The stat changed by a rolled affix modifier. |
| Item Drop Found | ctx.itemDrop.item.affixes[].modifiers[].op | string | Drop affix modifier op | The operation used by a rolled affix modifier. |
| Item Drop Found | ctx.itemDrop.item.affixes[].modifiers[].value | number | Drop affix modifier value | The numeric value of a rolled affix modifier. |
| Item Drop Found | ctx.itemDrop.item.implicitModifiers[].stat | string | Drop implicit modifier stat | The stat changed by a base implicit modifier. |
| Item Drop Found | ctx.itemDrop.item.implicitModifiers[].op | string | Drop implicit modifier op | The operation used by a base implicit modifier. |
| Item Drop Found | ctx.itemDrop.item.implicitModifiers[].value | number | Drop implicit modifier value | The numeric value of a base implicit modifier. |
| Item Drop Found | ctx.itemDrop.item.isUnique | boolean | Drop is unique | True when the dropped item is an Uncommon Rare. |
| Item Drop Found | ctx.itemDrop.item.uniqueImplicitModifiers[].stat | string | Drop unique implicit stat | The stat changed by a unique implicit modifier. |
| Item Drop Found | ctx.itemDrop.item.uniqueImplicitModifiers[].op | string | Drop unique implicit op | The operation used by a unique implicit modifier. |
| Item Drop Found | ctx.itemDrop.item.uniqueImplicitModifiers[].value | number | Drop unique implicit value | The numeric value of a unique implicit modifier. |
| Item Drop Found | ctx.itemDrop.item.timelineEventId | id | Drop item event | The timeline event id to pass back to drop item actions. |
| Item Drop Found | ctx.player.level | number | Player level | The player level used for this macro run. |
| Item Drop Found | ctx.player.currencyCopper | number | Currency | The player currency carried in copper. |
| Item Drop Found | ctx.player.bag.usedSlots | number | Bag used | The number of backpack slots currently occupied. |
| Item Drop Found | ctx.player.bag.maxSlots | number | Bag capacity | The current backpack capacity including equipped bag bonuses. |
| Item Drop Found | ctx.player.bag.freeSlots | number | Bag free | The number of free backpack slots remaining. |
| Item Drop Found | ctx.player.derivedStats.maxLife | number | Derived stat | A derived stat value; other stat keys are available beside maxLife. |
| Item Drop Found | ctx.player.equipment.mainHand.itemDefinitionKey | string | Equipped item | An equipped item definition key. Replace mainHand with another equipment slot as needed. |
| Item Drop Found | ctx.player.equipment.mainHand.rarity | string | Equipped item rarity | The rarity of an equipped item. |
| Item Drop Found | ctx.player.equipment.mainHand.itemLevel | number | Equipped item level | The required level of an equipped item. |
| Item Drop Found | ctx.player.equipment.mainHand.dropLevel | number | Equipped drop level | The drop level used to generate an equipped item. |
| Item Drop Found | ctx.player.equipment.mainHand.stats.maxLife | number | Equipped item stat | A stat contribution from an equipped item; other stat keys are available beside maxLife. |
| Item Drop Found | ctx.player.equipment.mainHand.affixes[].key | string | Equipped affix | A rolled affix key on an equipped item. |
| Loot Container Found | ctx.lootContainer.containerTypeKey | string | Container type | The kind of container that was found. |
| Loot Container Found | ctx.lootContainer.timelineEventId | id | Source event | The game event where the container appeared. |
| Loot Container Found | ctx.lootContainer.locationKey | string | Region | The area where the container was found. |
| Loot Container Found | loot.openContainer(...).items[].itemDefinitionKey | string | Loot item definition | The generated item's definition key. |
| Loot Container Found | loot.openContainer(...).items[].categoryKey | string | Loot item category | The generated item's category key. |
| Loot Container Found | loot.openContainer(...).items[].categoryFilterGroup | string | Loot item filter group | The generated item's broad filter group. |
| Loot Container Found | loot.openContainer(...).items[].rarity | string | Loot item rarity | The generated item's rarity. |
| Loot Container Found | loot.openContainer(...).items[].quantity | number | Loot item quantity | The generated stack quantity. |
| Loot Container Found | loot.openContainer(...).items[].itemLevel | number | Loot item level | The generated item's required level. |
| Loot Container Found | loot.openContainer(...).items[].dropLevel | number | Loot drop level | The level used to generate the item. |
| Loot Container Found | loot.openContainer(...).items[].vendorValueCopper | number | Loot vendor value | The stack's vendor value in copper. |
| Loot Container Found | loot.openContainer(...).items[].tags[] | array | Loot item tags | Affix group and tag labels on the generated item. |
| Loot Container Found | loot.openContainer(...).items[].isEquippable | boolean | Loot item equippable | Whether the generated item can be equipped. |
| Loot Container Found | loot.openContainer(...).items[].upgrade.slot | string | Loot upgrade slot | The equipped slot the generated item was compared against; two-slot item types use the weaker occupied slot, or an empty slot first. |
| Loot Container Found | loot.openContainer(...).items[].upgrade.isUpgradeForEquippedSlot | boolean | Loot upgrade | True when the generated item's raw stat total is greater than the compared equipped slot, or the slot is empty. |
| Loot Container Found | loot.openContainer(...).items[].upgrade.statDeltas.maxLife | number | Loot upgrade stat delta | A stat delta versus the compared equipped slot; other stat keys are available beside maxLife. |
| Loot Container Found | loot.openContainer(...).items[].affixes[].key | string | Loot affix key | A rolled affix key on the generated item. |
| Loot Container Found | loot.openContainer(...).items[].affixes[].type | string | Loot affix type | Whether the rolled affix is a prefix or suffix. |
| Loot Container Found | loot.openContainer(...).items[].affixes[].name | string | Loot affix name | The rolled affix display name. |
| Loot Container Found | loot.openContainer(...).items[].affixes[].equipLevelRequired | number | Loot affix level | The level required by the rolled affix. |
| Loot Container Found | loot.openContainer(...).items[].affixes[].modifiers[].stat | string | Loot affix modifier stat | The stat changed by a rolled affix modifier. |
| Loot Container Found | loot.openContainer(...).items[].affixes[].modifiers[].op | string | Loot affix modifier op | The operation used by a rolled affix modifier. |
| Loot Container Found | loot.openContainer(...).items[].affixes[].modifiers[].value | number | Loot affix modifier value | The numeric value of a rolled affix modifier. |
| Loot Container Found | loot.openContainer(...).items[].implicitModifiers[].stat | string | Loot implicit modifier stat | The stat changed by a base implicit modifier. |
| Loot Container Found | loot.openContainer(...).items[].implicitModifiers[].op | string | Loot implicit modifier op | The operation used by a base implicit modifier. |
| Loot Container Found | loot.openContainer(...).items[].implicitModifiers[].value | number | Loot implicit modifier value | The numeric value of a base implicit modifier. |
| Loot Container Found | loot.openContainer(...).items[].isUnique | boolean | Loot is unique | True when the generated item is an Uncommon Rare. |
| Loot Container Found | loot.openContainer(...).items[].uniqueImplicitModifiers[].stat | string | Loot unique implicit stat | The stat changed by a unique implicit modifier. |
| Loot Container Found | loot.openContainer(...).items[].uniqueImplicitModifiers[].op | string | Loot unique implicit op | The operation used by a unique implicit modifier. |
| Loot Container Found | loot.openContainer(...).items[].uniqueImplicitModifiers[].value | number | Loot unique implicit value | The numeric value of a unique implicit modifier. |
| Loot Container Found | loot.openContainer(...).items[].timelineEventId | id | Loot item event | The timeline event id to pass back to loot item actions. |
| Loot Container Found | ctx.player.level | number | Player level | The player level used for this macro run. |
| Loot Container Found | ctx.player.currencyCopper | number | Currency | The player currency carried in copper. |
| Loot Container Found | ctx.player.bag.usedSlots | number | Bag used | The number of backpack slots currently occupied. |
| Loot Container Found | ctx.player.bag.maxSlots | number | Bag capacity | The current backpack capacity including equipped bag bonuses. |
| Loot Container Found | ctx.player.bag.freeSlots | number | Bag free | The number of free backpack slots remaining. |
| Loot Container Found | ctx.player.derivedStats.maxLife | number | Derived stat | A derived stat value; other stat keys are available beside maxLife. |
| Loot Container Found | ctx.player.equipment.mainHand.itemDefinitionKey | string | Equipped item | An equipped item definition key. Replace mainHand with another equipment slot as needed. |
| Loot Container Found | ctx.player.equipment.mainHand.rarity | string | Equipped item rarity | The rarity of an equipped item. |
| Loot Container Found | ctx.player.equipment.mainHand.itemLevel | number | Equipped item level | The required level of an equipped item. |
| Loot Container Found | ctx.player.equipment.mainHand.dropLevel | number | Equipped drop level | The drop level used to generate an equipped item. |
| Loot Container Found | ctx.player.equipment.mainHand.stats.maxLife | number | Equipped item stat | A stat contribution from an equipped item; other stat keys are available beside maxLife. |
| Loot Container Found | ctx.player.equipment.mainHand.affixes[].key | string | Equipped affix | A rolled affix key on an equipped item. |