Package com.botwithus.bot.api.entities

package com.botwithus.bot.api.entities

Rich entity wrappers and fluent query builders.

This package sits on top of two substrates:

• api.snapshot.* — read-only tick-scoped records pulled directly from shared memory. Entity queries iterate these for the cheap path (no RPC).
• api.GameAPI — RPC and definition lookups for fields that aren't on the snapshot wire (NPC names, options, varbits/varps, etc.). Definition lookups are cached by id.

Obtain query facades through GameAPI:

  Npc target = api.npcs().query()
      .named("Goblin")
      .withinDistance(15)
      .filter(n -> n.hasOption("Attack"))
      .nearest();
  if (target != null) target.interact("Attack");

The facades (Npcs, Players) are singletons per GameAPI; only the per-query builder and the per-result wrappers allocate.

Related Packages

Package	Description
com.botwithus.bot.api	Core API interfaces for the BotWithUs scripting framework.

Class	Description
EntityContext	Shared surface for everything an EntityQuery can reason about without consulting an entity-specific definition.
EntityQuery<T extends EntityContext, Q extends EntityQuery<T,Q>>	Fluent query builder shared across entity types.
GroundItem	Rich wrapper around GroundItemInfo with lazy ItemType resolution and option-keyed interact.
GroundItems	Ground-item query facade.
GroundItems.Query
Npc	Rich wrapper around a snapshot Npc record plus the cached NpcType definition.
Npcs	NPC query facade.
Npcs.Query	Query subclass — wires the snapshot stream + name resolution to EntityQuery.
Player	Rich wrapper around a snapshot Player record.
Players	Player query facade.
Players.Query
Projectile	Rich wrapper around a snapshot Projectile record — one in-flight projectile at the producer's current tick (v17+).
Projectiles	In-flight projectile query facade (v17+).
Projectiles.Query	Query subclass — wires the snapshot stream to EntityQuery.
SceneObject	Rich wrapper around SceneObjectInfo with lazy LocationType resolution and option-keyed interact.
SceneObjects	Scene-object query facade.
SceneObjects.Query
WorldMapElements	World-map element query facade.
WorldMapElements.Query	Fluent filter builder for world-map element queries.