Scripting API

import net.runelite.client.plugins.projectx.bot.*;

SceneObject rock = Objects.query("Copper rocks").nearestReachable();
if (rock != null) {
    rock.interact("Mine");
}

Npcs.query("Cow").interact("Attack");

if (Inventory.isFull()) {
    Bank.depositAll();
}

Rules worth knowing from day one:

• Wait with sleepUntil(condition, timeoutMs), not a fixed sleep, when you are waiting for the game to change.
• Check for null: a search that finds nothing returns null from nearest(). Npcs.query("Cow").interact("Attack") searches and clicks in one go and returns false when there is no cow.
• Don't keep entities between loops. Search again each time; the scene changes every tick.
• Object names are the in-game names: the rock is Copper rocks, not Copper rock.

All in net.runelite.client.plugins.projectx.bot.

Every search has three parts: where to look, filters, and a terminal that gives the answer.

SceneObject tree = Objects.query("Oak tree").nearestReachable();         // by exact name
Npc banker       = Npcs.query().nameEquals("Banker").nearest();          // same, long form
FloorItem coins  = GroundItems.query().withId(ItemID.COINS).within(10).first();
List<Npc> goblins = Npcs.query().withNameContains("goblin").list();
int nearby       = Players.query().within(15).count();
boolean clicked  = Objects.query().withIds(ROCK_IDS).interact("Mine");  // search + click

Filters (chain as many as you like): nameEquals(name), withName(name), withNames(a, b), withNameContains(text), withId(id), withIds(ids...), within(tiles), within(point, tiles), where(entity -> ...), fromWorldView(). Names compare ignoring case.

Terminals (end the search): nearest(), nearest(maxTiles), nearestReachable(), first(), firstReachable(), list(), count(), interact(action).

Name searches off the game thread. A name filter reads each entity's name from the game, one hop per entity. If you search by name a lot, the ...OnClientThread() terminals (nearestOnClientThread(), firstOnClientThread(), toListOnClientThread()) do the whole search in one hop and are much cheaper.

Npcs.stream(), Objects.stream(), GroundItems.stream() and Players.stream() give everything in the scene this tick as a Java Stream.

interact(action) is the same as click(action), which also still works. It returns true when the click was sent. The names avoid clashing with RuneLite's own types: SceneObject (not GameObject), Npc (RuneLite has NPC), FloorItem, PlayerModel (RuneLite has Player).

Prayers.toggle(Prayers.PROTECT_MELEE, true);
Magic.cast(Spells.HIGH_LEVEL_ALCHEMY);
for (Rs2Food food : Foods.values()) { ... }

Prayers.PIETY is Rs2PrayerEnum.PIETY: a variable that holds one still has the old enum type (Rs2PrayerEnum, Rs2Spells, Rs2Food, ...).

• Player is the helper for your character. RuneLite also has net.runelite.api.Player; if a file needs both, write RuneLite's out in full.
• Objects shares its name with java.util.Objects. Don't import java.util.Objects; bot.Objects has the same equals, hash, requireNonNull, ... methods.
• With import net.runelite.api.*; or import java.util.*; in the same file, import Player or Objects by name so Java knows which one you mean.

Every old Rs2* name keeps working: scripts compiled against them run unchanged. They are marked deprecated so new code picks the short names. To move code over, rename; the methods are the same.

Searches move from the cache getters to the entry points: ProjectX.getRs2NpcCache().query() becomes Npcs.query(), ....query().withName("X") becomes ....query("X"), model.click(action) becomes model.interact(action), and query.toList() becomes query.list().