Macro API
Player-facing reference for the macro API.
Macro API pages are generated from the public macro contract stored in cold data.
Run Lengths
Adventure Profiles store run length intent. The server resolves the final duration from cold data and clamps it by target.
| Key | Label | Duration |
|---|---|---|
| quick | Quick | 5 min |
| standard | Standard | 15 min |
| long | Long | 1 hr |
| extended | Extended | 4 hr |
Targeting
Adventure Profiles appear when any target rule matches the current run target.
- All contexts
- Travel
- Location kind
- Specific location
- Specific region
Slot Behaviors
Loot slots can run a published Loot Filter. Filters are ordered predicate/action rules lowered to the same macro program and trace path as event macros.
- Default
- Loot Filter
- Ignore
- Event Macro
Event Slots
| Slot | Trigger | Event |
|---|---|---|
| Loot container found | onLootContainerFound | system-loot-container-found |
| Gathering node found | onGatheringNodeFound | system-gathering-found |
| Item drop found | onItemDropFound | system-item-drop |
| Currency drop found | onCurrencyDropFound | system-currency-drop |
| Bank node reached | onBankNodeReached | system-bank-interaction |
System Combat Profiles
| Profile | Hooks | Default |
|---|---|---|
| Balanced | onEnemySpotted, onCombatActionRequested, onEnemyIntentRevealed, onDamageReceived, onCombatParticipantDefeated, onBattleEnded | Yes |
- Bank Node Reached
Runs when an adventurer reaches a bank node.
- Battle Ended
Runs when combat finishes.
- Combat Action Requested
Chooses the player's next combat action.
- Combat Participant Defeated
Runs when any combat participant is defeated.
- Currency Drop Found
Runs when currency appears during a run.
- Damage Received
Runs when the player takes damage.
- Enemy Intent Revealed
Runs after an enemy intent is revealed.
- Enemy Spotted
Chooses whether to engage, drink a potion, or avoid a spotted enemy.
- Gathering Node Found
Runs when a gatherable resource appears during a run.
- Item Drop Found
Runs when an item appears during a run.
- Loot Container Found
Runs when a container appears during a run.