Macro APITriggers
Gathering Node Found
Runs when a gatherable resource appears during a run.
- Category
- Gathering
- Runs when
- A resource can be gathered.
- Summary
- Runs when a gatherable resource appears during a run.
- Version
- 1
Events
- system-gathering-found
Lua Example
print("Resource type", ctx.gatheringNode.nodeTypeKey)ctx Fields
| Trigger | Path | Type | Label | Description |
|---|---|---|---|---|
| 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. |
Blocks
| Block | Category | Summary |
|---|---|---|
| Continue | Flow | Returns continue to the Storyteller. |
| Pause | Flow | Returns pause to the Storyteller. |