Queries and selectors

Find items and monsters by name or ID, and players by username.

Use an ID selector when a name has multiple matches or an ID is ambiguous. A selector names what you want to match, such as { itemId: 12345 }.

Look up by name

Use the full name. A plain name and a name selector work the same way:

yield* api.inventory.get("Scroll of Enrage");
yield* api.inventory.get({ name: "Scroll of Enrage" });

For players, use their username:

yield* api.players.get("player_name");
yield* api.players.get({ username: "player_name" });

When names aren’t enough, use itemId for an item or monsterMapId for a specific monster:

yield* api.inventory.get({ itemId: 12345 });
yield* api.monsters.get({ monsterMapId: 3 });

If any monster will do, use "*":

yield* api.monsters.get("*");

Use itemId to find an item, or shopItemId to choose a particular shop entry. You can get these IDs from api.shop.getAll().

yield* api.shop.get({ itemId: 12345 });
yield* api.shop.get({ shopItemId: 67890 });