ArkInventory [Rules] RestedXP

A small plugin for ArkInventory that lets ArkInventory rules match items used by the remaining steps of your current RestedXP guide.

ArkInventory evaluates rule formulas in a sandbox where only its own functions are available. It knows nothing about RestedXP. This plugin registers the rule function rxpitem() to fill that gap.

Typical use: a "Guide items" bar that holds everything the guide will still ask you to collect, use, buy or equip, so you don't sell or bank it by accident.

Game version: WoW Forever only. Classic Era and other versions are not supported.

Requirements

• ArkInventory including ArkInventoryRules (enabled)
• RestedXP Guides with a guide loaded

Rule function

Steps that count:

• the current step and every step after it,
• earlier steps that are still active (sticky steps),
• except steps you skipped.

Items from steps already behind you (finished or skipped) still count for collect, collectmultiple and questitemcount while the quest they belong to is in your quest log. The turn-in step only names the quest, not the items it needs, so without this the items would drop out as soon as you finish collecting them.

Guide commands that count, and the name to pass to rxpitem(...) to filter by them:

Left out on purpose: destroy (items the guide tells you to throw away) and usespell (spells, not items).

Examples

Everything the rest of the guide needs:

rxpitem()

Only items you still have to use:

rxpitem("use")

Guide items, but not quest items that already have their own bar:

rxpitem() and not rxpitem("collect")

In-game setup

1. Open /ai rules and create a new rule, e.g. "Guide items".
2. Enter a formula, e.g. rxpitem(), and enable the rule.
3. In the bag window, right-click a bar → Categories – Assignable → Rule → assign the new rule to the bar.

Good to know

• Only the loaded guide counts. Items that only the next guide needs show up once that guide is loaded.
• Collected items stay in until the turn-in. Quest items keep counting after you move past the collect step, as long as the quest is in your quest log. Items without a quest (e.g. a plain collect for a profession) drop out once their step is behind you.
• Refresh. ArkInventory caches rule results. The plugin checks every 2 seconds whether the guide or the current step changed, and also reacts to accepting, turning in or abandoning quests. Only when the resulting item list changed it clears the cache and redraws the bags.
• Rules beat built-in categories. A matching rule always wins over default categories. A rule's priority only matters against other rules.
• Manual assignments beat rules. An item you assigned to a category by hand stays there.
• Without RestedXP loaded, or without a guide, rxpitem() never matches. No errors are raised.

License

MIT, see LICENSE.

Source code and issues

github.com/byWulf/wow-arkinventory-rules-restedxp