Index (BotWithUs API 1.0-SNAPSHOT)

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

abandon() - Method in class com.botwithus.bot.api.draw.DrawFrame: Discard everything queued without sending it.
ABANDONED - Enum constant in enum class com.botwithus.bot.api.runtime.Liveness: Revoked and still alive.
abortOffer(int) - Method in class com.botwithus.bot.api.util.GrandExchange: Click the abort button of offer slot (0-based) on the offer summary.
absScreenPos() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the absScreenPos record component.
ACCOUNT_NOT_FOUND - Static variable in exception class com.botwithus.bot.api.script.LauncherException: No account has that id.
accountId() - Method in record class com.botwithus.bot.api.script.LaunchedClient: Returns the value of the accountId record component.
accountName() - Method in record class com.botwithus.bot.api.script.LaunchedClient: Returns the value of the accountName record component.
accounts() - Method in interface com.botwithus.bot.api.script.ClientLauncher: The launcher's accounts this script may launch.
accountUuid() - Method in record class com.botwithus.bot.api.script.ManagementTarget.ClientScript: Returns the value of the accountUuid record component.
ACHIEVEMENT - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Achievements.
ACTION_BAR - Static variable in class com.botwithus.bot.api.constants.InterfaceIds
ActionAPI - Interface in com.botwithus.bot.api.domain: Game action queuing and execution control.
ActionEntry - Record Class in com.botwithus.bot.api.model: A historical record of an executed game action.
ActionEntry(int, int, int, int, long, long) - Constructor for record class com.botwithus.bot.api.model.ActionEntry: Creates an instance of a ActionEntry record class.
ActionExecutedEvent - Record Class in com.botwithus.bot.api.event: Fired after each queued bot action is executed on the game thread.
ActionExecutedEvent(int, int, int, int) - Constructor for record class com.botwithus.bot.api.event.ActionExecutedEvent
ActionExecutedEvent(int, int, int, int, long) - Constructor for record class com.botwithus.bot.api.event.ActionExecutedEvent: Creates an instance of a ActionExecutedEvent record class.
actionId() - Method in record class com.botwithus.bot.api.event.ActionExecutedEvent: Returns the value of the actionId record component.
actionId() - Method in record class com.botwithus.bot.api.model.ActionEntry: Returns the value of the actionId record component.
actionId() - Method in record class com.botwithus.bot.api.model.GameAction: Returns the value of the actionId record component.
ActionTypes - Class in com.botwithus.bot.api.inventory: Action type IDs corresponding to the game's mini menu system.
actualLevel() - Method in record class com.botwithus.bot.api.model.PlayerStat: Returns the value of the actualLevel record component.
actualLevel() - Method in record class com.botwithus.bot.api.snapshot.Skill: Returns the value of the actualLevel record component.
addToGroup(String, String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Adds a client to a group.
agentSha() - Method in record class com.botwithus.bot.api.script.LaunchedClient: Returns the value of the agentSha record component.
AgentUpdated(String) - Constructor for record class com.botwithus.bot.api.script.LauncherEvent.AgentUpdated: Creates an instance of a AgentUpdated record class.
AGILITY - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
AGILITY - Static variable in class com.botwithus.bot.api.util.Skills
agilityLevel() - Method in record class com.botwithus.bot.api.model.WorldPathConfig: Returns the value of the agilityLevel record component.
agilityLevel(int) - Method in class com.botwithus.bot.api.model.WorldPathConfig.Builder
alive() - Static method in interface com.botwithus.bot.api.snapshot.NpcFilter
all() - Method in class com.botwithus.bot.api.component.ComponentQuery: All matching nodes, in breadth-first tree order.
all() - Method in class com.botwithus.bot.api.entities.EntityQuery
all() - Method in class com.botwithus.bot.api.entities.Players
all() - Method in class com.botwithus.bot.api.entities.Projectiles: Every in-flight projectile this tick.
all() - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
all(int) - Method in class com.botwithus.bot.api.entities.Npcs: All NPCs of the given type id.
all(int) - Method in class com.botwithus.bot.api.entities.SceneObjects
all(String) - Method in class com.botwithus.bot.api.entities.Npcs: All NPCs whose name matches name (case-insensitive contains).
all(String) - Method in class com.botwithus.bot.api.entities.SceneObjects
all(String) - Method in class com.botwithus.bot.api.entities.WorldMapElements: Convenience: all elements with a given name (case-insensitive contains).
ALL - Enum constant in enum class com.botwithus.bot.api.inventory.Bank.TransferAmount
allByCategory(int) - Method in class com.botwithus.bot.api.entities.WorldMapElements: Convenience: all elements in a category.
allByGameval(String) - Method in class com.botwithus.bot.api.entities.GroundItems: All ground stacks of the item with the given gameval name.
allByGameval(String) - Method in class com.botwithus.bot.api.entities.Npcs: All NPCs with the given gameval name.
allByGameval(String) - Method in class com.botwithus.bot.api.entities.SceneObjects: All scene objects with the given gameval name.
allowClimbovers() - Method in record class com.botwithus.bot.api.model.WorldPathConfig: Returns the value of the allowClimbovers record component.
allowClimbovers(boolean) - Method in class com.botwithus.bot.api.model.WorldPathConfig.Builder
allowDoors() - Method in record class com.botwithus.bot.api.model.WorldPathConfig: Returns the value of the allowDoors record component.
allowDoors(boolean) - Method in class com.botwithus.bot.api.model.WorldPathConfig.Builder
allowPlaneTransitions() - Method in record class com.botwithus.bot.api.model.WorldPathConfig: Returns the value of the allowPlaneTransitions record component.
allowPlaneTransitions(boolean) - Method in class com.botwithus.bot.api.model.WorldPathConfig.Builder
allowShortcuts() - Method in record class com.botwithus.bot.api.model.WorldPathConfig: Returns the value of the allowShortcuts record component.
allowShortcuts(boolean) - Method in class com.botwithus.bot.api.model.WorldPathConfig.Builder
allowTeleports() - Method in record class com.botwithus.bot.api.model.WorldPathConfig: Returns the value of the allowTeleports record component.
allowTeleports(boolean) - Method in class com.botwithus.bot.api.model.WorldPathConfig.Builder
allowTransports() - Method in record class com.botwithus.bot.api.model.WorldPathConfig: Returns the value of the allowTransports record component.
allowTransports(boolean) - Method in class com.botwithus.bot.api.model.WorldPathConfig.Builder
alpha(int) - Method in class com.botwithus.bot.api.draw.DrawBuilder: The current colour at a different 0..255 alpha.
alpha(int) - Method in class com.botwithus.bot.api.draw.DrawCaptionBuilder: The current colour at a different 0..255 alpha.
alpha(int) - Method in class com.botwithus.bot.api.draw.HighlightBuilder: The current colour at a different 0..255 alpha.
alphaOf(int) - Static method in class com.botwithus.bot.api.draw.Colors: The 0..255 alpha channel of a packed colour.
alt() - Method in record class com.botwithus.bot.api.event.KeyInputEvent: Returns the value of the alt record component.
alternateStartLocation() - Method in record class com.botwithus.bot.api.model.QuestType: Returns the value of the alternateStartLocation record component.
AMMUNITION - Enum constant in enum class com.botwithus.bot.api.inventory.Equipment.Slot
AMOUNT - Enum constant in enum class com.botwithus.bot.api.input.InputMode: A quantity ("Enter amount:"), e.g.
and(Predicate) - Method in interface com.botwithus.bot.api.snapshot.GroundItemFilter
and(Predicate) - Method in interface com.botwithus.bot.api.snapshot.LocationFilter
and(Predicate) - Method in interface com.botwithus.bot.api.snapshot.NpcFilter
and(Predicate) - Method in interface com.botwithus.bot.api.snapshot.PlayerFilter
and(Predicate) - Method in interface com.botwithus.bot.api.snapshot.ProjectileFilter
animating() - Static method in interface com.botwithus.bot.api.snapshot.LocationFilter
animatingPrecedence() - Method in record class com.botwithus.bot.api.model.SequenceType: Returns the value of the animatingPrecedence record component.
animationId() - Method in class com.botwithus.bot.api.entities.Npc
animationId() - Method in class com.botwithus.bot.api.entities.Player
animationId() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Returns the value of the animationId record component.
animationId() - Method in record class com.botwithus.bot.api.snapshot.Location: Returns the value of the animationId record component.
animationId() - Method in record class com.botwithus.bot.api.snapshot.Npc: Returns the value of the animationId record component.
animationId() - Method in record class com.botwithus.bot.api.snapshot.Player: Returns the value of the animationId record component.
AnimationIds - Class in com.botwithus.bot.api.constants
annotation(String, Object) - Method in interface com.botwithus.bot.api.debug.ScriptContextPublisher: Script-defined named annotation.
applied() - Method in record class com.botwithus.bot.api.draw.DrawBatchResult: Returns the value of the applied record component.
APPLYING - Enum constant in enum class com.botwithus.bot.api.script.LauncherEvent.DataPhase
applyWhenHostsClose() - Method in record class com.botwithus.bot.api.script.LauncherEvent.DataUpdateAvailable: Returns the value of the applyWhenHostsClose record component.
ARCHAEOLOGY - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
ARCHAEOLOGY - Static variable in class com.botwithus.bot.api.util.Skills
area(int, int, int, int, int) - Method in interface com.botwithus.bot.api.draw.DrawTarget: Highlight a block of ground under the conventional auto key area:<x>:<y>:<w>:<h>:<plane>.
area(String, int, int, int, int, int) - Method in interface com.botwithus.bot.api.draw.DrawTarget: Highlight a widthTiles by heightTiles block of ground, anchored at its minimum corner, all in whole tiles.
Area(String, DrawStyle, int, int, int, int, int, DrawCaption) - Constructor for record class com.botwithus.bot.api.draw.DrawCommand.Area: Creates an instance of a Area record class.
areActionsBlocked() - Method in interface com.botwithus.bot.api.domain.ActionAPI: Checks whether action queuing is currently blocked.
argb(int, int, int, int) - Static method in class com.botwithus.bot.api.draw.Colors: Pack four 0..255 channels.
ARRIVED - Enum constant in enum class com.botwithus.bot.api.model.WalkResult: The walker reached the destination.
asMap() - Method in record class com.botwithus.bot.api.config.ScriptConfig: Returns an unmodifiable view of the raw values.
at(int) - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.GroundItems
at(int) - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Inventories
at(int) - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Locations
at(int) - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Npcs
at(int) - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Players
at(int) - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Projectiles
attach(ScriptUiHost) - Method in interface com.botwithus.bot.api.ui.ScriptUI: Called before every ScriptUI.render(), on the same thread, with the handle for the place the UI is drawn this frame: a pop-out window or the host's drawer.
Attached(String) - Constructor for record class com.botwithus.bot.api.script.LaunchOutcome.Attached: Creates an instance of a Attached record class.
ATTACHED - Enum constant in enum class com.botwithus.bot.api.script.LaunchedClient.Kind
AttachFailed(String) - Constructor for record class com.botwithus.bot.api.script.LaunchOutcome.AttachFailed: Creates an instance of a AttachFailed record class.
ATTACK - Static variable in class com.botwithus.bot.api.util.Skills
attempt() - Method in record class com.botwithus.bot.api.runtime.ReconnectState.Reconnecting: Returns the value of the attempt record component.
attempts() - Method in record class com.botwithus.bot.api.runtime.ReconnectState.GivingUp: Returns the value of the attempts record component.
atTile(int, int) - Static method in interface com.botwithus.bot.api.snapshot.GroundItemFilter
atTile(int, int) - Static method in interface com.botwithus.bot.api.snapshot.LocationFilter
atTile(int, int, int) - Static method in interface com.botwithus.bot.api.snapshot.GroundItemFilter
atTile(int, int, int) - Static method in interface com.botwithus.bot.api.snapshot.LocationFilter
AURA - Enum constant in enum class com.botwithus.bot.api.inventory.Equipment.Slot
author() - Method in record class com.botwithus.bot.api.script.ScriptInfo: Returns the value of the author record component.
author() - Element in annotation interface com.botwithus.bot.api.ScriptManifest: The author of the script.
autoKey(int, int) - Static method in record class com.botwithus.bot.api.draw.DrawCommand.ComponentTarget: The key a component highlight gets when the caller names none: comp:<iface>:<comp>, for example comp:1473:5.
autoKey(int, int, int) - Static method in record class com.botwithus.bot.api.draw.DrawCommand.Tile: The key a tile highlight gets when the caller names none: tile:<x>:<y>:<plane>, for example tile:3200:3200:0.
autoKey(int, int, int, int, int) - Static method in record class com.botwithus.bot.api.draw.DrawCommand.Area: The key an area highlight gets when the caller names none: area:<x>:<y>:<w>:<h>:<plane>.
autoKey(EntityRef, int) - Static method in record class com.botwithus.bot.api.draw.DrawCommand.Entity: The key an entity highlight gets when the caller names none: npc:<index>, player:<index>, or bare self.
AUTOMATION - Enum constant in enum class com.botwithus.bot.api.script.LaunchedClient.Origin

B

backend() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns the value of the backend record component.
backendPresents() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns the value of the backendPresents record component.
backpack() - Method in interface com.botwithus.bot.api.GameAPI: Backpack facade.
Backpack - Class in com.botwithus.bot.api.inventory: The local player's backpack (inv id 93, slot grid at iface 1473 comp 5).
Backpack(GameAPI) - Constructor for class com.botwithus.bot.api.inventory.Backpack
BACKPACK - Enum constant in enum class com.botwithus.bot.api.inventory.Bank.SideView
BACKPACK - Static variable in class com.botwithus.bot.api.constants.InterfaceIds
BACKPACK - Static variable in class com.botwithus.bot.api.constants.InventoryIds
BACKPACK - Static variable in class com.botwithus.bot.api.util.Interfaces
BACKPACK_COMPONENT - Static variable in class com.botwithus.bot.api.inventory.Bank: Backpack items shown inside the bank interface (BANK__INVENTORY_CLICK).
backspace(int) - Method in class com.botwithus.bot.api.input.InputDialog: Press Backspace n times, one per tick, in one batch.
BACKSPACE - Static variable in record class com.botwithus.bot.api.input.KeyStroke: Deletes the character before the caret.
bank() - Method in interface com.botwithus.bot.api.GameAPI: Bank facade.
Bank - Class in com.botwithus.bot.api.inventory: The bank inventory (inv id 95).
Bank(GameAPI) - Constructor for class com.botwithus.bot.api.inventory.Bank
BANK - Static variable in class com.botwithus.bot.api.constants.InterfaceIds
BANK - Static variable in class com.botwithus.bot.api.constants.InventoryIds
BANK - Static variable in class com.botwithus.bot.api.util.Interfaces
Bank.BankSetting - Enum Class in com.botwithus.bot.api.inventory: Bank interface mode — standard transfer controls or preset selector.
Bank.SideView - Enum Class in com.botwithus.bot.api.inventory: Side panel view alongside the bank grid.
Bank.TransferAmount - Enum Class in com.botwithus.bot.api.inventory: Bank transfer quantity, with its BANK_CUSTOMOP varbit value and its op on the item-slot menus.
Bank.WithdrawMode - Enum Class in com.botwithus.bot.api.inventory: Bank withdraw mode: as item or as bank note.
BAS - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Base animation sets.
baseId() - Method in record class com.botwithus.bot.api.snapshot.Location: The id the server sent for this row — what identity, hardcoded id sets and interaction are keyed on.
BLACK - Static variable in class com.botwithus.bot.api.draw.Colors
BLUE - Static variable in class com.botwithus.bot.api.draw.Colors
BODY - Enum constant in enum class com.botwithus.bot.api.inventory.Equipment.Slot
boolField(String, String, boolean) - Static method in interface com.botwithus.bot.api.config.ConfigField
BoolField(String, String, boolean) - Constructor for record class com.botwithus.bot.api.config.ConfigField.BoolField: Creates an instance of a BoolField record class.
boostedLevel() - Method in record class com.botwithus.bot.api.model.PlayerStat: Returns the value of the boostedLevel record component.
boostedLevel() - Method in record class com.botwithus.bot.api.snapshot.Skill: Returns the value of the boostedLevel record component.
BotLogger - Interface in com.botwithus.bot.api.log: Simple logging interface for bot scripts and framework components.
BotScript - Interface in com.botwithus.bot.api: Service Provider Interface for bot scripts.
BOX - Enum constant in enum class com.botwithus.bot.api.component.ComponentType
BreakEndedEvent - Record Class in com.botwithus.bot.api.event: Fired when a break countdown completes and the bot resumes.
BreakEndedEvent() - Constructor for record class com.botwithus.bot.api.event.BreakEndedEvent
BreakEndedEvent(long) - Constructor for record class com.botwithus.bot.api.event.BreakEndedEvent: Creates an instance of a BreakEndedEvent record class.
BreakStartedEvent - Record Class in com.botwithus.bot.api.event: Fired when a break begins (logout triggered by fatigue/risk or manual schedule).
BreakStartedEvent(int, double, double) - Constructor for record class com.botwithus.bot.api.event.BreakStartedEvent
BreakStartedEvent(int, double, double, long) - Constructor for record class com.botwithus.bot.api.event.BreakStartedEvent: Creates an instance of a BreakStartedEvent record class.
build() - Method in class com.botwithus.bot.api.draw.DrawBuilder: The command as configured, without sending it.
build() - Method in class com.botwithus.bot.api.draw.DrawCaptionBuilder: The command as configured, without sending it.
build() - Method in class com.botwithus.bot.api.draw.HighlightBuilder: The highlight as configured, without sending it.
build() - Method in class com.botwithus.bot.api.model.WorldPathConfig.Builder
builder() - Static method in record class com.botwithus.bot.api.model.WorldPathConfig
BUTTON - Enum constant in enum class com.botwithus.bot.api.component.ComponentType
byInvId(int) - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Inventories
byServerIndex(int) - Method in class com.botwithus.bot.api.entities.Players
byServerIndex(int) - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Npcs
byServerIndex(int) - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Players

C

cancel() - Method in class com.botwithus.bot.api.input.InputDialog: Press Escape, closing the dialog.
cancel(String) - Method in interface com.botwithus.bot.api.script.ScriptScheduler: Cancels a scheduled or repeating script.
cancelAll() - Method in interface com.botwithus.bot.api.script.ScriptScheduler: Cancels all scheduled and repeating scripts.
cancelAllSchedules() - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Cancels every schedule on every connected client.
cancelAllSchedulesOnGroup(String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Cancels every schedule on every client in a group; one result per cancellation.
CANCELLED - Enum constant in enum class com.botwithus.bot.api.model.WalkResult: The walk was cancelled (by another action or explicit cancel).
cancelSchedule(String, String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Cancels a single schedule on the named client.
cancelWalk() - Method in interface com.botwithus.bot.api.Navigation: Cancels the walk this script started.
capacity() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns the value of the capacity record component.
CAPE - Enum constant in enum class com.botwithus.bot.api.inventory.Equipment.Slot
caption() - Method in class com.botwithus.bot.api.draw.DrawCaptionBuilder: The caption as configured.
caption() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Area: Returns the value of the caption record component.
caption() - Method in record class com.botwithus.bot.api.draw.DrawCommand.ComponentTarget: Returns the value of the caption record component.
caption() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Entity: Returns the value of the caption record component.
caption() - Method in interface com.botwithus.bot.api.draw.DrawCommand.Highlight: The words drawn against the resolved marker, or DrawCaption.NONE.
caption() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Text: Returns the value of the caption record component.
caption() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Tile: Returns the value of the caption record component.
caption() - Method in class com.botwithus.bot.api.draw.HighlightBuilder: The caption as configured.
CaptionCommandFactory - Interface in com.botwithus.bot.api.draw: Turns a space, a style and a caption into a concrete DrawCommand.
category() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the category record component.
category() - Method in record class com.botwithus.bot.api.model.ItemType: Returns the value of the category record component.
category() - Method in record class com.botwithus.bot.api.model.QuestType: Returns the value of the category record component.
category() - Method in record class com.botwithus.bot.api.model.WorldMapElement: Returns the value of the category record component.
category() - Method in record class com.botwithus.bot.api.script.ScriptInfo: Returns the value of the category record component.
category() - Element in annotation interface com.botwithus.bot.api.ScriptManifest: The category this script belongs to.
CATEGORY - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Item/equipment categories.
cause() - Method in record class com.botwithus.bot.api.event.ConnectionLostEvent: Returns the value of the cause record component.
cause() - Method in record class com.botwithus.bot.api.event.ScriptLoadFailedEvent: Returns the value of the cause record component.
cause() - Method in record class com.botwithus.bot.api.runtime.LastCrash: Returns the value of the cause record component.
cause() - Method in record class com.botwithus.bot.api.runtime.ReconnectState.Disconnected: Returns the value of the cause record component.
chance(double) - Static method in class com.botwithus.bot.api.util.Humanize: Returns true with the given probability.
changeLoginState(int, int) - Method in interface com.botwithus.bot.api.GameAPI: Requests a login state transition.
channel() - Method in record class com.botwithus.bot.api.isc.ScriptMessage: Returns the value of the channel record component.
character(char) - Static method in record class com.botwithus.bot.api.input.KeyStroke: A character event typing c: (-1, c).
characterIndex() - Method in record class com.botwithus.bot.api.script.LaunchedClient: Returns the value of the characterIndex record component.
characterIndex() - Method in record class com.botwithus.bot.api.script.LaunchOptions: Returns the value of the characterIndex record component.
CHAT_BOX - Static variable in class com.botwithus.bot.api.constants.InterfaceIds
CHAT_BOX - Static variable in class com.botwithus.bot.api.util.Interfaces
ChatMessage - Record Class in com.botwithus.bot.api.model: A message from the game chat history.
ChatMessage(int, int, String, String) - Constructor for record class com.botwithus.bot.api.model.ChatMessage: Creates an instance of a ChatMessage record class.
ChatMessageEvent - Record Class in com.botwithus.bot.api.event: Event fired when a chat message is received in the game.
ChatMessageEvent(ChatMessage) - Constructor for record class com.botwithus.bot.api.event.ChatMessageEvent
ChatMessageEvent(ChatMessage, long) - Constructor for record class com.botwithus.bot.api.event.ChatMessageEvent: Creates an instance of a ChatMessageEvent record class.
children() - Method in class com.botwithus.bot.api.component.ComponentNode: Direct children.
choiceField(String, String, List, String) - Static method in interface com.botwithus.bot.api.config.ConfigField
ChoiceField(String, String, List, String) - Constructor for record class com.botwithus.bot.api.config.ConfigField.ChoiceField: Creates an instance of a ChoiceField record class.
choices() - Method in record class com.botwithus.bot.api.config.ConfigField.ChoiceField: Returns the value of the choices record component.
CHUNK_MAX_LOCAL - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion: Highest local coordinate inside a chunk — the pivot the rotation math reflects around, as in CHUNK_MAX_LOCAL - localX.
CHUNK_SHIFT - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion: tileX >> CHUNK_SHIFT is the chunk X containing that tile.
CHUNK_TILE_MASK - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion: tileX & CHUNK_TILE_MASK is the tile's position within its chunk.
CHUNK_TILES - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion: Tiles along one edge of a chunk.
chunkAt(int) - Method in interface com.botwithus.bot.api.snapshot.DynamicRegion: The raw packed descriptor at flat index index.
chunkCount() - Method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Number of descriptors actually published, 0 when static or truncated.
chunkDescriptorAt(int, int, int) - Method in interface com.botwithus.bot.api.snapshot.DynamicRegion: The raw packed descriptor covering world tile (tileX, tileY) on plane, or DynamicRegion.NO_CHUNK if that tile has no source chunk.
className() - Method in record class com.botwithus.bot.api.script.ScriptInfo: Returns the value of the className record component.
cleanup() - Method in interface com.botwithus.bot.api.Navigation: Cancels this script's active walk and waits for its walker to stop.
clear() - Method in class com.botwithus.bot.api.input.InputDialog: Delete everything typed so far: one Backspace per character of InputDialog.text(), so it takes that many ticks.
clear() - Method in interface com.botwithus.bot.api.isc.SharedState: Removes all stored key-value pairs.
clear(String...) - Method in class com.botwithus.bot.api.draw.Draw: Remove the named commands, answering how many went.
clear(List) - Method in class com.botwithus.bot.api.draw.Draw: Remove the named commands, answering how many went.
clearActionQueue() - Method in interface com.botwithus.bot.api.domain.ActionAPI: Clears all pending actions from the queue.
clearAll() - Method in class com.botwithus.bot.api.draw.Draw: Remove everything this connection drew, answering how many went.
clearDefinitionCache() - Method in class com.botwithus.bot.api.entities.GroundItems
clearDefinitionCache() - Method in class com.botwithus.bot.api.entities.Npcs: Drop the definition cache.
clearDefinitionCache() - Method in class com.botwithus.bot.api.entities.SceneObjects
clearDefinitionCache() - Method in class com.botwithus.bot.api.inventory.InventoryContainer: Drop the ItemType cache.
clearRegionCache() - Method in interface com.botwithus.bot.api.domain.NavigationAPI: Invalidates all cached region collision data.
clearRegionCache() - Method in interface com.botwithus.bot.api.Navigation: Invalidates all cached region collision data.
clickable() - Method in record class com.botwithus.bot.api.model.NpcType: Returns the value of the clickable record component.
client() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ClientStarted: Returns the value of the client record component.
Client - Interface in com.botwithus.bot.api: Represents a single connected game client with its associated API and event bus.
CLIENT_NOT_FOUND - Static variable in exception class com.botwithus.bot.api.script.LauncherException: No client has that id.
clientAlive() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScriptStatusEntry: Returns the value of the clientAlive record component.
ClientExited(String, long, LauncherEvent.ExitReason) - Constructor for record class com.botwithus.bot.api.script.LauncherEvent.ClientExited: Creates an instance of a ClientExited record class.
clientId() - Method in record class com.botwithus.bot.api.script.LaunchedClient: Returns the value of the clientId record component.
clientId() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ClientExited: Returns the value of the clientId record component.
clientId() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ClientStateChanged: Returns the value of the clientId record component.
clientId() - Method in record class com.botwithus.bot.api.script.LauncherEvent.LicenceChanged: Returns the value of the clientId record component.
clientId() - Method in interface com.botwithus.bot.api.script.LaunchHandle
clientLauncher() - Method in interface com.botwithus.bot.api.script.ManagementContext: Returns the launcher for starting, stopping and watching clients through the BotWithUs launcher service, limited to this script's targets.
ClientLauncher - Interface in com.botwithus.bot.api.script: Launches, stops and watches game clients through the BotWithUs launcher's background service.
clientName() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.OpResult: Returns the value of the clientName record component.
clientName() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScheduledScriptEntry: Returns the value of the clientName record component.
clientName() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScheduleOpResult: Returns the value of the clientName record component.
clientName() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScriptStatusEntry: Returns the value of the clientName record component.
clientOpened() - Method in record class com.botwithus.bot.api.snapshot.OpenInterface: Returns the value of the clientOpened record component.
ClientOrchestrator - Interface in com.botwithus.bot.api.script: Cross-client script lifecycle and group management.
ClientOrchestrator.OpResult - Record Class in com.botwithus.bot.api.script: Result of a script operation on a specific client.
ClientOrchestrator.ScheduledScriptEntry - Record Class in com.botwithus.bot.api.script: A single active schedule pinned to a specific client.
ClientOrchestrator.ScheduleOpResult - Record Class in com.botwithus.bot.api.script: Result of a schedule operation.
ClientOrchestrator.ScriptStatusEntry - Record Class in com.botwithus.bot.api.script: Snapshot of a script's state on a specific client.
ClientProvider - Interface in com.botwithus.bot.api: Provides access to all connected game clients.
clients() - Method in interface com.botwithus.bot.api.script.ClientLauncher: The clients the service manages that this script may see.
ClientScript(String, String) - Constructor for record class com.botwithus.bot.api.script.ManagementTarget.ClientScript: Creates an instance of a ClientScript record class.
ClientStarted(LaunchedClient) - Constructor for record class com.botwithus.bot.api.script.LauncherEvent.ClientStarted: Creates an instance of a ClientStarted record class.
ClientStateChanged(String, LaunchedClient.State, Optional, Optional, Optional) - Constructor for record class com.botwithus.bot.api.script.LauncherEvent.ClientStateChanged: Creates an instance of a ClientStateChanged record class.
climboverCost() - Method in record class com.botwithus.bot.api.model.WorldPathConfig: Returns the value of the climboverCost record component.
climboverCost(float) - Method in class com.botwithus.bot.api.model.WorldPathConfig.Builder
close() - Method in class com.botwithus.bot.api.draw.DrawFrame: Flush.
close() - Method in interface com.botwithus.bot.api.gameval.GamevalIndex: Releases any resources held.
close() - Method in class com.botwithus.bot.api.inventory.Bank: Click the bank's close (X) button.
close() - Method in interface com.botwithus.bot.api.ui.ScriptUiHost: Closes the script's pop-out window and returns the UI to the host's drawer, as the host's title-bar X does.
closeClients() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ServiceShuttingDown: Returns the value of the closeClients record component.
closed() - Method in class com.botwithus.bot.api.draw.DrawBuilder: Close a polyline back to its first point.
CLOSED - Enum constant in enum class com.botwithus.bot.api.input.InputMode: No input dialog is open.
code() - Method in enum class com.botwithus.bot.api.component.ComponentType: The stable wire code the producer emits for this category.
code() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ClientStateChanged: Returns the value of the code record component.
code() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ServiceLost: Returns the value of the code record component.
code() - Method in exception class com.botwithus.bot.api.script.LauncherException
code() - Method in record class com.botwithus.bot.api.script.LaunchOutcome.Failed: Returns the value of the code record component.
CODE_BACKSPACE - Static variable in record class com.botwithus.bot.api.input.KeyStroke: Jagex key code for Backspace.
CODE_ENTER - Static variable in record class com.botwithus.bot.api.input.KeyStroke: Jagex key code for Enter.
CODE_ESCAPE - Static variable in record class com.botwithus.bot.api.input.KeyStroke: Jagex key code for Escape.
COLLECT_INTERFACE_ID - Static variable in class com.botwithus.bot.api.util.GrandExchange: Collect-all panel interface id.
collectAll() - Method in class com.botwithus.bot.api.util.GrandExchange: Click "Collect to inventory" on the collect-all panel.
collectToBank() - Method in class com.botwithus.bot.api.util.GrandExchange: Click "Collect to bank" on the collect-all panel.
color() - Method in record class com.botwithus.bot.api.draw.DrawEntry: Returns the value of the color record component.
color() - Method in record class com.botwithus.bot.api.draw.DrawStyle: Returns the value of the color record component.
color(int) - Method in class com.botwithus.bot.api.draw.DrawBuilder: Packed 0xAARRGGBB.
color(int) - Method in class com.botwithus.bot.api.draw.DrawCaptionBuilder: Packed 0xAARRGGBB.
color(int) - Method in class com.botwithus.bot.api.draw.HighlightBuilder: Packed 0xAARRGGBB.
Colors - Class in com.botwithus.bot.api.draw: Packed 0xAARRGGBB colours for debug drawing, and the two helpers for building one.
com.botwithus.bot.api - package com.botwithus.bot.api: Core API interfaces for the BotWithUs scripting framework.
com.botwithus.bot.api.component - package com.botwithus.bot.api.component: Scripter-facing API for querying interface components.
com.botwithus.bot.api.config - package com.botwithus.bot.api.config: Script configuration framework for persistent, user-editable settings.
com.botwithus.bot.api.constants - package com.botwithus.bot.api.constants: Constant definitions for game object, item, and NPC identifiers.
com.botwithus.bot.api.debug - package com.botwithus.bot.api.debug
com.botwithus.bot.api.diag - package com.botwithus.bot.api.diag
com.botwithus.bot.api.dialog - package com.botwithus.bot.api.dialog: Reading and selecting RS3 dialog options.
com.botwithus.bot.api.domain - package com.botwithus.bot.api.domain: Domain-specific sub-interfaces of GameAPI.
com.botwithus.bot.api.draw - package com.botwithus.bot.api.draw: Debug drawing — retained overlay commands the producer renders over the client.
com.botwithus.bot.api.entities - package com.botwithus.bot.api.entities: Rich entity wrappers and fluent query builders.
com.botwithus.bot.api.event - package com.botwithus.bot.api.event: Event bus infrastructure and game event types.
com.botwithus.bot.api.gameval - package com.botwithus.bot.api.gameval
com.botwithus.bot.api.input - package com.botwithus.bot.api.input: Typing into the game through component key triggers.
com.botwithus.bot.api.inventory - package com.botwithus.bot.api.inventory: Inventory facades and the constants needed to build raw component actions.
com.botwithus.bot.api.isc - package com.botwithus.bot.api.isc: Inter-script communication facilities.
com.botwithus.bot.api.log - package com.botwithus.bot.api.log: Logging interfaces for script output and diagnostics.
com.botwithus.bot.api.model - package com.botwithus.bot.api.model: Data transfer records representing game state.
com.botwithus.bot.api.runtime - package com.botwithus.bot.api.runtime
com.botwithus.bot.api.script - package com.botwithus.bot.api.script: Script lifecycle management and orchestration.
com.botwithus.bot.api.snapshot - package com.botwithus.bot.api.snapshot: Tick-scoped read API backed by the producer's shared-memory snapshot.
com.botwithus.bot.api.ui - package com.botwithus.bot.api.ui: Script UI interface for rendering custom user interfaces.
com.botwithus.bot.api.util - package com.botwithus.bot.api.util: General-purpose utility classes for script development.
COMBAT - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
COMBAT - Static variable in class com.botwithus.bot.api.util.Interfaces
COMBAT_TARGET - Static variable in class com.botwithus.bot.api.constants.InterfaceIds
combatLevel() - Method in class com.botwithus.bot.api.entities.Npc
combatLevel() - Method in class com.botwithus.bot.api.entities.Player
combatLevel() - Method in record class com.botwithus.bot.api.model.NpcType: Returns the value of the combatLevel record component.
combatLevel() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Returns the value of the combatLevel record component.
combatLevel() - Method in record class com.botwithus.bot.api.snapshot.Player: Returns the value of the combatLevel record component.
combatLevelBetween(int, int) - Static method in interface com.botwithus.bot.api.snapshot.PlayerFilter
combinedSection() - Static method in interface com.botwithus.bot.api.snapshot.LocationFilter
COMBO - Enum constant in enum class com.botwithus.bot.api.component.ComponentType
COMP_ON_PLAYER - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
compass() - Method in record class com.botwithus.bot.api.snapshot.Orientation: The nearest of the eight compass points; empty when unknown.
compId() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the compId record component.
component() - Method in record class com.botwithus.bot.api.model.ComponentTreeNode: Returns the value of the component record component.
component(int, int) - Method in interface com.botwithus.bot.api.draw.DrawTarget: Highlight an interface component under the conventional auto key comp:<iface>:<comp>.
component(String) - Method in interface com.botwithus.bot.api.gameval.GamevalIndex: Splits a GamevalType.COMPONENT name into the interface and component ids it packs, e.g.
component(String, int, int) - Method in interface com.botwithus.bot.api.draw.DrawTarget: Highlight an interface component under a key you choose.
Component - Record Class in com.botwithus.bot.api.model: Snapshot of an interface component at the moment the producer answered an RPC.
Component(int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, String, int, int, int, int, List) - Constructor for record class com.botwithus.bot.api.model.Component: Creates an instance of a Component record class.
COMPONENT - Enum constant in enum class com.botwithus.bot.api.draw.DrawKind: An interface component, named by (interfaceId, componentId) and carrying no geometry: the producer re-resolves the on-screen rect on the game thread once per tick, because the client recomputes a component's rect on every layout pass.
COMPONENT - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Interface components.
COMPONENT - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
COMPONENT_DRAG - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
COMPONENT_ID - Static variable in class com.botwithus.bot.api.inventory.Backpack
COMPONENT_ID - Static variable in class com.botwithus.bot.api.inventory.Bank: Banked-items slot grid (BANK__BANK_INV).
COMPONENT_ID - Static variable in class com.botwithus.bot.api.inventory.Equipment
COMPONENT_ID_MASK - Static variable in interface com.botwithus.bot.api.gameval.GamevalIndex: Mask selecting the component-id half of a packed component id.
COMPONENT_KEY - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
COMPONENT_SPECIAL - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
COMPONENT_TRIGGER - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
componentHash(int, int) - Static method in class com.botwithus.bot.api.util.Interfaces: Packs into the format used by the game client for component addressing.
componentId() - Method in class com.botwithus.bot.api.component.ComponentNode
componentId() - Method in record class com.botwithus.bot.api.dialog.DialogOption: The component id the server expects for this option (the row, not the label).
componentId() - Method in record class com.botwithus.bot.api.draw.DrawCommand.ComponentTarget: Returns the value of the componentId record component.
componentId() - Method in record class com.botwithus.bot.api.event.RadioGroupSelectEvent: Returns the value of the componentId record component.
componentId() - Method in class com.botwithus.bot.api.inventory.InventoryContainer
componentId() - Method in record class com.botwithus.bot.api.model.ComponentRef: Returns the value of the componentId record component.
componentIdFromHash(int) - Static method in class com.botwithus.bot.api.util.Interfaces
ComponentNode - Class in com.botwithus.bot.api.component: Rich wrapper around a Component record plus its position in a materialized ComponentTree.
ComponentQuery - Class in com.botwithus.bot.api.component: Fluent, RPC-backed query over an interface subtree.
ComponentRef - Record Class in com.botwithus.bot.api.model: Identifies a component by its owning interface and component id within that interface.
ComponentRef(int, int) - Constructor for record class com.botwithus.bot.api.model.ComponentRef: Creates an instance of a ComponentRef record class.
components() - Method in interface com.botwithus.bot.api.GameAPI: Interface-component query facade — the high-level, fluent entry point for inspecting interface components (parallel to GameAPI.npcs() / GameAPI.mapElements()).
Components - Class in com.botwithus.bot.api.component: Interface-component query facade.
Components(GameAPI) - Constructor for class com.botwithus.bot.api.component.Components
ComponentTarget(String, DrawSpace, DrawStyle, int, int, DrawCaption) - Constructor for record class com.botwithus.bot.api.draw.DrawCommand.ComponentTarget: Creates an instance of a ComponentTarget record class.
ComponentTree - Class in com.botwithus.bot.api.component: An immutable, materialized interface subtree fetched in a single get_interface_tree round-trip.
ComponentTreeNode - Record Class in com.botwithus.bot.api.model: One node of a flattened interface subtree returned by GameAPI.getInterfaceTree(int, int) — the raw decode of a single get_interface_tree entry.
ComponentTreeNode(Component, int) - Constructor for record class com.botwithus.bot.api.model.ComponentTreeNode: Creates an instance of a ComponentTreeNode record class.
componentTrigger(int, int, int, int, int) - Static method in record class com.botwithus.bot.api.model.GameAction: A ActionTypes.COMPONENT_TRIGGER action: fire the CS2 event trigger of type triggerType on a component.
ComponentTrigger - Record Class in com.botwithus.bot.api.model: One CS2 event trigger bound to an interface Component — the discovery side of trigger firing.
ComponentTrigger(int, int) - Constructor for record class com.botwithus.bot.api.model.ComponentTrigger: Creates an instance of a ComponentTrigger record class.
ComponentType - Enum Class in com.botwithus.bot.api.component: Stable, build-independent semantic category of an interface component.
ConfigField - Interface in com.botwithus.bot.api.config: Describes a single configurable parameter that a script exposes.
ConfigField.BoolField - Record Class in com.botwithus.bot.api.config: A boolean-valued field rendered as a checkbox.
ConfigField.ChoiceField - Record Class in com.botwithus.bot.api.config: A field whose value is one of an enumerated set of choices.
ConfigField.IntField - Record Class in com.botwithus.bot.api.config: An integer-valued field.
ConfigField.ItemIdField - Record Class in com.botwithus.bot.api.config: An integer-valued field representing an item id.
ConfigField.StringField - Record Class in com.botwithus.bot.api.config: A free-text string-valued field.
configFor(String) - Method in interface com.botwithus.bot.api.script.ManagementContext: Returns this script's settings as they apply to the client on account accountUuid.
configFor(String, String) - Method in interface com.botwithus.bot.api.script.ManagementContext: Returns this script's settings as they apply to the script named scriptName on the client on account accountUuid: the same order as ManagementContext.configFor(String), with only that script's own values in the first place.
Connected(long) - Constructor for record class com.botwithus.bot.api.runtime.ReconnectState.Connected: Creates an instance of a Connected record class.
ConnectionLostEvent - Record Class in com.botwithus.bot.api.event: Fired when the underlying pipe transport drops mid-session.
ConnectionLostEvent(String, Throwable) - Constructor for record class com.botwithus.bot.api.event.ConnectionLostEvent
ConnectionLostEvent(String, Throwable, long) - Constructor for record class com.botwithus.bot.api.event.ConnectionLostEvent: Creates an instance of a ConnectionLostEvent record class.
connectionName() - Method in record class com.botwithus.bot.api.event.ConnectionLostEvent: Returns the value of the connectionName record component.
connectionName() - Method in record class com.botwithus.bot.api.event.ReconnectStateChangedEvent: Returns the value of the connectionName record component.
connectionName() - Method in record class com.botwithus.bot.api.event.ScriptCrashedEvent: Returns the value of the connectionName record component.
connectionName() - Method in record class com.botwithus.bot.api.script.LaunchOutcome.Attached: Returns the value of the connectionName record component.
CONSTITUTION - Static variable in class com.botwithus.bot.api.util.Skills
CONSTRUCTION - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
CONSTRUCTION - Static variable in class com.botwithus.bot.api.util.Skills
containingText(String) - Method in class com.botwithus.bot.api.component.ComponentQuery: Filter by label substring (case-insensitive).
contains(int) - Method in class com.botwithus.bot.api.inventory.InventoryContainer
contains(int, int) - Method in class com.botwithus.bot.api.inventory.InventoryContainer: True when the total quantity of itemId is at least amount.
contains(String) - Method in class com.botwithus.bot.api.inventory.InventoryContainer: Containment by name (case-insensitive substring match against ItemType.name).
containsAll(int...) - Method in class com.botwithus.bot.api.inventory.InventoryContainer
containsAny(int...) - Method in class com.botwithus.bot.api.inventory.InventoryContainer
containsGameval(String) - Method in class com.botwithus.bot.api.inventory.InventoryContainer: Containment by gameval name, e.g.
containsKey(String) - Method in interface com.botwithus.bot.api.isc.SharedState: Checks whether a value is stored under the given key.
continueChat(GameAPI) - Static method in class com.botwithus.bot.api.dialog.Dialog: Advances a text-only NPC-chat page (interface 1184) by driving its continue / next button (component 15) with the DIALOGUE action.
COOKING - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
COOKING - Static variable in class com.botwithus.bot.api.util.Skills
COOKING_FIRE - Static variable in class com.botwithus.bot.api.constants.AnimationIds
copyOf(DynamicRegion) - Static method in interface com.botwithus.bot.api.snapshot.DynamicRegion: A heap copy of source, safe to retain across ticks.
copyOfStable(GameSnapshot) - Static method in interface com.botwithus.bot.api.snapshot.DynamicRegion: DynamicRegion.copyOf(DynamicRegion) with the torn-read check built in: copies the grid, re-reads GameSnapshot.publishSeq(), and retries if the producer republished while the copy was in flight.
count() - Method in class com.botwithus.bot.api.component.ComponentQuery
count() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns the value of the count record component.
count() - Method in class com.botwithus.bot.api.entities.EntityQuery
count() - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
count() - Method in record class com.botwithus.bot.api.script.LauncherEvent.EventsDropped: Returns the value of the count record component.
count() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.GroundItems
count() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Inventories
count() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Locations
count() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Npcs
count() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Players
count() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Projectiles
count(int) - Method in class com.botwithus.bot.api.inventory.InventoryContainer
count(String) - Method in class com.botwithus.bot.api.inventory.InventoryContainer: Total quantity of items whose name matches (case-insensitive contains).
countGameval(String) - Method in class com.botwithus.bot.api.inventory.InventoryContainer: Total quantity of the item with the given gameval name.
CRAFTING - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
CRAFTING - Static variable in class com.botwithus.bot.api.constants.AnimationIds
CRAFTING - Static variable in class com.botwithus.bot.api.util.Skills
crash() - Method in record class com.botwithus.bot.api.event.ScriptCrashedEvent: Returns the value of the crash record component.
create(DrawSpace, DrawStyle) - Method in interface com.botwithus.bot.api.draw.DrawCommandFactory: Build the command this factory was created for.
create(DrawSpace, DrawStyle, DrawCaption) - Method in interface com.botwithus.bot.api.draw.CaptionCommandFactory: Build the command this factory was created for.
create(DrawStyle, DrawCaption) - Method in interface com.botwithus.bot.api.draw.HighlightFactory: Build the highlight this factory was created for.
createGroup(String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Creates a group with no description.
createGroup(String, String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Creates a group.
CRM_VIEW - Enum constant in enum class com.botwithus.bot.api.component.ComponentType
ctrl() - Method in record class com.botwithus.bot.api.event.KeyInputEvent: Returns the value of the ctrl record component.
CURRENT - Enum constant in enum class com.botwithus.bot.api.script.LauncherEvent.DataPhase
currentHealth() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Returns the value of the currentHealth record component.
currentStep() - Method in record class com.botwithus.bot.api.model.WalkStatus: Returns the value of the currentStep record component.
CURSOR - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Mouse cursors.
CUSTOM - Enum constant in enum class com.botwithus.bot.api.inventory.Bank.TransferAmount
CUTSCENE - Enum constant in enum class com.botwithus.bot.api.component.ComponentType
CYAN - Static variable in class com.botwithus.bot.api.draw.Colors
cyclesRemaining(int) - Method in class com.botwithus.bot.api.entities.Projectile: Cycles remaining until impact, floored at 0.

D

data() - Method in class com.botwithus.bot.api.component.ComponentNode: The underlying raw record.
DataUpdateApplied(String) - Constructor for record class com.botwithus.bot.api.script.LauncherEvent.DataUpdateApplied: Creates an instance of a DataUpdateApplied record class.
DataUpdateAvailable(LauncherEvent.DataPhase, Optional, int, boolean) - Constructor for record class com.botwithus.bot.api.script.LauncherEvent.DataUpdateAvailable: Creates an instance of a DataUpdateAvailable record class.
DBROW - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Database rows.
DBTABLE - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Database tables.
debug(String, Object...) - Method in interface com.botwithus.bot.api.log.BotLogger
DEBUG - Enum constant in enum class com.botwithus.bot.api.log.LogLevel
decimals() - Method in record class com.botwithus.bot.api.draw.DrawCaption.FixedPoint: Returns the value of the decimals record component.
DEFAULT - Static variable in record class com.botwithus.bot.api.draw.DrawStyle: The style a builder starts from: opaque green, hairline, the producer's default TTL.
DEFAULT - Static variable in record class com.botwithus.bot.api.model.WorldPathConfig: Default config matching server defaults.
DEFAULT_FOOTPRINT_TILES - Static variable in class com.botwithus.bot.api.draw.DrawLimits: The footprint a highlighted entity or tile gets when the caller names none, in tiles.
DEFAULT_NOT_SET_CLIENTSIDE - Enum constant in enum class com.botwithus.bot.api.model.VarpState: The varp exists but the client holds no entry for it, so it is at its type default.
DEFAULT_TTL_MS - Static variable in class com.botwithus.bot.api.draw.DrawLimits: The TTL the producer applies when a command omits ttl_ms.
defaultAsString() - Method in interface com.botwithus.bot.api.config.ConfigField
defaults() - Static method in record class com.botwithus.bot.api.script.LaunchOptions
defaultVerified() - Method in record class com.botwithus.bot.api.model.VarbitRead: Returns the value of the defaultVerified record component.
defaultVerified() - Method in record class com.botwithus.bot.api.model.VarpRead: Returns the value of the defaultVerified record component.
DEFENCE - Static variable in class com.botwithus.bot.api.util.Skills
definitionCacheSize() - Method in class com.botwithus.bot.api.entities.GroundItems
definitionCacheSize() - Method in class com.botwithus.bot.api.entities.Npcs: Diagnostic — current size of the NpcType cache.
definitionCacheSize() - Method in class com.botwithus.bot.api.entities.SceneObjects
definitionCacheSize() - Method in class com.botwithus.bot.api.inventory.InventoryContainer: Diagnostic — number of cached ItemType definitions.
degrees() - Method in enum class com.botwithus.bot.api.snapshot.Direction: Compass bearing of this point, clockwise from north: 0, 45, ... 315.
degrees() - Method in record class com.botwithus.bot.api.snapshot.Orientation: Compass bearing in [0, 360), clockwise from north; empty when unknown.
delay(long, long, long, long) - Static method in class com.botwithus.bot.api.util.Humanize: Returns a gaussian-bounded delay in milliseconds, clamped to [min, max].
deleteGroup(String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Deletes a group.
delta() - Method in record class com.botwithus.bot.api.model.ActionEntry: Returns the value of the delta record component.
dependentQuestIds() - Method in record class com.botwithus.bot.api.model.QuestType: Returns the value of the dependentQuestIds record component.
deposit(int, Bank.TransferAmount) - Method in class com.botwithus.bot.api.inventory.Bank: Deposit one stack of itemId from the backpack-inside-bank panel.
depositAll() - Method in class com.botwithus.bot.api.inventory.Bank: Deposit carried backpack contents.
depositCoins() - Method in class com.botwithus.bot.api.inventory.Bank: Deposit coin pouch.
depositEquipment() - Method in class com.botwithus.bot.api.inventory.Bank: Deposit worn equipment.
depositEverything() - Method in class com.botwithus.bot.api.inventory.Bank: Deposit carried items + equipment + familiar + coins, in order.
depositFamiliar() - Method in class com.botwithus.bot.api.inventory.Bank: Deposit familiar inventory.
DESC_CHUNK_X_MASK - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion
DESC_CHUNK_X_SHIFT - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion
DESC_CHUNK_Y_MASK - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion
DESC_CHUNK_Y_SHIFT - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion
DESC_PLANE_MASK - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion
DESC_PLANE_SHIFT - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion
DESC_ROTATION_MASK - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion
DESC_ROTATION_SHIFT - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion
descChunkX(int) - Static method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Source chunk X, 0..1023.
descChunkY(int) - Static method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Source chunk Y, 0..2047.
descendants() - Method in class com.botwithus.bot.api.component.ComponentNode: All descendants, depth-first.
descPlane(int) - Static method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Source plane, 0..3.
description() - Method in record class com.botwithus.bot.api.model.WorldMapElement: Returns the value of the description record component.
description() - Method in record class com.botwithus.bot.api.script.ScriptInfo: Returns the value of the description record component.
description() - Element in annotation interface com.botwithus.bot.api.ScriptManifest: A brief description of what the script does.
DESCRIPTOR - Enum constant in enum class com.botwithus.bot.api.script.LauncherEvent.ExitReason: The agent refused its launch details.
descRotation(int) - Static method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Chunk rotation, 0..3 in 90-degree steps.
destroyScriptHandle(long) - Method in interface com.botwithus.bot.api.GameAPI: Releases a script handle.
Dialog - Class in com.botwithus.bot.api.dialog: Reads RS3 conversation dialogs: selects options on the multi-choice dialog (interface DIALOG_OPTIONS, 1188 — "select an option") and advances a text-only NPC-chat page (interface DIALOG_NPC, 1184).
DIALOG_NPC - Static variable in class com.botwithus.bot.api.constants.InterfaceIds
DIALOG_OPTIONS - Static variable in class com.botwithus.bot.api.constants.InterfaceIds
DIALOG_PLAYER - Static variable in class com.botwithus.bot.api.constants.InterfaceIds
DialogOption - Record Class in com.botwithus.bot.api.dialog: One selectable line of the multi-choice dialog (interface DIALOG_OPTIONS).
DialogOption(int, String, ComponentNode) - Constructor for record class com.botwithus.bot.api.dialog.DialogOption: Creates an instance of a DialogOption record class.
DIALOGUE - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
DIALOGUE - Static variable in class com.botwithus.bot.api.util.Interfaces
difficulty() - Method in record class com.botwithus.bot.api.model.QuestType: Returns the value of the difficulty record component.
direct() - Static method in interface com.botwithus.bot.api.snapshot.LocationFilter
Direction - Enum Class in com.botwithus.bot.api.snapshot: The eight compass points, in clockwise order starting at north.
Disconnected(long, Throwable) - Constructor for record class com.botwithus.bot.api.runtime.ReconnectState.Disconnected: Creates an instance of a Disconnected record class.
distanceTo(int, int) - Method in interface com.botwithus.bot.api.entities.EntityContext: Chebyshev (king-move) distance to another tile — same metric the game itself uses for "within range" checks on actions.
distanceTo(EntityContext) - Method in interface com.botwithus.bot.api.entities.EntityContext: Distance to another entity.
distanceToPlayer() - Method in class com.botwithus.bot.api.entities.Npc: Chebyshev distance to the local player tile, or MAX_VALUE if the player isn't loaded.
distanceToPlayer() - Method in class com.botwithus.bot.api.entities.Player: Chebyshev distance to the local player tile, or MAX_VALUE if the local player isn't loaded.
distanceToPlayer() - Method in class com.botwithus.bot.api.entities.SceneObject: Chebyshev distance to the local player tile, or MAX_VALUE if the player isn't loaded.
DIVIDER - Enum constant in enum class com.botwithus.bot.api.component.ComponentType
DIVINATION - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
DIVINATION - Static variable in class com.botwithus.bot.api.util.Skills
domainType() - Method in record class com.botwithus.bot.api.model.VarbitType: Returns the value of the domainType record component.
doorCost() - Method in record class com.botwithus.bot.api.model.WorldPathConfig: Returns the value of the doorCost record component.
doorCost(float) - Method in class com.botwithus.bot.api.model.WorldPathConfig.Builder
DOWNLOADING - Enum constant in enum class com.botwithus.bot.api.script.LauncherEvent.DataPhase
dragOnto(ComponentNode) - Method in class com.botwithus.bot.api.component.ComponentNode: Queue a drag of this component onto target, reproducing a manual drag-and-release so the client sends its component-drag packet.
draw() - Method in interface com.botwithus.bot.api.domain.DrawAPI: Debug-drawing facade.
Draw - Class in com.botwithus.bot.api.draw: Debug-drawing facade.
Draw(DrawAPI) - Constructor for class com.botwithus.bot.api.draw.Draw
DrawAPI - Interface in com.botwithus.bot.api.domain: Debug drawing: retained overlay commands the producer renders over the client.
DrawBatchResult - Record Class in com.botwithus.bot.api.draw: What a batched submit actually achieved.
DrawBatchResult(int, int, String) - Constructor for record class com.botwithus.bot.api.draw.DrawBatchResult: Creates an instance of a DrawBatchResult record class.
DrawBuilder - Class in com.botwithus.bot.api.draw: Fluent presentation chain for one draw command.
DrawCaption - Interface in com.botwithus.bot.api.draw: The words a captioned command draws, and the style to draw them in.
DrawCaption.FixedPoint - Record Class in com.botwithus.bot.api.draw: A fixed-point number the producer formats.
DrawCaption.Literal - Record Class in com.botwithus.bot.api.draw: Literal text.
DrawCaption.None - Record Class in com.botwithus.bot.api.draw: The absence of a caption.
DrawCaptionBuilder - Class in com.botwithus.bot.api.draw: Fluent chain for the two commands that draw words — a text command and a captioned component highlight.
drawClear(List) - Method in interface com.botwithus.bot.api.domain.DrawAPI: Remove the named commands (debug_draw_clear), answering how many went.
drawClearAll() - Method in interface com.botwithus.bot.api.domain.DrawAPI: Remove everything this connection drew (debug_draw_clear_all), answering how many went.
DrawCommand - Interface in com.botwithus.bot.api.draw: One fully-specified draw command, ready for the wire.
DrawCommand.Area - Record Class in com.botwithus.bot.api.draw: A highlight over a widthTiles by heightTiles block of ground, anchored at its minimum corner.
DrawCommand.ComponentTarget - Record Class in com.botwithus.bot.api.draw: A highlight that tracks an interface component rather than a rectangle.
DrawCommand.Ellipse - Record Class in com.botwithus.bot.api.draw: Ellipse inscribed in the given rectangle, stroked or filled.
DrawCommand.Entity - Record Class in com.botwithus.bot.api.draw: A highlight that tracks a live entity — an NPC, another player, or the local player.
DrawCommand.Highlight - Interface in com.botwithus.bot.api.draw: A command only a highlight_* call can carry, because what it marks is a thing rather than a place.
DrawCommand.Line - Record Class in com.botwithus.bot.api.draw: Straight segment from (x1, y1) to (x2, y2).
DrawCommand.Poly - Record Class in com.botwithus.bot.api.draw: Polyline over a flat [x, y, x, y, ...] list of 2 to 32 pairs.
DrawCommand.Primitive - Interface in com.botwithus.bot.api.draw: A command debug_draw_set carries: the caller names its kind and its space, and the producer stores the geometry as sent.
DrawCommand.Rect - Record Class in com.botwithus.bot.api.draw: Axis-aligned rectangle, stroked or filled per DrawStyle.isFilled().
DrawCommand.Text - Record Class in com.botwithus.bot.api.draw: A caption anchored at (x, y).
DrawCommand.Tile - Record Class in com.botwithus.bot.api.draw: A highlight over exactly one game tile, on a named plane.
DrawCommandFactory - Interface in com.botwithus.bot.api.draw: Turns a space and a style into a concrete DrawCommand.
DrawEntry - Record Class in com.botwithus.bot.api.draw: One retained draw command as the producer currently holds it.
DrawEntry(String, DrawKind, DrawSpace, int, int, int, boolean, boolean, List, boolean, List, long, String, DrawFont) - Constructor for record class com.botwithus.bot.api.draw.DrawEntry: Creates an instance of a DrawEntry record class.
DrawFont - Enum Class in com.botwithus.bot.api.draw: The text styles the producer can draw a caption in.
DrawFrame - Class in com.botwithus.bot.api.draw: A tick's worth of drawing, collapsed into as few round-trips as the wire allows.
drawHighlight(DrawCommand.Highlight) - Method in interface com.botwithus.bot.api.domain.DrawAPI: Set one highlight, answering the key it is stored under — one round-trip to highlight_entity, highlight_tile or highlight_area, chosen from the command's own variant.
drawHighlights(List) - Method in interface com.botwithus.bot.api.domain.DrawAPI: Set several highlights, answering the aggregate the way a batch does.
DrawKind - Enum Class in com.botwithus.bot.api.draw: The primitive shapes the producer's overlay can retain.
DrawLimits - Class in com.botwithus.bot.api.draw: The producer's hard limits on debug drawing, named once so no caller has to spell a bare number.
drawList() - Method in interface com.botwithus.bot.api.domain.DrawAPI: Every command this connection currently holds (debug_draw_list).
drawSet(DrawCommand.Primitive) - Method in interface com.botwithus.bot.api.domain.DrawAPI: Set one command (debug_draw_set), answering the key it is stored under.
drawSetBatch(List) - Method in interface com.botwithus.bot.api.domain.DrawAPI: Set many commands in one round-trip (debug_draw_set_batch).
drawsOwnChrome() - Method in interface com.botwithus.bot.api.ui.ScriptUI: True when the script draws its own window chrome: its background, and a close button that calls ScriptUiHost.close().
DrawSpace - Enum Class in com.botwithus.bot.api.draw: The coordinate space a draw command's geometry is expressed in.
drawStats() - Method in interface com.botwithus.bot.api.domain.DrawAPI: The producer's overlay counters and renderer health (debug_draw_stats).
DrawStats - Record Class in com.botwithus.bot.api.draw: The producer's own account of its overlay: how full the store is, what it has refused, and whether the renderer is alive.
DrawStats(int, int, int, int, int, int, int, long, long, long, boolean, boolean, long, boolean, long, String, int, int) - Constructor for record class com.botwithus.bot.api.draw.DrawStats: Creates an instance of a DrawStats record class.
DrawStyle - Record Class in com.botwithus.bot.api.draw: The presentation half of a draw command — everything that is not geometry.
DrawStyle(int, int, boolean, boolean, int, long) - Constructor for record class com.botwithus.bot.api.draw.DrawStyle: Creates an instance of a DrawStyle record class.
DrawTarget - Interface in com.botwithus.bot.api.draw: Somewhere a draw command can be sent — either straight down the wire (Draw) or into a batch (DrawFrame).
dropped() - Method in record class com.botwithus.bot.api.draw.DrawBatchResult: Returns the value of the dropped record component.
dropped() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns the value of the dropped record component.
DROPPED - Enum constant in enum class com.botwithus.bot.api.script.LaunchedClient.LicenceState: The licence lapsed or will; the client exits.
DUNGEONEERING - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
DUNGEONEERING - Static variable in class com.botwithus.bot.api.util.Skills
durationSeconds() - Method in record class com.botwithus.bot.api.event.BreakStartedEvent: Returns the value of the durationSeconds record component.
dynamicRegion() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: The scene's dynamic-region (instance) chunk-descriptor grid (v19+) — the table mapping each instance tile back to the static tile it was copied from.
DynamicRegion - Interface in com.botwithus.bot.api.snapshot: The scene's dynamic-region (instance) chunk-descriptor grid (v19+).

E

EAST - Enum constant in enum class com.botwithus.bot.api.snapshot.Direction
elementId() - Method in record class com.botwithus.bot.api.model.WorldMapElement: Returns the value of the elementId record component.
ellipse(String, int, int, int, int) - Method in interface com.botwithus.bot.api.draw.DrawTarget: Ellipse inscribed in the given rectangle.
Ellipse(String, DrawSpace, DrawStyle, int, int, int, int) - Constructor for record class com.botwithus.bot.api.draw.DrawCommand.Ellipse: Creates an instance of a Ellipse record class.
ELLIPSE - Enum constant in enum class com.botwithus.bot.api.draw.DrawKind: Axis-aligned ellipse inscribed in a rectangle, stroked or filled.
empty() - Static method in interface com.botwithus.bot.api.gameval.GamevalIndex: An index that resolves nothing — the fallback when none is deployed.
EMPTY - Static variable in record class com.botwithus.bot.api.draw.DrawBatchResult: The result of flushing nothing.
endCycle() - Method in class com.botwithus.bot.api.entities.Projectile: Game cycle it lands.
endCycle() - Method in record class com.botwithus.bot.api.snapshot.Projectile: Returns the value of the endCycle record component.
endTileX() - Method in class com.botwithus.bot.api.entities.Projectile: Absolute world tile X of the impact point.
endTileX() - Method in record class com.botwithus.bot.api.snapshot.Projectile: Returns the value of the endTileX record component.
endTileY() - Method in class com.botwithus.bot.api.entities.Projectile: Absolute world tile Y of the impact point.
endTileY() - Method in record class com.botwithus.bot.api.snapshot.Projectile: Returns the value of the endTileY record component.
ENTER - Static variable in record class com.botwithus.bot.api.input.KeyStroke: Submits an input field.
enterAmount(long) - Method in class com.botwithus.bot.api.input.InputDialog: Type amount and submit it.
enterAmount(String) - Method in class com.botwithus.bot.api.input.InputDialog: Type amount and submit it.
enterText(String) - Method in class com.botwithus.bot.api.input.InputDialog: Type text and submit it.
entity(String, EntityRef, int) - Method in interface com.botwithus.bot.api.draw.DrawTarget: Highlight an entity by list and server index — the general form the three named entity helpers funnel through, for a caller holding an index without a snapshot row to go with it.
entity(String, EntityRef, int, int, int) - Method in interface com.botwithus.bot.api.draw.DrawTarget: DrawTarget.entity(String, EntityRef, int) with a footprint in tiles.
Entity(String, DrawStyle, EntityRef, int, int, int, DrawCaption) - Constructor for record class com.botwithus.bot.api.draw.DrawCommand.Entity: Creates an instance of a Entity record class.
ENTITY - Enum constant in enum class com.botwithus.bot.api.draw.DrawKind: A tracked entity — an NPC, another player, or the local player — named by EntityRef plus a server index and carrying no coordinates: the producer re-reads the entity's live position every tick.
EntityContext - Interface in com.botwithus.bot.api.entities: Shared surface for everything an EntityQuery can reason about without consulting an entity-specific definition.
EntityQuery<T,Q> - Class in com.botwithus.bot.api.entities: Fluent query builder shared across entity types.
EntityRef - Enum Class in com.botwithus.bot.api.draw: Which list a highlighted entity's index belongs to.
entries() - Method in record class com.botwithus.bot.api.model.EnumType: Returns the value of the entries record component.
entryCount() - Method in record class com.botwithus.bot.api.model.EnumType: Returns the value of the entryCount record component.
ENUM - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Enums (id → value tables).
EnumType - Record Class in com.botwithus.bot.api.model: Enum (key-value mapping) definition from the game cache.
EnumType(int, int, int, int, String, int, Map) - Constructor for record class com.botwithus.bot.api.model.EnumType: Creates an instance of a EnumType record class.
equals(Object) - Method in record class com.botwithus.bot.api.config.ConfigField.BoolField: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.config.ConfigField.ChoiceField: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.config.ConfigField.IntField: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.config.ConfigField.ItemIdField: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.config.ConfigField.StringField: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.config.ScriptConfig: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.dialog.DialogOption: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.draw.DrawBatchResult: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.draw.DrawCaption.FixedPoint: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.draw.DrawCaption.Literal: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.draw.DrawCaption.None: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.draw.DrawCommand.Area: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.draw.DrawCommand.ComponentTarget: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.draw.DrawCommand.Ellipse: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.draw.DrawCommand.Entity: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.draw.DrawCommand.Line: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.draw.DrawCommand.Poly: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.draw.DrawCommand.Rect: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.draw.DrawCommand.Text: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.draw.DrawCommand.Tile: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.draw.DrawEntry: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.draw.DrawStats: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.draw.DrawStyle: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.ActionExecutedEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.BreakEndedEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.BreakStartedEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.ChatMessageEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.ConnectionLostEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.KeyInputEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.LoginStateChangeEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.ObjVarChangeEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.RadioGroupSelectEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.ReconnectStateChangedEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.ScriptCrashedEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.ScriptLoadFailedEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.SpotAnimEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.TickEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.VarbitChangeEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.VarcChangeEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.VarChangeEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.WalkArrivedEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.WalkCancelledEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.event.WalkFailedEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.gameval.GamevalEntry: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.gameval.GamevalRef: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.input.KeyStroke: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.isc.ScriptMessage: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.ActionEntry: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.ChatMessage: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.Component: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.ComponentRef: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.ComponentTreeNode: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.ComponentTrigger: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.EnumType: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.GameAction: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.GroundItemInfo: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.ItemType: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.LocationType: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.LoginState: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.NpcType: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.PathResult: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.PlayerStat: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.QuestType: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.ResourceItem: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.ResourceSection: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.SceneObjectInfo: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.ScriptResult: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.SequenceType: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.SkillRequirement: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.StructType: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.VarbitRead: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.VarbitType: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.VarbitValue: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.VarpRead: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.WalkStatus: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.WorldMapElement: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.WorldMapPlacement: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.model.WorldPathConfig: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.runtime.LastCrash: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.runtime.ReconnectState.Connected: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.runtime.ReconnectState.Disconnected: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.runtime.ReconnectState.GivingUp: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.runtime.ReconnectState.Reconnecting: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.runtime.ScriptHealth: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.OpResult: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScheduledScriptEntry: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScheduleOpResult: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScriptStatusEntry: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.LaunchedClient: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.LaunchedClient.LaunchedBy: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.LaunchedClient.Licence: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.LauncherAccount: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.LauncherEvent.AgentUpdated: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.LauncherEvent.ClientExited: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.LauncherEvent.ClientStarted: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.LauncherEvent.ClientStateChanged: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.LauncherEvent.DataUpdateApplied: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.LauncherEvent.DataUpdateAvailable: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.LauncherEvent.EventsDropped: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.LauncherEvent.LicenceChanged: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.LauncherEvent.ServiceLost: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.LauncherEvent.ServiceRestored: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.LauncherEvent.ServiceShuttingDown: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.LaunchOptions: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.LaunchOutcome.Attached: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.LaunchOutcome.AttachFailed: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.LaunchOutcome.Failed: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.ManagementTarget.ClientScript: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.ManagementTarget.Group: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.ManagementTarget.WholeHost: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.ScriptInfo: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.script.ScriptScheduler.ScheduledEntry: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.snapshot.GroundItem: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.snapshot.Inventory: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.snapshot.InventoryItem: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.snapshot.Location: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.snapshot.Npc: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.snapshot.OpenInterface: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.snapshot.Orientation: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.snapshot.Player: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.snapshot.Projectile: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.snapshot.Skill: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.botwithus.bot.api.snapshot.SourceTile: Indicates whether some other object is "equal to" this one.
equipment() - Method in interface com.botwithus.bot.api.GameAPI: Worn equipment facade.
Equipment - Class in com.botwithus.bot.api.inventory: The local player's worn equipment (inv id 94, equipment iface 1464).
Equipment(GameAPI) - Constructor for class com.botwithus.bot.api.inventory.Equipment
EQUIPMENT - Enum constant in enum class com.botwithus.bot.api.inventory.Bank.SideView
EQUIPMENT - Static variable in class com.botwithus.bot.api.constants.InterfaceIds
EQUIPMENT - Static variable in class com.botwithus.bot.api.constants.InventoryIds
EQUIPMENT - Static variable in class com.botwithus.bot.api.util.Interfaces
Equipment.Slot - Enum Class in com.botwithus.bot.api.inventory: Semantic equipment slot names paired with their in-game inventory indices.
error(String, Object...) - Method in interface com.botwithus.bot.api.log.BotLogger
error(String, Throwable) - Method in interface com.botwithus.bot.api.log.BotLogger
ERROR - Enum constant in enum class com.botwithus.bot.api.log.LogLevel
ERROR - Enum constant in enum class com.botwithus.bot.api.script.LauncherEvent.DataPhase
ESCAPE - Static variable in record class com.botwithus.bot.api.input.KeyStroke: Cancels an input dialog.
EventBus - Interface in com.botwithus.bot.api.event: Publish-subscribe event bus for game events.
EventsDropped(long) - Constructor for record class com.botwithus.bot.api.script.LauncherEvent.EventsDropped: Creates an instance of a EventsDropped record class.
exchangeable() - Method in record class com.botwithus.bot.api.model.ItemType: Returns the value of the exchangeable record component.
execute() - Method in interface com.botwithus.bot.api.script.Task: Executes this task.
executeScript(long, int[], String[], String[]) - Method in interface com.botwithus.bot.api.GameAPI: Executes a previously-obtained client script handle.
exists() - Method in class com.botwithus.bot.api.component.ComponentQuery
exists() - Method in class com.botwithus.bot.api.entities.EntityQuery
exists() - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
exitCode() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ClientExited: Returns the value of the exitCode record component.
EXITED - Enum constant in enum class com.botwithus.bot.api.script.LaunchedClient.State
experience() - Method in record class com.botwithus.bot.api.model.PlayerStat: Returns the value of the experience record component.
experience() - Method in record class com.botwithus.bot.api.snapshot.Skill: Returns the value of the experience record component.

F

FACE_TILE - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
Failed(String, String) - Constructor for record class com.botwithus.bot.api.script.LaunchOutcome.Failed: Creates an instance of a Failed record class.
FAILED - Enum constant in enum class com.botwithus.bot.api.model.WalkResult: The walk failed (pathfinding failure, stuck, etc.).
FAILED - Enum constant in enum class com.botwithus.bot.api.script.LaunchedClient.State
Failure - Section in class com.botwithus.bot.api.input.InputDialog
failures() - Method in record class com.botwithus.bot.api.script.LaunchedClient.Licence: Returns the value of the failures record component.
failures() - Method in record class com.botwithus.bot.api.script.LauncherEvent.LicenceChanged: Returns the value of the failures record component.
fallbackId() - Method in record class com.botwithus.bot.api.gameval.GamevalRef: Returns the value of the fallbackId record component.
FAMILIAR - Enum constant in enum class com.botwithus.bot.api.inventory.Bank.SideView
FAMILIAR - Static variable in class com.botwithus.bot.api.constants.InventoryIds
FARMING - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
FARMING - Static variable in class com.botwithus.bot.api.util.Skills
fatigue() - Method in record class com.botwithus.bot.api.event.BreakStartedEvent: Returns the value of the fatigue record component.
FEET - Enum constant in enum class com.botwithus.bot.api.inventory.Equipment.Slot
fetch(GameAPI, int, int) - Static method in class com.botwithus.bot.api.component.ComponentTree: Fetch + materialize the subtree rooted at (interfaceId, componentId).
field() - Method in exception class com.botwithus.bot.api.script.LauncherException
filled() - Method in class com.botwithus.bot.api.draw.DrawBuilder: Fill rather than stroke.
filled() - Method in class com.botwithus.bot.api.draw.DrawCaptionBuilder: Fill rather than stroke.
filled() - Method in class com.botwithus.bot.api.draw.HighlightBuilder: Fill the marker rather than stroking it.
filled(boolean) - Method in class com.botwithus.bot.api.draw.DrawBuilder: Fill or stroke explicitly.
filled(boolean) - Method in class com.botwithus.bot.api.draw.DrawCaptionBuilder: Fill or stroke explicitly.
filled(boolean) - Method in class com.botwithus.bot.api.draw.HighlightBuilder: Fill or stroke explicitly.
filter(GroundItemFilter) - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.GroundItems
filter(LocationFilter) - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Locations
filter(NpcFilter) - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Npcs
filter(PlayerFilter) - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Players
filter(ProjectileFilter) - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Projectiles
filter(Predicate) - Method in class com.botwithus.bot.api.component.ComponentQuery: Adds a predicate; multiple calls AND together.
filter(Predicate) - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
filter(Predicate) - Method in class com.botwithus.bot.api.entities.EntityQuery: Adds a predicate; multiple calls AND together.
find(int, Predicate) - Method in class com.botwithus.bot.api.component.Components: Convenience: first node in the interface matching predicate, or null.
find(String, Predicate) - Method in class com.botwithus.bot.api.component.Components: Convenience: first node in the gameval-named interface matching predicate, or null.
findComponentAt(int, int) - Method in interface com.botwithus.bot.api.GameAPI: Locate the deepest visible component under a screen-space coordinate, or null when nothing is there.
findFirst() - Method in class com.botwithus.bot.api.component.ComponentQuery: First matching node as an Optional.
findFirst() - Method in class com.botwithus.bot.api.entities.EntityQuery: First match as Optional.
findFirst() - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
findFirst(int) - Method in class com.botwithus.bot.api.inventory.InventoryContainer
findFirst(String) - Method in class com.botwithus.bot.api.inventory.InventoryContainer
findFirstGameval(String) - Method in class com.botwithus.bot.api.inventory.InventoryContainer: First slot holding the item with the given gameval name, as an Optional.
findNearest() - Method in class com.botwithus.bot.api.entities.EntityQuery: Nearest as Optional.
findNearest() - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
findPath(int, int) - Method in interface com.botwithus.bot.api.domain.NavigationAPI: Finds a local A* path between the player and a destination.
findPath(int, int) - Method in interface com.botwithus.bot.api.Navigation: Finds a local A* path from the player's position to a destination.
findPath(int, int, int, int) - Method in interface com.botwithus.bot.api.domain.NavigationAPI: Finds a local A* path from a specific origin.
findPath(int, int, int, int) - Method in interface com.botwithus.bot.api.Navigation: Finds a local A* path between two tiles.
findWorldPath(int, int) - Method in interface com.botwithus.bot.api.domain.NavigationAPI: Finds a world-scale path without walking it.
findWorldPath(int, int) - Method in interface com.botwithus.bot.api.Navigation: Finds a world-scale path from the player's position without walking it.
findWorldPath(int, int, int, int) - Method in interface com.botwithus.bot.api.domain.NavigationAPI: Finds a world-scale path from a specific origin without walking it.
findWorldPath(int, int, int, int) - Method in interface com.botwithus.bot.api.Navigation: Finds a world-scale path between two tiles without walking it.
finishTransferX(int) - Method in class com.botwithus.bot.api.inventory.Bank: Finish a deposit-X or withdraw-X: type amount into the enter-amount dialog and submit it, through InputDialog.enterAmount(long).
fireComponentTrigger(int, int, int, int, int) - Method in interface com.botwithus.bot.api.GameAPI: Fires a component's CS2 event trigger (click / key / ...) by event type, reproducing the engine's own component-event path.
fireKeys(int, int, List) - Method in interface com.botwithus.bot.api.GameAPI: Fires a component's key (type-10) CS2 trigger once per stroke, in order, as a single batched action-queue request (one RPC round-trip).
fireKeyTrigger(int, int, String) - Method in interface com.botwithus.bot.api.GameAPI: Types input into a component through its key (type-10) CS2 trigger, one KeyStroke.character(char) per character, batched as by GameAPI.fireKeys(int, int, List).
FIREMAKING - Enum constant in enum class com.botwithus.bot.api.ScriptCategory: Firemaking training.
FIREMAKING - Static variable in class com.botwithus.bot.api.util.Skills
first() - Method in class com.botwithus.bot.api.component.ComponentQuery: First matching node in tree order, or null.
first() - Method in class com.botwithus.bot.api.entities.EntityQuery: First match in source order, or null.
first() - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
firstError() - Method in record class com.botwithus.bot.api.draw.DrawBatchResult: Returns the value of the firstError record component.
FISHING - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
FISHING - Static variable in class com.botwithus.bot.api.constants.AnimationIds
FISHING - Static variable in class com.botwithus.bot.api.util.Skills
FIVE - Enum constant in enum class com.botwithus.bot.api.inventory.Bank.TransferAmount
FixedPoint(long, int, DrawFont) - Constructor for record class com.botwithus.bot.api.draw.DrawCaption.FixedPoint: Creates an instance of a FixedPoint record class.
FLAG_CLIENT_OPENED - Static variable in record class com.botwithus.bot.api.snapshot.OpenInterface: Bit 3 of a wire flags byte.
flags() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Returns the value of the flags record component.
flags() - Method in record class com.botwithus.bot.api.snapshot.Location: Returns the value of the flags record component.
flags() - Method in record class com.botwithus.bot.api.snapshot.Npc: Returns the value of the flags record component.
flags() - Method in record class com.botwithus.bot.api.snapshot.Player: Returns the value of the flags record component.
FLETCHING - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
FLETCHING - Static variable in class com.botwithus.bot.api.constants.AnimationIds
FLETCHING - Static variable in class com.botwithus.bot.api.util.Skills
flightProgress(int) - Method in class com.botwithus.bot.api.entities.Projectile: Flight progress, 0.0 at launch through 1.0 at impact, clamped to that range.
flush() - Method in class com.botwithus.bot.api.draw.DrawFrame: Send everything queued and answer what the producer did with it.
followingIndex() - Method in class com.botwithus.bot.api.entities.Npc
followingIndex() - Method in class com.botwithus.bot.api.entities.Player
followingIndex() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Returns the value of the followingIndex record component.
followingIndex() - Method in record class com.botwithus.bot.api.snapshot.Npc: Returns the value of the followingIndex record component.
followingIndex() - Method in record class com.botwithus.bot.api.snapshot.Player: Returns the value of the followingIndex record component.
font() - Method in record class com.botwithus.bot.api.draw.DrawCaption.FixedPoint: Returns the value of the font record component.
font() - Method in record class com.botwithus.bot.api.draw.DrawCaption.Literal: Returns the value of the font record component.
font() - Method in record class com.botwithus.bot.api.draw.DrawEntry: Returns the value of the font record component.
font(DrawFont) - Method in class com.botwithus.bot.api.draw.DrawCaptionBuilder: Draw the caption in a named style.
font(DrawFont) - Method in class com.botwithus.bot.api.draw.HighlightBuilder: Draw the caption in a named style.
FONTMETRICS - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Font metrics.
found() - Method in record class com.botwithus.bot.api.model.PathResult: Returns the value of the found record component.
frame() - Method in class com.botwithus.bot.api.draw.Draw: Open a batch.
frameCount() - Method in record class com.botwithus.bot.api.model.SequenceType: Returns the value of the frameCount record component.
frameLengths() - Method in record class com.botwithus.bot.api.model.SequenceType: Returns the value of the frameLengths record component.
freeSlots() - Method in class com.botwithus.bot.api.inventory.InventoryContainer
fromCode(int) - Static method in enum class com.botwithus.bot.api.component.ComponentType: Resolves a wire code to its category, or ComponentType.UNKNOWN for an unrecognized code (e.g.
fromIndex(int) - Static method in enum class com.botwithus.bot.api.inventory.Equipment.Slot: Look up by index; null when index doesn't map to a real slot.
fromSource(int) - Static method in interface com.botwithus.bot.api.snapshot.ProjectileFilter: Projectiles launched by the given source entity (NPC/player server index).
fromTile() - Static method in interface com.botwithus.bot.api.snapshot.ProjectileFilter: Projectiles anchored to a fixed tile at the source end rather than an entity.
fromVarc(int) - Static method in enum class com.botwithus.bot.api.input.InputMode: The mode a MESLAYERMODE value names.
fromWire(int, int) - Static method in record class com.botwithus.bot.api.snapshot.OpenInterface: Decodes one wire flags byte for interface id.
fromWire(int, IntConsumer) - Static method in record class com.botwithus.bot.api.snapshot.Orientation: Decodes the producer's zero-extended u16, degrading rather than throwing.
fromWire(String) - Static method in enum class com.botwithus.bot.api.gameval.GamevalType: The type for a wire etype key, or empty when unknown.
fromWireName(String) - Static method in enum class com.botwithus.bot.api.draw.DrawFont: The style a producer reply spelled, defaulting to DrawFont.NORMAL for a name this build does not know — the producer is versioned separately and may grow a style, and a decoder must not throw when it does.
fromWireName(String) - Static method in enum class com.botwithus.bot.api.draw.DrawKind: The kind a producer reply spelled, or null when the producer named a kind this build does not know.
fromWireName(String) - Static method in enum class com.botwithus.bot.api.draw.DrawSpace: The space a producer reply spelled, defaulting to DrawSpace.SCREEN.
FULL_TURN - Static variable in record class com.botwithus.bot.api.snapshot.Orientation: Client angle units in one full turn.

G

GameAction - Record Class in com.botwithus.bot.api.model: A game action to be queued for execution via the pipe RPC.
GameAction(int, int, int, int) - Constructor for record class com.botwithus.bot.api.model.GameAction: Creates an instance of a GameAction record class.
GameAPI - Interface in com.botwithus.bot.api: Slim RPC-shaped surface for talking to the game producer.
gameCycle() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: The client's own game-cycle counter: one per ~20 ms client main-loop iteration, roughly 30 per GameSnapshot.serverTick().
GameEvent - Interface in com.botwithus.bot.api.event: Common interface for every typed game event distributed through the EventBus.
GameSnapshot - Interface in com.botwithus.bot.api.snapshot: Tick-scoped read view over the producer's published game snapshot.
GameSnapshot.GroundItems - Interface in com.botwithus.bot.api.snapshot
GameSnapshot.Inventories - Interface in com.botwithus.bot.api.snapshot
GameSnapshot.Locations - Interface in com.botwithus.bot.api.snapshot
GameSnapshot.Npcs - Interface in com.botwithus.bot.api.snapshot
GameSnapshot.Players - Interface in com.botwithus.bot.api.snapshot
GameSnapshot.Projectiles - Interface in com.botwithus.bot.api.snapshot
gameState() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: Game client state.
gameval() - Method in record class com.botwithus.bot.api.gameval.GamevalEntry: Returns the value of the gameval record component.
gameval() - Method in exception class com.botwithus.bot.api.gameval.GamevalNotFoundException: The name that failed to resolve.
gameval() - Method in record class com.botwithus.bot.api.gameval.GamevalRef: Returns the value of the gameval record component.
gameval(GamevalType, int) - Method in interface com.botwithus.bot.api.gameval.GamevalIndex: The name for an id, or empty when the id has none.
GamevalEntry - Record Class in com.botwithus.bot.api.gameval: One name↔id pairing from the gameval index.
GamevalEntry(GamevalType, int, String) - Constructor for record class com.botwithus.bot.api.gameval.GamevalEntry: Creates an instance of a GamevalEntry record class.
GamevalIndex - Interface in com.botwithus.bot.api.gameval: Resolves gameval symbolic names to entity ids and back.
GamevalNotFoundException - Exception Class in com.botwithus.bot.api.gameval: A gameval name did not resolve.
GamevalNotFoundException(GamevalType, String, boolean) - Constructor for exception class com.botwithus.bot.api.gameval.GamevalNotFoundException
GamevalRef - Record Class in com.botwithus.bot.api.gameval: A gameval name paired with the id it resolved to when the calling code was written.
GamevalRef(GamevalType, String, int) - Constructor for record class com.botwithus.bot.api.gameval.GamevalRef: Creates an instance of a GamevalRef record class.
gamevals() - Method in interface com.botwithus.bot.api.GameAPI: Resolves gameval symbolic names — the game's own stable names for items, scenery, NPCs, interfaces, components and variables — to ids.
GamevalType - Enum Class in com.botwithus.bot.api.gameval: A namespace of gameval symbolic names — one per table the game ships in cache index 67.
gaussianRandom(long, long) - Static method in class com.botwithus.bot.api.util.Timing: Returns a gaussian-distributed random value around a mean.
geBuyLimit() - Method in record class com.botwithus.bot.api.model.ItemType: Returns the value of the geBuyLimit record component.
geometry() - Method in record class com.botwithus.bot.api.draw.DrawEntry: Returns the value of the geometry record component.
get(int, int) - Method in class com.botwithus.bot.api.component.Components: Single component by coordinates, or null when not loaded.
get(String) - Method in class com.botwithus.bot.api.component.Components: Single component named by its gameval, e.g.
get(String) - Method in interface com.botwithus.bot.api.isc.SharedState: Retrieves the value stored under the given key.
get(String, Class) - Method in interface com.botwithus.bot.api.isc.SharedState: Retrieves and casts the value stored under the given key.
getActionHistory(int, int) - Method in interface com.botwithus.bot.api.domain.ActionAPI: Returns a history of recently executed actions.
getActionQueueSize() - Method in interface com.botwithus.bot.api.domain.ActionAPI: Returns the number of actions currently pending in the queue.
getAll(String) - Method in class com.botwithus.bot.api.inventory.InventoryContainer
getAllSlots() - Method in class com.botwithus.bot.api.inventory.InventoryContainer: All slots, including empties.
getAllSlotVars() - Method in class com.botwithus.bot.api.inventory.InventoryContainer: Per-item obj vars for every filled slot in this container.
getAnimation() - Method in class com.botwithus.bot.api.entities.Npc: Alias for Npc.animationId().
getAutoLogin() - Method in interface com.botwithus.bot.api.GameAPI: Returns whether the producer's auto-login state machine is enabled.
getBoolean(String, boolean) - Method in record class com.botwithus.bot.api.config.ScriptConfig
getBoostedLevel(GameAPI, int) - Static method in class com.botwithus.bot.api.util.Skills: Current displayed level for skillId including stat boosts and drains.
getClient(String) - Method in interface com.botwithus.bot.api.ClientProvider: Returns the client with the given name, if connected.
getClientCount() - Method in interface com.botwithus.bot.api.domain.SystemAPI: Returns the number of clients currently connected to the pipe server.
getClientNames() - Method in interface com.botwithus.bot.api.ClientProvider: Returns the names of all currently connected clients.
getClientNames() - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Returns the names of all connected clients.
getClientProvider() - Method in interface com.botwithus.bot.api.script.ManagementContext: Returns the client provider for accessing individual connected clients and their GameAPI / EventBus instances.
getClients() - Method in interface com.botwithus.bot.api.ClientProvider: Returns all currently connected clients.
getComponent(int, int) - Method in interface com.botwithus.bot.api.GameAPI: Returns the component at (interfaceId, componentId) or null when no such component is loaded.
getComponents(List) - Method in interface com.botwithus.bot.api.GameAPI: Batch counterpart of GameAPI.getComponent(int, int).
getConfigFields() - Method in interface com.botwithus.bot.api.BotScript: Returns the configurable fields this script exposes.
getConfigFields() - Method in interface com.botwithus.bot.api.script.ManagementScript: Returns the configurable fields this script exposes.
getConfigFields() - Method in class com.botwithus.bot.api.script.TaskScript
getDisplayName() - Method in interface com.botwithus.bot.api.Client: The display name of the character on this client, once the host knows it.
getDisplayName() - Method in enum class com.botwithus.bot.api.ScriptCategory: Returns the human-readable display name for this category.
getDisplayName() - Method in interface com.botwithus.bot.api.ScriptContext: The display name of the character on this script's client, once the host knows it.
getDynamicChildren(int, int) - Method in interface com.botwithus.bot.api.GameAPI: Returns the dynamic (script-spawned) child component ids of (interfaceId, componentId).
getEnumType(int) - Method in interface com.botwithus.bot.api.GameAPI
getEventBus() - Method in interface com.botwithus.bot.api.Client: Returns the event bus for this client.
getEventBus() - Method in interface com.botwithus.bot.api.ScriptContext: Returns the event bus for subscribing to and publishing game events.
getFirst(int) - Method in class com.botwithus.bot.api.inventory.InventoryContainer
getFirst(String) - Method in class com.botwithus.bot.api.inventory.InventoryContainer
getFirstGameval(String) - Method in class com.botwithus.bot.api.inventory.InventoryContainer: First slot holding the item with the given gameval name, or null.
getFollowingIndex() - Method in class com.botwithus.bot.api.entities.Npc: Alias for Npc.followingIndex().
getGameAPI() - Method in interface com.botwithus.bot.api.Client: Returns the game API for this client.
getGameAPI() - Method in interface com.botwithus.bot.api.ScriptContext: Returns the game API for interacting with the game client.
getGameCycle() - Method in interface com.botwithus.bot.api.GameAPI: Returns the producer's monotonically increasing game cycle counter.
getGroupDescription(String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Returns the description of a group, or null.
getGroupMembers(String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Returns the client names in a group.
getGroupNames() - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Returns the names of all groups.
getHealth() - Method in class com.botwithus.bot.api.entities.Npc: Alias for Npc.hp().
getHealthPercent() - Method in class com.botwithus.bot.api.entities.Npc: Current health as a percentage of max health, 0 when max health is unknown.
getInfo(String) - Method in interface com.botwithus.bot.api.script.ScriptManager: Returns info for a single script by name, or null if not found.
getInt(String, int) - Method in record class com.botwithus.bot.api.config.ScriptConfig: Falls back to default if absent or unparseable.
getInterfaceTree(int, int) - Method in interface com.botwithus.bot.api.GameAPI: Returns the component at (interfaceId, componentId) and its entire descendant subtree, flattened breadth-first, in a single pipe round-trip.
getItems() - Method in class com.botwithus.bot.api.inventory.InventoryContainer: Non-empty slots only.
getItemType(int) - Method in interface com.botwithus.bot.api.GameAPI
getLastActionTime() - Method in interface com.botwithus.bot.api.domain.ActionAPI: Returns the game-cycle timestamp of the last executed action.
getLevel(GameAPI, int) - Static method in class com.botwithus.bot.api.util.Skills: Base (unboosted) level for skillId.
getLocalPlayer() - Method in interface com.botwithus.bot.api.GameAPI: The local player, with LocalPlayer.currentHealth() and LocalPlayer.maxHealth() filled in.
getLocationType(int) - Method in interface com.botwithus.bot.api.GameAPI
getLogger(Class) - Static method in class com.botwithus.bot.api.log.LoggerFactory
getLogger(String) - Static method in class com.botwithus.bot.api.log.LoggerFactory
getLoginState() - Method in interface com.botwithus.bot.api.GameAPI: Returns the producer's current login state.
getMaxHealth() - Method in class com.botwithus.bot.api.entities.Npc: Alias for Npc.maxHp().
getMessageBus() - Method in interface com.botwithus.bot.api.script.ManagementContext: Returns the message bus for inter-script communication.
getMessageBus() - Method in interface com.botwithus.bot.api.ScriptContext: Returns the message bus for inter-script communication.
getName() - Method in interface com.botwithus.bot.api.Client: Returns the unique name identifying this client connection.
getNavigation() - Method in interface com.botwithus.bot.api.ScriptContext: Returns the navigation interface for blocking walk operations.
getNpcType(int) - Method in interface com.botwithus.bot.api.GameAPI
getObjVars(int) - Method in interface com.botwithus.bot.api.GameAPI: Per-item obj vars for every filled slot of a container — the per-instance variables an item carries in its slot's ObjVarDomain (augmentation XP, charges, etc.), distinct from the global player/client var domains.
getObjVars(int, int) - Method in interface com.botwithus.bot.api.GameAPI: Per-item obj vars for a single container slot.
getOptions() - Method in class com.botwithus.bot.api.entities.GroundItem
getOptions() - Method in class com.botwithus.bot.api.entities.Npc: Right-click options.
getOptions() - Method in class com.botwithus.bot.api.entities.SceneObject: Right-click options.
getOrchestrator() - Method in interface com.botwithus.bot.api.script.ManagementContext: Returns the orchestrator for cross-client script and group management.
getPlayerStat(int) - Method in interface com.botwithus.bot.api.GameAPI: Returns one of the local player's skill stats by skill type id.
getPresetPage() - Method in class com.botwithus.bot.api.inventory.Bank: Preset page (0 for presets 1-9, 1 for 10-18).
getQuestType(int) - Method in interface com.botwithus.bot.api.GameAPI
getRegionCacheSize() - Method in interface com.botwithus.bot.api.domain.NavigationAPI: Returns the region collision cache size.
getRegionCacheSize() - Method in interface com.botwithus.bot.api.Navigation: Returns the region collision cache size.
getScheduler() - Method in interface com.botwithus.bot.api.script.ScriptManager: Returns the scheduler for running scripts on a timer or interval.
getScriptContext() - Method in interface com.botwithus.bot.api.ScriptContext: Returns the debug publisher bound to this script.
getScriptHandle(int) - Method in interface com.botwithus.bot.api.GameAPI: Obtains a producer-side handle to a client script for repeated execution.
getSequenceType(int) - Method in interface com.botwithus.bot.api.GameAPI
getSharedState() - Method in interface com.botwithus.bot.api.script.ManagementContext: Returns the shared state store for cross-script data sharing.
getSharedState() - Method in interface com.botwithus.bot.api.ScriptContext: Returns the shared state store for inter-script data sharing.
getSlot(int) - Method in class com.botwithus.bot.api.inventory.InventoryContainer: One slot by 0-based index, or null when out of range.
getSlot(Equipment.Slot) - Method in class com.botwithus.bot.api.inventory.Equipment: Item worn in the given semantic slot, or null when nothing is equipped there.
getSlotVars(int) - Method in class com.botwithus.bot.api.inventory.InventoryContainer: Per-item obj vars for one slot — the per-instance variables the item in that slot carries inside its ObjVarDomain (augmentation XP, charges, etc.).
getSpotAnims() - Method in class com.botwithus.bot.api.entities.Npc: Currently-active spot anim ids (graphics) playing on this NPC.
getStaticChildren(int, int) - Method in interface com.botwithus.bot.api.GameAPI: Returns the static (cache-defined) child component ids of (interfaceId, componentId).
getStatusAll() - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Returns script status across all clients.
getStatusForGroup(String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Returns script status for clients in a group.
getString(String, String) - Method in record class com.botwithus.bot.api.config.ScriptConfig
getStructType(int) - Method in interface com.botwithus.bot.api.GameAPI
getType() - Method in class com.botwithus.bot.api.entities.GroundItem
getType() - Method in class com.botwithus.bot.api.entities.Npc: Cached NpcType for this NPC's base typeId.
getType() - Method in class com.botwithus.bot.api.entities.SceneObject: Cached LocationType for this object.
getUI() - Method in interface com.botwithus.bot.api.BotScript: Returns a custom UI for this script, rendered in the Script UI panel.
getUI() - Method in interface com.botwithus.bot.api.script.ManagementScript: Returns a custom UI for this script, rendered in the Script UI panel.
getVarbit(int) - Method in interface com.botwithus.bot.api.domain.VariableAPI: Returns the value of a variable bit (varbit), decoded from its base variable and bit range.
getVarbit(String) - Method in interface com.botwithus.bot.api.GameAPI: Value of a variable bit named by its gameval, e.g.
getVarcInt(int) - Method in interface com.botwithus.bot.api.domain.VariableAPI: Returns the value of an integer client variable (varc).
getVarcInt(String) - Method in interface com.botwithus.bot.api.GameAPI: Value of an integer client variable named by its gameval.
getVarcInts(List) - Method in interface com.botwithus.bot.api.domain.VariableAPI: Batch counterpart of VariableAPI.getVarcInt(int).
getVarcString(int) - Method in interface com.botwithus.bot.api.domain.VariableAPI: Returns the value of a string client variable (varc).
getVarcStrings(List) - Method in interface com.botwithus.bot.api.domain.VariableAPI: Batch counterpart of VariableAPI.getVarcString(int).
getVarp(int) - Method in interface com.botwithus.bot.api.domain.VariableAPI: Returns the value of a player variable (varp): what the game reads for it.
getVarp(String) - Method in interface com.botwithus.bot.api.GameAPI: Value of a player variable named by its gameval, e.g.
getVarpLong(int) - Method in interface com.botwithus.bot.api.domain.VariableAPI: The full 64-bit value of a player variable, for LONG varps whose value does not fit an int.
getVarpLong(String) - Method in interface com.botwithus.bot.api.GameAPI: Full 64-bit value of a player variable named by its gameval.
getVarps(List) - Method in interface com.botwithus.bot.api.domain.VariableAPI: Batch counterpart of VariableAPI.getVarp(int).
getWalkStatus() - Method in interface com.botwithus.bot.api.domain.NavigationAPI: Returns the walker state for the calling script: walking while its own walk is in flight, otherwise the outcome of its last request — arrived, cancelled, failed, refused_busy, or idle if it has never asked for one.
getWalkStatus() - Method in interface com.botwithus.bot.api.Navigation: Returns the walker state for the calling script — never a sibling script's.
getWithdrawAmount() - Method in class com.botwithus.bot.api.inventory.Bank: Currently configured custom withdraw amount.
getWorldMapElement(int) - Method in interface com.botwithus.bot.api.GameAPI: Single world-map element by id, or null when not found.
getXp(GameAPI, int) - Static method in class com.botwithus.bot.api.util.Skills: Total xp for skillId.
GivingUp(long, int, Throwable) - Constructor for record class com.botwithus.bot.api.runtime.ReconnectState.GivingUp: Creates an instance of a GivingUp record class.
globalTeleportMinHeuristic() - Method in record class com.botwithus.bot.api.model.WorldPathConfig: Returns the value of the globalTeleportMinHeuristic record component.
globalTeleportMinHeuristic(float) - Method in class com.botwithus.bot.api.model.WorldPathConfig.Builder
GRACEFUL - Enum constant in enum class com.botwithus.bot.api.script.StopMode: Ask the game to close, as the window's close button does.
GRAND_EXCHANGE - Static variable in class com.botwithus.bot.api.constants.InterfaceIds
GRAND_EXCHANGE - Static variable in class com.botwithus.bot.api.util.Interfaces
GrandExchange - Class in com.botwithus.bot.api.util: Convenience wrapper around the Grand Exchange interface (STOCKMARKET, iface 105) and its collect-all panel (STOCKMARKET_COLLECTALL, iface 651).
GrandExchange(GameAPI) - Constructor for class com.botwithus.bot.api.util.GrandExchange
GRAPHIC - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Spot animations / graphical effects.
GREEN - Static variable in class com.botwithus.bot.api.draw.Colors: The producer's own default when a command omits color.
GREY - Static variable in class com.botwithus.bot.api.draw.Colors
gridH() - Method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Descriptor grid height in CHUNKS (0 when static).
gridW() - Method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Descriptor grid width in CHUNKS (0 when static).
GROUND_ITEM_OPTIONS - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
GROUND_ITEM1 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
GROUND_ITEM2 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
GROUND_ITEM3 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
GROUND_ITEM4 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
GROUND_ITEM5 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
GROUND_ITEM6 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
GroundItem - Class in com.botwithus.bot.api.entities: Rich wrapper around GroundItemInfo with lazy ItemType resolution and option-keyed interact.
GroundItem - Record Class in com.botwithus.bot.api.snapshot: Snapshot of one ground-item stack at the producer's current tick (v15+).
GroundItem(int, int, int, int, int) - Constructor for record class com.botwithus.bot.api.snapshot.GroundItem: Creates an instance of a GroundItem record class.
GroundItemFilter - Interface in com.botwithus.bot.api.snapshot: Predicate for filtering GroundItem entries in a GameSnapshot.
GroundItemInfo - Record Class in com.botwithus.bot.api.model: Wire-format record returned by query_ground_items for one stack of items lying on the ground.
GroundItemInfo(int, int, int, int, int, int) - Constructor for record class com.botwithus.bot.api.model.GroundItemInfo: Creates an instance of a GroundItemInfo record class.
groundItems() - Method in interface com.botwithus.bot.api.GameAPI: Ground-item query facade.
groundItems() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: Ground items table accessor (v15+).
GroundItems - Class in com.botwithus.bot.api.entities: Ground-item query facade.
GroundItems(GameAPI) - Constructor for class com.botwithus.bot.api.entities.GroundItems
GroundItems.Query - Class in com.botwithus.bot.api.entities
groundOptions() - Method in record class com.botwithus.bot.api.model.ItemType: Returns the value of the groundOptions record component.
Group(String, String) - Constructor for record class com.botwithus.bot.api.script.ManagementTarget.Group: Creates an instance of a Group record class.

H

h() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Ellipse: Returns the value of the h record component.
h() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Rect: Returns the value of the h record component.
handle() - Method in class com.botwithus.bot.api.entities.GroundItem
handle() - Method in class com.botwithus.bot.api.entities.SceneObject
handle() - Method in record class com.botwithus.bot.api.model.GroundItemInfo: Returns the value of the handle record component.
handle() - Method in record class com.botwithus.bot.api.model.SceneObjectInfo: Returns the value of the handle record component.
HANDS - Enum constant in enum class com.botwithus.bot.api.inventory.Equipment.Slot
hashCode() - Method in record class com.botwithus.bot.api.config.ConfigField.BoolField: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.config.ConfigField.ChoiceField: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.config.ConfigField.IntField: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.config.ConfigField.ItemIdField: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.config.ConfigField.StringField: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.config.ScriptConfig: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.dialog.DialogOption: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.draw.DrawBatchResult: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.draw.DrawCaption.FixedPoint: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.draw.DrawCaption.Literal: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.draw.DrawCaption.None: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Area: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.draw.DrawCommand.ComponentTarget: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Ellipse: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Entity: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Line: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Poly: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Rect: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Text: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Tile: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.draw.DrawEntry: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.draw.DrawStyle: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.ActionExecutedEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.BreakEndedEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.BreakStartedEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.ChatMessageEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.ConnectionLostEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.KeyInputEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.LoginStateChangeEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.ObjVarChangeEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.RadioGroupSelectEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.ReconnectStateChangedEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.ScriptCrashedEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.ScriptLoadFailedEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.SpotAnimEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.TickEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.VarbitChangeEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.VarcChangeEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.VarChangeEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.WalkArrivedEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.WalkCancelledEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.event.WalkFailedEvent: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.gameval.GamevalEntry: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.gameval.GamevalRef: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.input.KeyStroke: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.isc.ScriptMessage: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.ActionEntry: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.ChatMessage: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.Component: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.ComponentRef: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.ComponentTreeNode: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.ComponentTrigger: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.EnumType: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.GameAction: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.GroundItemInfo: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.ItemType: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.LocationType: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.LoginState: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.NpcType: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.PathResult: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.PlayerStat: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.QuestType: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.ResourceItem: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.ResourceSection: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.SceneObjectInfo: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.ScriptResult: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.SequenceType: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.SkillRequirement: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.StructType: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.VarbitRead: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.VarbitType: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.VarbitValue: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.VarpRead: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.WalkStatus: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.WorldMapElement: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.WorldMapPlacement: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.model.WorldPathConfig: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.runtime.LastCrash: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.runtime.ReconnectState.Connected: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.runtime.ReconnectState.Disconnected: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.runtime.ReconnectState.GivingUp: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.runtime.ReconnectState.Reconnecting: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.runtime.ScriptHealth: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.OpResult: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScheduledScriptEntry: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScheduleOpResult: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScriptStatusEntry: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.LaunchedClient: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.LaunchedClient.LaunchedBy: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.LaunchedClient.Licence: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.LauncherAccount: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.LauncherEvent.AgentUpdated: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ClientExited: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ClientStarted: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ClientStateChanged: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.LauncherEvent.DataUpdateApplied: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.LauncherEvent.DataUpdateAvailable: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.LauncherEvent.EventsDropped: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.LauncherEvent.LicenceChanged: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ServiceLost: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ServiceRestored: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ServiceShuttingDown: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.LaunchOptions: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.LaunchOutcome.Attached: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.LaunchOutcome.AttachFailed: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.LaunchOutcome.Failed: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.ManagementTarget.ClientScript: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.ManagementTarget.Group: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.ManagementTarget.WholeHost: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.ScriptInfo: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.script.ScriptScheduler.ScheduledEntry: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.snapshot.GroundItem: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.snapshot.Inventory: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.snapshot.InventoryItem: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.snapshot.Location: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.snapshot.Npc: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.snapshot.OpenInterface: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.snapshot.Orientation: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.snapshot.Player: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.snapshot.Projectile: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.snapshot.Skill: Returns a hash code value for this object.
hashCode() - Method in record class com.botwithus.bot.api.snapshot.SourceTile: Returns a hash code value for this object.
hasHealth() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: True when both health fields carry a real reading.
hasIndex() - Method in enum class com.botwithus.bot.api.draw.EntityRef: Whether this reference is completed by a server index.
hasOption(String) - Method in class com.botwithus.bot.api.entities.GroundItem
hasOption(String) - Method in class com.botwithus.bot.api.entities.Npc: True if any option matches option (case-insensitive).
hasOption(String) - Method in class com.botwithus.bot.api.entities.SceneObject: True if any option matches option case-insensitively.
hasPresented() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns the value of the hasPresented record component.
hasValue() - Method in record class com.botwithus.bot.api.model.VarbitRead: True when VarbitRead.value() is what the game reads.
hasValue() - Method in record class com.botwithus.bot.api.model.VarpRead: True when VarpRead.value() is what the game reads: set, or at its default.
HEAD - Enum constant in enum class com.botwithus.bot.api.inventory.Equipment.Slot
HEADBAR - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Overhead health bars.
HEADING - Enum constant in enum class com.botwithus.bot.api.draw.DrawFont
HEALTH_UNKNOWN - Static variable in record class com.botwithus.bot.api.snapshot.LocalPlayer: Value LocalPlayer.currentHealth() and LocalPlayer.maxHealth() carry when no one has read the backing varps — the sentinel the variable reads use for "unset" as well, so a caller needs only one "no value" check.
HEALTHY - Static variable in record class com.botwithus.bot.api.runtime.ScriptHealth: Sentinel for a never-crashed script.
height() - Method in class com.botwithus.bot.api.component.ComponentNode
height() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the height record component.
heightTiles() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Area: Returns the value of the heightTiles record component.
heightTiles() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Entity: Returns the value of the heightTiles record component.
HERBLORE - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
HERBLORE - Static variable in class com.botwithus.bot.api.util.Skills
heuristicWeight() - Method in record class com.botwithus.bot.api.model.WorldPathConfig: Returns the value of the heuristicWeight record component.
heuristicWeight(float) - Method in class com.botwithus.bot.api.model.WorldPathConfig.Builder
hidden() - Method in class com.botwithus.bot.api.component.ComponentQuery: Keep only components the producer reported hidden.
hidden() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the hidden record component.
HighlightBuilder - Class in com.botwithus.bot.api.draw: Fluent chain for a highlight — the four calls that mark a thing rather than a place.
HighlightFactory - Interface in com.botwithus.bot.api.draw: Turns a style and a caption into a concrete DrawCommand.Highlight.
HITMARK - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Hit splats.
hostKind() - Method in record class com.botwithus.bot.api.script.LaunchedClient.LaunchedBy: Returns the value of the hostKind record component.
hostsBlocking() - Method in record class com.botwithus.bot.api.script.LauncherEvent.DataUpdateAvailable: Returns the value of the hostsBlocking record component.
hp() - Method in class com.botwithus.bot.api.entities.Npc
hp() - Method in record class com.botwithus.bot.api.snapshot.Npc: Returns the value of the hp record component.
hpaReady() - Method in record class com.botwithus.bot.api.model.WalkStatus: Returns the value of the hpaReady record component.
Humanize - Class in com.botwithus.bot.api.util: Human-like delay utilities to make bot behavior less detectable.
HUNTER - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
HUNTER - Static variable in class com.botwithus.bot.api.util.Skills

I

id() - Method in record class com.botwithus.bot.api.gameval.GamevalEntry: Returns the value of the id record component.
id() - Method in record class com.botwithus.bot.api.model.EnumType: Returns the value of the id record component.
id() - Method in record class com.botwithus.bot.api.model.ItemType: Returns the value of the id record component.
id() - Method in record class com.botwithus.bot.api.model.LocationType: Returns the value of the id record component.
id() - Method in record class com.botwithus.bot.api.model.NpcType: Returns the value of the id record component.
id() - Method in record class com.botwithus.bot.api.model.QuestType: Returns the value of the id record component.
id() - Method in record class com.botwithus.bot.api.model.SequenceType: Returns the value of the id record component.
id() - Method in record class com.botwithus.bot.api.model.StructType: Returns the value of the id record component.
id() - Method in record class com.botwithus.bot.api.model.VarbitRead: Returns the value of the id record component.
id() - Method in record class com.botwithus.bot.api.model.VarbitType: Returns the value of the id record component.
id() - Method in record class com.botwithus.bot.api.model.VarpRead: Returns the value of the id record component.
id() - Method in record class com.botwithus.bot.api.model.WorldMapElement: Returns the value of the id record component.
id() - Method in record class com.botwithus.bot.api.script.LauncherAccount: Returns the value of the id record component.
id() - Method in record class com.botwithus.bot.api.script.ManagementTarget.Group: Returns the value of the id record component.
id() - Method in record class com.botwithus.bot.api.script.ScriptScheduler.ScheduledEntry: Returns the value of the id record component.
id() - Method in record class com.botwithus.bot.api.snapshot.OpenInterface: Returns the value of the id record component.
id(int) - Static method in interface com.botwithus.bot.api.snapshot.ProjectileFilter
id(GamevalType, String) - Method in interface com.botwithus.bot.api.gameval.GamevalIndex: The id for a name, or empty when the name is unknown.
IDLE - Static variable in class com.botwithus.bot.api.constants.AnimationIds
ifaceId() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the ifaceId record component.
in(int) - Method in class com.botwithus.bot.api.component.Components: Start a query over the whole interface (rooted at its root component).
in(String) - Method in class com.botwithus.bot.api.component.Components: Query over the whole interface named by its gameval, e.g.
incoming() - Method in class com.botwithus.bot.api.entities.Projectiles: Projectiles aimed at the local player.
index - Variable in enum class com.botwithus.bot.api.inventory.Equipment.Slot
index() - Method in record class com.botwithus.bot.api.dialog.DialogOption: Returns the value of the index record component.
index() - Method in record class com.botwithus.bot.api.model.ChatMessage: Returns the value of the index record component.
inFlightAt(int) - Static method in interface com.botwithus.bot.api.snapshot.ProjectileFilter: Projectiles whose flight brackets the given game cycle — i.e.
info(String, Object...) - Method in interface com.botwithus.bot.api.log.BotLogger
INFO - Enum constant in enum class com.botwithus.bot.api.log.LogLevel
INJECTED - Enum constant in enum class com.botwithus.bot.api.script.LaunchedClient.State: The agent is injected and its pipe is up; the last state the service can know.
INJECTING - Enum constant in enum class com.botwithus.bot.api.script.LaunchedClient.State
INPUT - Enum constant in enum class com.botwithus.bot.api.component.ComponentType
INPUT_COMPONENT - Static variable in class com.botwithus.bot.api.input.InputDialog: The dialog's input field, which carries the key trigger (MESLAYER__MES_TEXT2).
INPUT_INTERFACE - Static variable in class com.botwithus.bot.api.inventory.Bank: Withdraw-X / Deposit-X input layer (MESLAYER).
inputDialog() - Method in interface com.botwithus.bot.api.GameAPI: The game's text/amount input dialog (withdraw-X, add-friend, ...).
InputDialog - Class in com.botwithus.bot.api.input: The game's input dialog (MESLAYER, interface 1469): the prompt behind withdraw-X, deposit-X, add-friend and the like.
InputDialog(GameAPI) - Constructor for class com.botwithus.bot.api.input.InputDialog
InputMode - Enum Class in com.botwithus.bot.api.input: What the game's input dialog is asking for, read from the client variable MESLAYERMODE.
inputTypeId() - Method in record class com.botwithus.bot.api.model.EnumType: Returns the value of the inputTypeId record component.
INT - Enum constant in enum class com.botwithus.bot.api.model.VarKind: A 32-bit integer.
intDefault() - Method in record class com.botwithus.bot.api.model.EnumType: Returns the value of the intDefault record component.
interact(int) - Method in class com.botwithus.bot.api.component.ComponentNode: Queue a click on this component with the given 1-based right-click option index.
interact(int) - Method in class com.botwithus.bot.api.entities.GroundItem: Queue an action by 1-based right-click option index.
interact(int) - Method in class com.botwithus.bot.api.entities.Npc: Queue an action against this NPC by 1-based option index.
interact(int) - Method in class com.botwithus.bot.api.entities.Player: Queue an action against this player by 1-based option index.
interact(int) - Method in class com.botwithus.bot.api.entities.SceneObject: Queue an action by 1-based right-click option index.
interact(int, int) - Method in class com.botwithus.bot.api.entities.Npc: Two-arg variant kept for pre-rewrite scripts.
interact(int, int) - Method in class com.botwithus.bot.api.entities.SceneObject: Two-arg variant kept for pre-rewrite scripts.
interact(int, int) - Method in class com.botwithus.bot.api.inventory.InventoryContainer: Click the given slot with the given 1-based right-click option index.
interact(int, String) - Method in class com.botwithus.bot.api.inventory.InventoryContainer: Alias for InventoryContainer.interactFirst(int, String).
interact(Equipment.Slot, int) - Method in class com.botwithus.bot.api.inventory.Equipment: Click the given semantic slot with a 1-based right-click option index.
interact(Equipment.Slot, String) - Method in class com.botwithus.bot.api.inventory.Equipment: Click the given semantic slot with the named right-click option.
interact(String) - Method in class com.botwithus.bot.api.entities.GroundItem: Queue an action by option text.
interact(String) - Method in class com.botwithus.bot.api.entities.Npc: Queue an action by option text (e.g.
interact(String) - Method in class com.botwithus.bot.api.entities.SceneObject: Queue an action by option text.
interactFirst(int, int) - Method in class com.botwithus.bot.api.inventory.InventoryContainer: Click the first slot containing itemId with the given 1-based option index (no name lookup).
interactFirst(int, String) - Method in class com.botwithus.bot.api.inventory.InventoryContainer: Click the first slot containing itemId with the named option.
interactFirstGameval(String, int) - Method in class com.botwithus.bot.api.inventory.InventoryContainer: Click the first slot holding the item with the given gameval name, using the given 1-based option index.
interactFirstGameval(String, String) - Method in class com.botwithus.bot.api.inventory.InventoryContainer: Click the first slot holding the item with the given gameval name, using the named option.
interactId() - Method in record class com.botwithus.bot.api.snapshot.Location: Returns the value of the interactId record component.
interactId(int) - Static method in interface com.botwithus.bot.api.snapshot.LocationFilter
interactType() - Method in record class com.botwithus.bot.api.model.LocationType: Returns the value of the interactType record component.
INTERFACE - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Interfaces.
INTERFACE_ID - Static variable in class com.botwithus.bot.api.input.InputDialog: The input-dialog interface (MESLAYER).
INTERFACE_ID - Static variable in class com.botwithus.bot.api.inventory.Backpack
INTERFACE_ID - Static variable in class com.botwithus.bot.api.inventory.Bank
INTERFACE_ID - Static variable in class com.botwithus.bot.api.inventory.Equipment
INTERFACE_ID - Static variable in class com.botwithus.bot.api.util.GrandExchange: GE interface id.
INTERFACE_ID_SHIFT - Static variable in interface com.botwithus.bot.api.gameval.GamevalIndex: Bit position the interface id occupies in a packed component id.
interfaceId() - Method in class com.botwithus.bot.api.component.ComponentNode
interfaceId() - Method in record class com.botwithus.bot.api.dialog.DialogOption: The interface the row lives on.
interfaceId() - Method in record class com.botwithus.bot.api.draw.DrawCommand.ComponentTarget: Returns the value of the interfaceId record component.
interfaceId() - Method in record class com.botwithus.bot.api.event.RadioGroupSelectEvent: Returns the value of the interfaceId record component.
interfaceId() - Method in class com.botwithus.bot.api.inventory.InventoryContainer
interfaceId() - Method in record class com.botwithus.bot.api.model.ComponentRef: Returns the value of the interfaceId record component.
interfaceId(String) - Method in interface com.botwithus.bot.api.gameval.GamevalIndex: Shorthand for id(GamevalType.INTERFACE, gameval).
interfaceIdFromHash(int) - Static method in class com.botwithus.bot.api.util.Interfaces
InterfaceIds - Class in com.botwithus.bot.api.constants
Interfaces - Class in com.botwithus.bot.api.util: Common RS3 interface ID constants and component hash utilities.
interruptBreak() - Method in interface com.botwithus.bot.api.GameAPI: Interrupts any currently active break.
interval() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScheduledScriptEntry: Returns the value of the interval record component.
interval() - Method in record class com.botwithus.bot.api.script.ScriptScheduler.ScheduledEntry: Returns the value of the interval record component.
intField(String, String, int) - Static method in interface com.botwithus.bot.api.config.ConfigField
IntField(String, String, int) - Constructor for record class com.botwithus.bot.api.config.ConfigField.IntField: Creates an instance of a IntField record class.
INV - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Inventories / containers.
INVENTION - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
INVENTION - Static variable in class com.botwithus.bot.api.util.Skills
inventories() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: Inventory table accessor.
Inventory - Record Class in com.botwithus.bot.api.snapshot: Snapshot of one inventory container.
Inventory(int, int, List) - Constructor for record class com.botwithus.bot.api.snapshot.Inventory: Creates an instance of a Inventory record class.
INVENTORY_ID - Static variable in class com.botwithus.bot.api.inventory.Backpack
INVENTORY_ID - Static variable in class com.botwithus.bot.api.inventory.Bank
INVENTORY_ID - Static variable in class com.botwithus.bot.api.inventory.Equipment
InventoryContainer - Class in com.botwithus.bot.api.inventory: Snapshot-backed wrapper for one game inventory (backpack, bank, equipment, ...).
InventoryContainer(GameAPI, int) - Constructor for class com.botwithus.bot.api.inventory.InventoryContainer: Read-only construction for ad-hoc inventories (shops, generic containers) where the script only needs item-list reads.
InventoryIds - Class in com.botwithus.bot.api.constants
InventoryItem - Record Class in com.botwithus.bot.api.snapshot: One slot of an inventory snapshot.
InventoryItem(int, int, int) - Constructor for record class com.botwithus.bot.api.snapshot.InventoryItem: Creates an instance of a InventoryItem record class.
inventoryOptions() - Method in record class com.botwithus.bot.api.model.ItemType: Returns the value of the inventoryOptions record component.
invId() - Method in record class com.botwithus.bot.api.event.ObjVarChangeEvent: Returns the value of the invId record component.
invId() - Method in class com.botwithus.bot.api.inventory.InventoryContainer
invId() - Method in record class com.botwithus.bot.api.snapshot.Inventory: Returns the value of the invId record component.
isAgentStale() - Method in record class com.botwithus.bot.api.script.LaunchedClient: Returns the value of the isAgentStale record component.
isAlive() - Method in class com.botwithus.bot.api.entities.Npc
isAvailable() - Method in interface com.botwithus.bot.api.gameval.GamevalIndex: False when no index is deployed and every lookup will return empty.
isChatOpen(GameAPI) - Static method in class com.botwithus.bot.api.dialog.Dialog: True when the text-only NPC-chat dialog (1184) is open.
isClickable() - Method in class com.botwithus.bot.api.entities.Npc
isClientAlive(String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Returns true if the named client is connected and alive.
isClosed() - Method in record class com.botwithus.bot.api.draw.DrawEntry: Returns the value of the isClosed record component.
isClosed() - Method in record class com.botwithus.bot.api.draw.DrawStyle: Returns the value of the isClosed record component.
isCombinedSection() - Method in record class com.botwithus.bot.api.snapshot.Location
isComplete() - Method in record class com.botwithus.bot.api.draw.DrawBatchResult: True when every command in the batch was accepted.
isConnected() - Method in interface com.botwithus.bot.api.Client: Checks whether this client is still connected to the game server.
isDead() - Method in class com.botwithus.bot.api.entities.Npc: Same as !isAlive().
isDefinitionVisible() - Method in class com.botwithus.bot.api.entities.Npc
isDeleted() - Method in record class com.botwithus.bot.api.snapshot.Location
isDone() - Method in record class com.botwithus.bot.api.model.WalkStatus: Returns the value of the isDone record component.
isDrawEnabled() - Method in interface com.botwithus.bot.api.domain.DrawAPI: Whether the producer is currently drawing at all (debug_draw_enable).
isEmpty() - Method in interface com.botwithus.bot.api.draw.DrawCaption: True when there is nothing to draw.
isEmpty() - Method in record class com.botwithus.bot.api.draw.DrawCaption.None
isEmpty() - Method in class com.botwithus.bot.api.inventory.InventoryContainer
isEmpty() - Method in record class com.botwithus.bot.api.snapshot.InventoryItem
isEnabled() - Method in class com.botwithus.bot.api.draw.Draw: Whether the producer is currently drawing at all.
isEnabled() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns the value of the isEnabled record component.
isEnabled(LogLevel) - Method in interface com.botwithus.bot.api.log.BotLogger
isEquipped(int) - Method in class com.botwithus.bot.api.inventory.Equipment: True when itemId is in any equipment slot.
isFilled() - Method in record class com.botwithus.bot.api.draw.DrawEntry: Returns the value of the isFilled record component.
isFilled() - Method in record class com.botwithus.bot.api.draw.DrawStyle: Returns the value of the isFilled record component.
isFollowing() - Method in class com.botwithus.bot.api.entities.Npc: True when this NPC is following another entity (Npc.followingIndex() != -1).
isFull() - Method in record class com.botwithus.bot.api.draw.DrawStats: True when the store has no room for another command.
isFull() - Method in class com.botwithus.bot.api.inventory.InventoryContainer
isHidden() - Method in class com.botwithus.bot.api.component.ComponentNode
isHidden() - Method in class com.botwithus.bot.api.entities.Npc: The snapshot only carries visible NPCs; this stub always returns false.
isHidden() - Method in class com.botwithus.bot.api.entities.SceneObject: The snapshot only carries visible objects; this stub always returns false.
isHidden() - Method in record class com.botwithus.bot.api.model.Component: True iff the producer reported this component is hidden (hidden == 1).
isHidden() - Method in record class com.botwithus.bot.api.snapshot.Location
isHole(int) - Static method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Whether descriptor means "no source chunk".
isInputOpen() - Method in class com.botwithus.bot.api.inventory.Bank: True when the withdraw-X / deposit-X dialog is up.
isInstance() - Method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Whether the scene is a dynamic region.
isInterfaceOpen(int) - Method in interface com.botwithus.bot.api.GameAPI: Convenience shim — delegates to snapshot().isInterfaceOpen(ifaceId).
isInterfaceOpen(int) - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: Whether ifaceId is currently mounted in jag::InterfaceManager's open-subs hashmap — the engine's canonical "this interface is open right now" signal.
isKnown() - Method in record class com.botwithus.bot.api.snapshot.Orientation
isMember() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Returns the value of the isMember record component.
isModal() - Method in record class com.botwithus.bot.api.snapshot.OpenInterface: Whether this is a modal: it closes when the player moves.
isMoving() - Method in class com.botwithus.bot.api.entities.Npc
isMoving() - Method in class com.botwithus.bot.api.entities.Player
isMoving() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer
isMoving() - Method in record class com.botwithus.bot.api.snapshot.Npc
isMoving() - Method in record class com.botwithus.bot.api.snapshot.Player
isNotEmpty() - Method in class com.botwithus.bot.api.inventory.InventoryContainer
isNotFull() - Method in class com.botwithus.bot.api.inventory.InventoryContainer
isOpen() - Method in class com.botwithus.bot.api.input.InputDialog: True while an input dialog of any mode is open.
isOpen() - Method in class com.botwithus.bot.api.inventory.Bank: True when the bank UI (iface 517) is open.
isOpen() - Method in class com.botwithus.bot.api.util.GrandExchange: True when the GE interface is open.
isOpen(int) - Method in class com.botwithus.bot.api.component.Components: True when the interface's root component resolves — a proxy for "this interface is currently loaded / open".
isOpen(GameAPI) - Static method in class com.botwithus.bot.api.dialog.Dialog: True when the multi-choice dialog is open with at least one selectable option.
isOpen(String) - Method in class com.botwithus.bot.api.component.Components: True when the interface named by its gameval is currently loaded.
isOpenInterfaceListComplete() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: Whether the open-interface list is known to be complete this tick: the client's count was readable and every entry made it into the snapshot.
isOverlay() - Method in record class com.botwithus.bot.api.snapshot.OpenInterface: Whether this is a persistent overlay such as a HUD panel.
isPersistent() - Method in record class com.botwithus.bot.api.draw.DrawEntry: True when this command has no expiry and lives until replaced or cleared.
isReachable(int, int) - Method in interface com.botwithus.bot.api.domain.NavigationAPI: Checks if a tile is reachable from the player's current position.
isReachable(int, int) - Method in interface com.botwithus.bot.api.Navigation: Checks if a tile is reachable from the player's current position via local A*.
isReachable(int, int, int) - Method in interface com.botwithus.bot.api.domain.NavigationAPI: Checks if a tile is reachable with a custom iteration limit.
isReachable(int, int, int) - Method in interface com.botwithus.bot.api.Navigation: Checks if a tile is reachable with a custom iteration limit.
isRequest() - Method in record class com.botwithus.bot.api.isc.ScriptMessage: Returns true if this message is part of a request/response exchange.
isResolved() - Method in record class com.botwithus.bot.api.draw.DrawEntry: Returns the value of the isResolved record component.
isResolveLagging() - Method in record class com.botwithus.bot.api.draw.DrawStats: True when more component highlights are live than the producer resolves per tick, so some of their geometry is a tick or more behind the game.
isResolverLive() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns the value of the isResolverLive record component.
isRetryable() - Method in exception class com.botwithus.bot.api.script.LauncherException
isRoot() - Method in class com.botwithus.bot.api.component.ComponentNode: True when this node has no parent in its view.
isRunning(String) - Method in interface com.botwithus.bot.api.script.ScriptManager: Returns true if the named script is currently running.
isSameFacingAs(Orientation) - Method in record class com.botwithus.bot.api.snapshot.Orientation: True when both facings are known and lie within Orientation.READBACK_TOLERANCE of each other around the circle, so 0 and 16383 count as one unit apart.
isSet() - Method in record class com.botwithus.bot.api.model.VarpRead: True when the client holds a value for the varp.
isSourceTile() - Method in class com.botwithus.bot.api.entities.Projectile: true when the source end is a fixed tile rather than an entity.
isSpellable() - Method in enum class com.botwithus.bot.api.draw.DrawKind: Whether debug_draw_set accepts this kind in its kind field.
isStopRequested() - Method in interface com.botwithus.bot.api.ScriptContext: Whether the user (or the host) has asked this script to stop.
isTargetTile() - Method in class com.botwithus.bot.api.entities.Projectile: true when the target end is a fixed tile rather than an entity.
isTerminal() - Method in enum class com.botwithus.bot.api.runtime.Liveness: true for the states a runner can never leave.
isTruncated() - Method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Whether the client's grid exceeded the wire cap and was dropped.
isTwoHanded() - Method in record class com.botwithus.bot.api.model.ItemType: Whether wearing this item also blocks the shield slot, so nothing can be worn in the off hand alongside it.
isTypeUnknown() - Method in record class com.botwithus.bot.api.snapshot.OpenInterface: Whether the producer could not publish the client's type.
isWalking() - Method in record class com.botwithus.bot.api.model.WalkStatus: Returns the value of the isWalking record component.
isWorldAnchored() - Method in record class com.botwithus.bot.api.event.SpotAnimEvent: True for a world/static spot anim — one playing on a tile with no entity (targetServerIndex == -1, equivalently targetType == 2).
ITEM - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Items.
ITEM - Enum constant in enum class com.botwithus.bot.api.inventory.Bank.WithdrawMode
itemAmount() - Method in class com.botwithus.bot.api.component.ComponentNode
itemAmount() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the itemAmount record component.
itemId() - Method in class com.botwithus.bot.api.component.ComponentNode
itemId() - Method in class com.botwithus.bot.api.entities.GroundItem
itemId() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the itemId record component.
itemId() - Method in record class com.botwithus.bot.api.model.GroundItemInfo: Returns the value of the itemId record component.
itemId() - Method in record class com.botwithus.bot.api.model.ResourceItem: Returns the value of the itemId record component.
itemId() - Method in record class com.botwithus.bot.api.snapshot.GroundItem: Returns the value of the itemId record component.
itemId() - Method in record class com.botwithus.bot.api.snapshot.InventoryItem: Returns the value of the itemId record component.
itemId(int) - Static method in interface com.botwithus.bot.api.snapshot.GroundItemFilter
itemIdField(String, String, int) - Static method in interface com.botwithus.bot.api.config.ConfigField
ItemIdField(String, String, int) - Constructor for record class com.botwithus.bot.api.config.ConfigField.ItemIdField: Creates an instance of a ItemIdField record class.
items() - Method in record class com.botwithus.bot.api.model.ResourceSection: Returns the value of the items record component.
items() - Method in record class com.botwithus.bot.api.snapshot.Inventory: Returns the value of the items record component.
ItemType - Record Class in com.botwithus.bot.api.model: Item definition from the game cache.
ItemType(int, String, boolean, boolean, int, int, int, int, int, boolean, List, List, Map) - Constructor for record class com.botwithus.bot.api.model.ItemType: Builds a definition that claims no extra wear positions; wearpos2 and wearpos3 are ItemType.NO_WEARPOS.
ItemType(int, String, boolean, boolean, int, int, int, int, int, int, int, boolean, List, List, Map) - Constructor for record class com.botwithus.bot.api.model.ItemType: Creates an instance of a ItemType record class.
iteration() - Method in record class com.botwithus.bot.api.runtime.LastCrash: Returns the value of the iteration record component.

J

JAGEX - Enum constant in enum class com.botwithus.bot.api.script.LaunchedClient.Kind
jar() - Method in record class com.botwithus.bot.api.event.ScriptLoadFailedEvent: Returns the value of the jar record component.

K

key() - Method in record class com.botwithus.bot.api.config.ConfigField.BoolField: Returns the value of the key record component.
key() - Method in record class com.botwithus.bot.api.config.ConfigField.ChoiceField: Returns the value of the key record component.
key() - Method in record class com.botwithus.bot.api.config.ConfigField.IntField: Returns the value of the key record component.
key() - Method in record class com.botwithus.bot.api.config.ConfigField.ItemIdField: Returns the value of the key record component.
key() - Method in interface com.botwithus.bot.api.config.ConfigField
key() - Method in record class com.botwithus.bot.api.config.ConfigField.StringField: Returns the value of the key record component.
key() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Area: Returns the value of the key record component.
key() - Method in record class com.botwithus.bot.api.draw.DrawCommand.ComponentTarget: Returns the value of the key record component.
key() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Ellipse: Returns the value of the key record component.
key() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Entity: Returns the value of the key record component.
key() - Method in interface com.botwithus.bot.api.draw.DrawCommand: The caller-chosen identity of this command within its connection.
key() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Line: Returns the value of the key record component.
key() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Poly: Returns the value of the key record component.
key() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Rect: Returns the value of the key record component.
key() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Text: Returns the value of the key record component.
key() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Tile: Returns the value of the key record component.
key() - Method in record class com.botwithus.bot.api.draw.DrawEntry: Returns the value of the key record component.
key() - Method in record class com.botwithus.bot.api.event.KeyInputEvent: Returns the value of the key record component.
keyChar() - Method in record class com.botwithus.bot.api.input.KeyStroke: Returns the value of the keyChar record component.
keyCode() - Method in record class com.botwithus.bot.api.input.KeyStroke: Returns the value of the keyCode record component.
KeyInputEvent - Record Class in com.botwithus.bot.api.event: Fired when a key is pressed while the overlay has keyboard focus.
KeyInputEvent(int, boolean, boolean, boolean) - Constructor for record class com.botwithus.bot.api.event.KeyInputEvent
KeyInputEvent(int, boolean, boolean, boolean, long) - Constructor for record class com.botwithus.bot.api.event.KeyInputEvent: Creates an instance of a KeyInputEvent record class.
KeyStroke - Record Class in com.botwithus.bot.api.input: One key event delivered to a component's key (type-10) CS2 trigger — the argument the trigger's script reads as its key code and key character.
KeyStroke(int, int) - Constructor for record class com.botwithus.bot.api.input.KeyStroke: Creates an instance of a KeyStroke record class.
keyTriggerArg(int) - Static method in record class com.botwithus.bot.api.input.KeyStroke: The wire argument for a key trigger fired through GameAPI.fireComponentTrigger(int, int, int, int, int), which accepts two forms.
KILL - Enum constant in enum class com.botwithus.bot.api.script.StopMode: Terminate the process at once.
kind() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Area
kind() - Method in record class com.botwithus.bot.api.draw.DrawCommand.ComponentTarget
kind() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Ellipse
kind() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Entity
kind() - Method in interface com.botwithus.bot.api.draw.DrawCommand: The primitive this command draws.
kind() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Line
kind() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Poly
kind() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Rect
kind() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Text
kind() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Tile
kind() - Method in record class com.botwithus.bot.api.draw.DrawEntry: Returns the value of the kind record component.
kind() - Method in record class com.botwithus.bot.api.model.VarpRead: Returns the value of the kind record component.
kind() - Method in record class com.botwithus.bot.api.script.LaunchedClient: Returns the value of the kind record component.

L

label() - Method in record class com.botwithus.bot.api.config.ConfigField.BoolField: Returns the value of the label record component.
label() - Method in record class com.botwithus.bot.api.config.ConfigField.ChoiceField: Returns the value of the label record component.
label() - Method in record class com.botwithus.bot.api.config.ConfigField.IntField: Returns the value of the label record component.
label() - Method in record class com.botwithus.bot.api.config.ConfigField.ItemIdField: Returns the value of the label record component.
label() - Method in interface com.botwithus.bot.api.config.ConfigField
label() - Method in record class com.botwithus.bot.api.config.ConfigField.StringField: Returns the value of the label record component.
label() - Method in record class com.botwithus.bot.api.script.LaunchedClient.LaunchedBy: Returns the value of the label record component.
label(String) - Method in class com.botwithus.bot.api.draw.DrawCaptionBuilder: Draw this text.
label(String) - Method in class com.botwithus.bot.api.draw.HighlightBuilder: Draw this text against the marker the producer resolved.
landingAt(int, int) - Static method in interface com.botwithus.bot.api.snapshot.ProjectileFilter: Projectiles that will land on the given tile.
landingAt(int, int, int) - Static method in interface com.botwithus.bot.api.snapshot.ProjectileFilter: Projectiles that will land on the given tile and plane.
LARGE - Enum constant in enum class com.botwithus.bot.api.draw.DrawFont
lastCause() - Method in record class com.botwithus.bot.api.runtime.ReconnectState.GivingUp: Returns the value of the lastCause record component.
lastCrash() - Method in record class com.botwithus.bot.api.runtime.ScriptHealth: Returns the value of the lastCrash record component.
LastCrash - Record Class in com.botwithus.bot.api.runtime: Immutable record describing a single script failure: the lifecycle phase in which the throwable surfaced, the loop iteration index at the time, the wall-clock Instant the runner observed it, and the throwable itself.
LastCrash(Phase, long, Instant, Throwable) - Constructor for record class com.botwithus.bot.api.runtime.LastCrash: Creates an instance of a LastCrash record class.
lastError() - Method in record class com.botwithus.bot.api.script.LaunchedClient.Licence: Returns the value of the lastError record component.
launch(String) - Method in interface com.botwithus.bot.api.script.ClientLauncher: ClientLauncher.launch(String, LaunchOptions) with LaunchOptions.defaults().
launch(String, LaunchOptions) - Method in interface com.botwithus.bot.api.script.ClientLauncher: Asks the service to launch a client on accountId.
launchedAt(int, int) - Static method in interface com.botwithus.bot.api.snapshot.ProjectileFilter: Projectiles launched from the given tile.
launchedBy() - Method in record class com.botwithus.bot.api.script.LaunchedClient: Returns the value of the launchedBy record component.
LaunchedBy(long, String, Optional) - Constructor for record class com.botwithus.bot.api.script.LaunchedClient.LaunchedBy: Creates an instance of a LaunchedBy record class.
LaunchedClient - Record Class in com.botwithus.bot.api.script: A client the launcher service manages, as it reported it.
LaunchedClient(String, long, String, String, int, LaunchedClient.Kind, LaunchedClient.Origin, Optional, OptionalLong, LaunchedClient.State, long, String, boolean, LaunchedClient.Licence) - Constructor for record class com.botwithus.bot.api.script.LaunchedClient: Creates an instance of a LaunchedClient record class.
LaunchedClient.Kind - Enum Class in com.botwithus.bot.api.script: What kind of client it is.
LaunchedClient.LaunchedBy - Record Class in com.botwithus.bot.api.script: The host connection that launched a client.
LaunchedClient.Licence - Record Class in com.botwithus.bot.api.script: A client's licence.
LaunchedClient.LicenceState - Enum Class in com.botwithus.bot.api.script: A licence's state; see LaunchedClient.Licence.
LaunchedClient.Origin - Enum Class in com.botwithus.bot.api.script: Who launched it: the launcher's own UI, or a host over automation.
LaunchedClient.State - Enum Class in com.botwithus.bot.api.script: Where a launch is.
LauncherAccount - Record Class in com.botwithus.bot.api.script: An account the launcher can start a client on.
LauncherAccount(String, String) - Constructor for record class com.botwithus.bot.api.script.LauncherAccount: Creates an instance of a LauncherAccount record class.
LauncherEvent - Interface in com.botwithus.bot.api.script: Something the launcher service reported, or a change in the host's link to it.
LauncherEvent.AgentUpdated - Record Class in com.botwithus.bot.api.script: The launcher has a new agent; clients injected before it are now stale.
LauncherEvent.ClientExited - Record Class in com.botwithus.bot.api.script: A client's process exited.
LauncherEvent.ClientStarted - Record Class in com.botwithus.bot.api.script: A client started: a launch reached its first record, or auto-restart replaced the process (then LaunchedClient.restartOf() is set).
LauncherEvent.ClientStateChanged - Record Class in com.botwithus.bot.api.script: A client's launch moved on.
LauncherEvent.DataPhase - Enum Class in com.botwithus.bot.api.script: Where a data update is.
LauncherEvent.DataUpdateApplied - Record Class in com.botwithus.bot.api.script: A data update was applied.
LauncherEvent.DataUpdateAvailable - Record Class in com.botwithus.bot.api.script: The state of a data update changed.
LauncherEvent.EventsDropped - Record Class in com.botwithus.bot.api.script: Events were missed: the service's sequence skipped, or this listener fell too far behind.
LauncherEvent.ExitReason - Enum Class in com.botwithus.bot.api.script: Why a client exited.
LauncherEvent.LicenceChanged - Record Class in com.botwithus.bot.api.script: The licence link, or one client's licence, changed.
LauncherEvent.ServiceLost - Record Class in com.botwithus.bot.api.script: The host lost the service.
LauncherEvent.ServiceRestored - Record Class in com.botwithus.bot.api.script: The host has the service again after a LauncherEvent.ServiceLost.
LauncherEvent.ServiceShuttingDown - Record Class in com.botwithus.bot.api.script: The service is shutting down.
LauncherException - Exception Class in com.botwithus.bot.api.script: A ClientLauncher call that failed.
LauncherException(String, String) - Constructor for exception class com.botwithus.bot.api.script.LauncherException
LauncherException(String, String, boolean, OptionalLong, Optional) - Constructor for exception class com.botwithus.bot.api.script.LauncherException
LauncherException(String, String, Throwable) - Constructor for exception class com.botwithus.bot.api.script.LauncherException
LaunchHandle - Interface in com.botwithus.bot.api.script: A launch the service has queued: ClientLauncher.launch(String, LaunchOptions).
LaunchOptions - Record Class in com.botwithus.bot.api.script: Options for ClientLauncher.launch(String, LaunchOptions).
LaunchOptions(int) - Constructor for record class com.botwithus.bot.api.script.LaunchOptions: Creates an instance of a LaunchOptions record class.
LaunchOutcome - Interface in com.botwithus.bot.api.script: How a LaunchHandle ended.
LaunchOutcome.Attached - Record Class in com.botwithus.bot.api.script: The client was injected and the host attached to it.
LaunchOutcome.AttachFailed - Record Class in com.botwithus.bot.api.script: The service injected the client, but the host could not attach to it: its pipe or its shared memory never appeared.
LaunchOutcome.Failed - Record Class in com.botwithus.bot.api.script: The launch failed before the client was injected, or the client exited first.
LAYER - Enum constant in enum class com.botwithus.bot.api.component.ComponentType
LEGS - Enum constant in enum class com.botwithus.bot.api.inventory.Equipment.Slot
level() - Method in record class com.botwithus.bot.api.model.PlayerStat: The base (unboosted) level.
level() - Method in record class com.botwithus.bot.api.model.ResourceItem: Returns the value of the level record component.
level() - Method in record class com.botwithus.bot.api.model.SkillRequirement: Returns the value of the level record component.
levelTier1() - Method in record class com.botwithus.bot.api.model.WorldMapElement: Returns the value of the levelTier1 record component.
levelTier2() - Method in record class com.botwithus.bot.api.model.WorldMapElement: Returns the value of the levelTier2 record component.
levelTier3() - Method in record class com.botwithus.bot.api.model.WorldMapElement: Returns the value of the levelTier3 record component.
licence() - Method in record class com.botwithus.bot.api.script.LaunchedClient: Returns the value of the licence record component.
Licence(LaunchedClient.LicenceState, int, Optional) - Constructor for record class com.botwithus.bot.api.script.LaunchedClient.Licence: Creates an instance of a Licence record class.
LICENCE - Enum constant in enum class com.botwithus.bot.api.script.LauncherEvent.ExitReason: Its licence lapsed.
LicenceChanged(String, Optional, Optional, OptionalInt) - Constructor for record class com.botwithus.bot.api.script.LauncherEvent.LicenceChanged: Creates an instance of a LicenceChanged record class.
Lifetime - Section in interface com.botwithus.bot.api.snapshot.DynamicRegion
limit(int) - Method in class com.botwithus.bot.api.component.ComponentQuery: Cap the number of results.
limit(int) - Method in class com.botwithus.bot.api.entities.EntityQuery: Cap the number of results.
limit(int) - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
line(String, int, int, int, int) - Method in interface com.botwithus.bot.api.draw.DrawTarget: Straight segment from (x1, y1) to (x2, y2).
Line(String, DrawSpace, DrawStyle, int, int, int, int) - Constructor for record class com.botwithus.bot.api.draw.DrawCommand.Line: Creates an instance of a Line record class.
LINE - Enum constant in enum class com.botwithus.bot.api.draw.DrawKind: Straight segment between two points.
link() - Method in record class com.botwithus.bot.api.script.LauncherEvent.LicenceChanged: Returns the value of the link record component.
list() - Method in class com.botwithus.bot.api.draw.Draw: Every command this connection currently holds.
LIST - Enum constant in enum class com.botwithus.bot.api.component.ComponentType
listAll() - Method in interface com.botwithus.bot.api.script.ScriptManager: Returns info about all known scripts (running and stopped).
listMethods() - Method in interface com.botwithus.bot.api.domain.SystemAPI: Lists all RPC method names supported by the game client.
listName() - Method in record class com.botwithus.bot.api.model.QuestType: Returns the value of the listName record component.
listRunning() - Method in interface com.botwithus.bot.api.script.ScriptManager: Returns info about currently running scripts only.
listScheduled() - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Returns every active schedule across all connected clients.
listScheduled() - Method in interface com.botwithus.bot.api.script.ScriptScheduler: Lists all active schedules.
listScheduledForClient(String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Returns active schedules on the named client.
listScheduledForGroup(String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Returns active schedules across all clients in a group.
Literal(String, DrawFont) - Constructor for record class com.botwithus.bot.api.draw.DrawCaption.Literal: Creates an instance of a Literal record class.
LIVE - Enum constant in enum class com.botwithus.bot.api.runtime.Liveness: Looping normally, or parked between loops.
Liveness - Enum Class in com.botwithus.bot.api.runtime: How responsive a script runner is, as judged by the runtime's watchdog.
liveTargets() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns the value of the liveTargets record component.
LOC - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Scenery.
LocalPlayer - Record Class in com.botwithus.bot.api.snapshot: Snapshot of the local (logged-in) player at the producer's current tick.
LocalPlayer(int, int, int, int, int, int, int, int, int, int, int, boolean, int, int, int, List) - Constructor for record class com.botwithus.bot.api.snapshot.LocalPlayer: Builds a record with an unknown facing; kept so pre-v21 callers compile unchanged.
LocalPlayer(int, int, int, int, int, int, int, int, int, int, int, boolean, int, int, int, List, Orientation) - Constructor for record class com.botwithus.bot.api.snapshot.LocalPlayer: Creates an instance of a LocalPlayer record class.
Location - Record Class in com.botwithus.bot.api.snapshot: Snapshot of one scene Location (door / tree / rock / bank / scenery tile) at the producer's current tick.
Location(int, int, int, int, int, int, int, int, int) - Constructor for record class com.botwithus.bot.api.snapshot.Location: Builds a row that is not a multiloc, deriving resolvedId from the base id.
Location(int, int, int, int, int, int, int, int, int, int) - Constructor for record class com.botwithus.bot.api.snapshot.Location: Creates an instance of a Location record class.
LocationFilter - Interface in com.botwithus.bot.api.snapshot: Predicate for filtering Location entries in a GameSnapshot.
locations() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: Scene Location table accessor (doors / trees / rocks / scenery).
LocationType - Record Class in com.botwithus.bot.api.model: Location (game object) definition from the game cache.
LocationType(int, String, int, int, int, int, boolean, List, int, int, List, int, Map) - Constructor for record class com.botwithus.bot.api.model.LocationType: Creates an instance of a LocationType record class.
LODESTONE - Static variable in class com.botwithus.bot.api.constants.InterfaceIds
LoggerFactory - Class in com.botwithus.bot.api.log: Factory for obtaining BotLogger instances.
loginProgress() - Method in record class com.botwithus.bot.api.model.LoginState: Returns the value of the loginProgress record component.
LoginState - Record Class in com.botwithus.bot.api.model: The current login state of the game client.
LoginState(int, int, int) - Constructor for record class com.botwithus.bot.api.model.LoginState: Creates an instance of a LoginState record class.
LoginStateChangeEvent - Record Class in com.botwithus.bot.api.event: Fired when the client login state changes (e.g., lobby to logged in).
LoginStateChangeEvent(int, int) - Constructor for record class com.botwithus.bot.api.event.LoginStateChangeEvent
LoginStateChangeEvent(int, int, long) - Constructor for record class com.botwithus.bot.api.event.LoginStateChangeEvent: Creates an instance of a LoginStateChangeEvent record class.
loginStatus() - Method in record class com.botwithus.bot.api.model.LoginState: Returns the value of the loginStatus record component.
loginToLobby() - Method in interface com.botwithus.bot.api.GameAPI: Triggers a login from the login screen to the lobby.
LogLevel - Enum Class in com.botwithus.bot.api.log
LOGOUT - Static variable in class com.botwithus.bot.api.util.Interfaces
LONG - Enum constant in enum class com.botwithus.bot.api.model.VarKind: A 64-bit integer.
longDelay() - Static method in class com.botwithus.bot.api.util.Timing: 600–1200ms.
loopDelay(int, double) - Static method in class com.botwithus.bot.api.util.Humanize: Returns a loop delay with variance and a 5% chance of a micro-break (2-5s).
loopOffset() - Method in record class com.botwithus.bot.api.model.SequenceType: Returns the value of the loopOffset record component.
lsb() - Method in record class com.botwithus.bot.api.model.VarbitType: Returns the value of the lsb record component.

M

MAGENTA - Static variable in class com.botwithus.bot.api.draw.Colors
MAGIC - Enum constant in enum class com.botwithus.bot.api.ScriptCategory: Magic training: alching, enchanting and other spell-based skilling.
MAGIC - Static variable in class com.botwithus.bot.api.util.Interfaces
MAGIC - Static variable in class com.botwithus.bot.api.util.Skills
mainHand() - Method in record class com.botwithus.bot.api.model.SequenceType: Returns the value of the mainHand record component.
ManagementContext - Interface in com.botwithus.bot.api.script: Context passed to ManagementScript.onStart(ManagementContext).
ManagementScript - Interface in com.botwithus.bot.api.script: Service Provider Interface for independent management scripts.
ManagementTarget - Interface in com.botwithus.bot.api.script: Something a ManagementScript has been told to manage.
ManagementTarget.ClientScript - Record Class in com.botwithus.bot.api.script: One script on one client.
ManagementTarget.Group - Record Class in com.botwithus.bot.api.script: Every client in a group, and every script on each.
ManagementTarget.WholeHost - Record Class in com.botwithus.bot.api.script: Every client on the host, and every script on each.
MAPELEMENT - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: World-map elements.
mapElements() - Method in interface com.botwithus.bot.api.GameAPI: World-map element query facade.
mapSpriteId() - Method in record class com.botwithus.bot.api.model.LocationType: Returns the value of the mapSpriteId record component.
MAPSQUARE_CHUNK_SHIFT - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion: mapX << MAPSQUARE_CHUNK_SHIFT converts a mapsquare to its first chunk — the x8 in the UNITS TRAP above.
MATERIAL - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Materials / textures.
MAX_AMOUNT_LENGTH - Static variable in class com.botwithus.bot.api.input.InputDialog: Longest value amount mode accepts, suffix included.
MAX_AMOUNT_VALUE - Static variable in class com.botwithus.bot.api.input.InputDialog: Largest value amount mode takes, after suffix expansion.
MAX_BATCH_ITEMS - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Most items one debug_draw_set_batch accepts.
MAX_COMMANDS - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Retained commands per producer, across every connected client.
MAX_DECIMALS - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Most decimal places a fixed-point caption may be scaled by.
MAX_EXTENT - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Largest width or height a rect or ellipse may have.
MAX_KEY_BYTES - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Longest key the producer stores, in UTF-8 bytes — its buffer is 48 bytes including the NUL.
MAX_NAME_LENGTH - Static variable in class com.botwithus.bot.api.input.InputDialog: Longest value name mode accepts.
MAX_PLANE - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Highest plane a world highlight may name.
MAX_POLY_COMMANDS - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Retained poly commands, across every connected client.
MAX_POLY_POINTS - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Most points a polyline may have.
MAX_ROTATION - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion: Highest valid rotation — the inclusive bound for a range check.
MAX_SCREEN_COORDINATE - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Largest absolute value a screen coordinate may take.
MAX_TEXT_COMMANDS - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Retained text commands, across every connected client.
MAX_TEXT_LENGTH - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Longest text a text command may carry, in UTF-16 code units — the producer converts the UTF-8 payload into a 128-unit wide buffer and fails the command rather than truncating when it will not fit.
MAX_THICKNESS - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Thickest stroke.
MAX_WORLD_COORDINATE - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Largest absolute value a world coordinate may take, in wire sub-tiles.
MAX_WORLD_TILE - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Largest absolute value a tile coordinate or tile extent may take, for the highlight_* calls that speak whole tiles rather than sub-tiles.
MAX_Z - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Highest paint order.
maxDuration() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScheduledScriptEntry: Returns the value of the maxDuration record component.
maxDuration() - Method in record class com.botwithus.bot.api.script.ScriptScheduler.ScheduledEntry: Returns the value of the maxDuration record component.
maxHealth() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Returns the value of the maxHealth record component.
maxHp() - Method in class com.botwithus.bot.api.entities.Npc
maxHp() - Method in record class com.botwithus.bot.api.snapshot.Npc: Returns the value of the maxHp record component.
maxIterations() - Method in record class com.botwithus.bot.api.model.WorldPathConfig: Returns the value of the maxIterations record component.
maxIterations(int) - Method in class com.botwithus.bot.api.model.WorldPathConfig.Builder
maxLoops() - Method in record class com.botwithus.bot.api.model.SequenceType: Returns the value of the maxLoops record component.
maxMapX() - Method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Maximum loaded MAPSQUARE X.
maxMapY() - Method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Maximum loaded MAPSQUARE Y.
MEDIA - Enum constant in enum class com.botwithus.bot.api.component.ComponentType
mediumDelay() - Static method in class com.botwithus.bot.api.util.Timing: 300–600ms.
members() - Method in record class com.botwithus.bot.api.model.ItemType: Returns the value of the members record component.
members() - Method in record class com.botwithus.bot.api.model.LocationType: Returns the value of the members record component.
membersOnly() - Method in record class com.botwithus.bot.api.model.QuestType: Returns the value of the membersOnly record component.
membersOnly() - Method in record class com.botwithus.bot.api.model.WorldMapPlacement: Returns the value of the membersOnly record component.
merge(DrawBatchResult) - Method in record class com.botwithus.bot.api.draw.DrawBatchResult: This result combined with a later one, for a frame large enough to need more than one DrawLimits.MAX_BATCH_ITEMS-item batch.
message() - Method in record class com.botwithus.bot.api.event.ChatMessageEvent: Returns the value of the message record component.
message() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.OpResult: Returns the value of the message record component.
message() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScheduleOpResult: Returns the value of the message record component.
message() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ClientStateChanged: Returns the value of the message record component.
message() - Method in record class com.botwithus.bot.api.script.LaunchOutcome.AttachFailed: Returns the value of the message record component.
message() - Method in record class com.botwithus.bot.api.script.LaunchOutcome.Failed: Returns the value of the message record component.
MessageBus - Interface in com.botwithus.bot.api.isc: Async pub/sub message bus for inter-script communication over named channels.
messageType() - Method in record class com.botwithus.bot.api.model.ChatMessage: Returns the value of the messageType record component.
meta(String) - Method in interface com.botwithus.bot.api.gameval.GamevalIndex: A value from the index's build stamp — built, source_mtime, rows, groups, schema_version.
MIDI - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Music tracks.
MIN_PLANE - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Lowest plane a world highlight may name.
MIN_POLY_POINTS - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Fewest points a polyline may have.
MIN_THICKNESS - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Thinnest stroke.
MIN_Z - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Lowest paint order.
MINIGAME - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
MINIMAP - Static variable in class com.botwithus.bot.api.constants.InterfaceIds
MINIMAP - Static variable in class com.botwithus.bot.api.util.Interfaces
MINING - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
MINING - Static variable in class com.botwithus.bot.api.constants.AnimationIds
MINING - Static variable in class com.botwithus.bot.api.util.Skills
minLevel() - Method in record class com.botwithus.bot.api.model.WorldMapElement: Returns the value of the minLevel record component.
minQuantity(int) - Static method in interface com.botwithus.bot.api.snapshot.GroundItemFilter
mode() - Method in class com.botwithus.bot.api.input.InputDialog: What the dialog is asking for; InputMode.CLOSED when it is not open.
MODEL - Enum constant in enum class com.botwithus.bot.api.component.ComponentType
MODEL - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Models.
MONEYMAKING - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
moving() - Static method in interface com.botwithus.bot.api.snapshot.NpcFilter
moving() - Static method in interface com.botwithus.bot.api.snapshot.PlayerFilter
msb() - Method in record class com.botwithus.bot.api.model.VarbitType: Returns the value of the msb record component.
MULTI_CHOICE_INTERFACE - Static variable in class com.botwithus.bot.api.dialog.Dialog: The multi-choice dialog interface ("select an option").

N

name() - Method in class com.botwithus.bot.api.entities.GroundItem
name() - Method in class com.botwithus.bot.api.entities.Npc
name() - Method in class com.botwithus.bot.api.entities.SceneObject: Display name.
name() - Method in record class com.botwithus.bot.api.model.ItemType: Returns the value of the name record component.
name() - Method in record class com.botwithus.bot.api.model.LocationType: Returns the value of the name record component.
name() - Method in record class com.botwithus.bot.api.model.NpcType: Returns the value of the name record component.
name() - Method in record class com.botwithus.bot.api.model.QuestType: Returns the value of the name record component.
name() - Method in record class com.botwithus.bot.api.model.SceneObjectInfo: Returns the value of the name record component.
name() - Method in record class com.botwithus.bot.api.model.WorldMapElement: Returns the value of the name record component.
name() - Method in record class com.botwithus.bot.api.script.LauncherAccount: Returns the value of the name record component.
name() - Method in record class com.botwithus.bot.api.script.ManagementTarget.Group: Returns the value of the name record component.
name() - Method in record class com.botwithus.bot.api.script.ScriptInfo: Returns the value of the name record component.
name() - Method in interface com.botwithus.bot.api.script.Task: Display name for logging/debugging.
name() - Element in annotation interface com.botwithus.bot.api.ScriptManifest: The display name of the script.
NAME - Enum constant in enum class com.botwithus.bot.api.input.InputMode: A player name ("Enter name of friend to add to list").
named(String) - Method in class com.botwithus.bot.api.entities.EntityQuery: Filter by display name (case-insensitive substring).
named(String) - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
namedExact(String) - Method in class com.botwithus.bot.api.entities.EntityQuery: Filter by display name (case-insensitive exact match).
nameMatching(String) - Method in class com.botwithus.bot.api.entities.EntityQuery: Filter by display name (regex match against the full name).
Navigation - Interface in com.botwithus.bot.api: High-level navigation interface providing blocking walk operations.
NavigationAPI - Interface in com.botwithus.bot.api.domain: Navigation and pathfinding.
navStep() - Method in record class com.botwithus.bot.api.model.WalkStatus: Returns the value of the navStep record component.
near(int, int, int) - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
nearest() - Method in class com.botwithus.bot.api.entities.EntityQuery: Nearest result, or null when no match.
nearest() - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
nearest(int) - Method in class com.botwithus.bot.api.entities.Npcs: Nearest NPC of the given type id, or null.
nearest(int) - Method in class com.botwithus.bot.api.entities.SceneObjects
nearest(String) - Method in class com.botwithus.bot.api.entities.Npcs: Nearest NPC matching name (case-insensitive contains), or null.
nearest(String) - Method in class com.botwithus.bot.api.entities.SceneObjects
nearest(String) - Method in class com.botwithus.bot.api.entities.WorldMapElements: Convenience: nearest element with the given name (case-insensitive contains).
nearestByGameval(String) - Method in class com.botwithus.bot.api.entities.GroundItems: Nearest ground stack of the item with the given gameval name (e.g.
nearestByGameval(String) - Method in class com.botwithus.bot.api.entities.Npcs: Nearest NPC with the given gameval name (e.g.
nearestByGameval(String) - Method in class com.botwithus.bot.api.entities.SceneObjects: Nearest scene object with the given gameval name (e.g.
nearestIncoming() - Method in class com.botwithus.bot.api.entities.Projectiles: The incoming projectile landing nearest the local player, or null when nothing is inbound.
nearPlayer() - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query: Default radius around the local player (covers a typical map view).
nearPlayer(int) - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
NECK - Enum constant in enum class com.botwithus.bot.api.inventory.Equipment.Slot
NECROMANCY - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
NECROMANCY - Static variable in class com.botwithus.bot.api.util.Skills
negate() - Method in interface com.botwithus.bot.api.snapshot.GroundItemFilter
negate() - Method in interface com.botwithus.bot.api.snapshot.LocationFilter
negate() - Method in interface com.botwithus.bot.api.snapshot.NpcFilter
negate() - Method in interface com.botwithus.bot.api.snapshot.PlayerFilter
negate() - Method in interface com.botwithus.bot.api.snapshot.ProjectileFilter
newState() - Method in record class com.botwithus.bot.api.event.LoginStateChangeEvent: Returns the value of the newState record component.
newValue() - Method in record class com.botwithus.bot.api.event.ObjVarChangeEvent: Returns the value of the newValue record component.
newValue() - Method in record class com.botwithus.bot.api.event.VarbitChangeEvent: Returns the value of the newValue record component.
newValue() - Method in record class com.botwithus.bot.api.event.VarcChangeEvent: Returns the value of the newValue record component.
newValue() - Method in record class com.botwithus.bot.api.event.VarChangeEvent: Returns the value of the newValue record component.
nextDelayMs() - Method in record class com.botwithus.bot.api.runtime.ReconnectState.Reconnecting: Returns the value of the nextDelayMs record component.
nextRun() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScheduledScriptEntry: Returns the value of the nextRun record component.
nextRun() - Method in record class com.botwithus.bot.api.script.ScriptScheduler.ScheduledEntry: Returns the value of the nextRun record component.
NO_CHARACTER - Static variable in record class com.botwithus.bot.api.script.LaunchOptions: No particular character: the account's default.
NO_CHUNK - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion: Descriptor value meaning "this grid cell has no source chunk".
NO_EXPIRY - Static variable in record class com.botwithus.bot.api.draw.DrawEntry: Milliseconds reported for a command that never expires.
NO_KEY_CHAR - Static variable in record class com.botwithus.bot.api.input.KeyStroke: KeyStroke.keyChar() of a stroke that carries only a key code.
NO_KEY_CODE - Static variable in record class com.botwithus.bot.api.input.KeyStroke: KeyStroke.keyCode() of a stroke that carries only a character.
NO_SOURCE - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion: DynamicRegion.sourceOfPacked(int, int, int) result meaning "no source tile".
NO_SUCH_VARP - Enum constant in enum class com.botwithus.bot.api.model.VarpState: The cache has no varp with this id.
NO_VALUE - Static variable in record class com.botwithus.bot.api.model.VarpRead: The value reported for VarpState.NO_SUCH_VARP and VarpState.UNAVAILABLE.
NO_WEARPOS - Static variable in record class com.botwithus.bot.api.model.ItemType: The cache's value for a wear position the item does not claim.
node(int, int) - Method in class com.botwithus.bot.api.component.ComponentTree: First node matching (interfaceId, componentId), or null.
nodes() - Method in class com.botwithus.bot.api.component.ComponentTree: All nodes in breadth-first order.
None() - Constructor for record class com.botwithus.bot.api.draw.DrawCaption.None: Creates an instance of a None record class.
NONE - Static variable in interface com.botwithus.bot.api.draw.DrawCaption: No caption.
NOOP - Static variable in interface com.botwithus.bot.api.debug.ScriptContextPublisher: No-op publisher.
NORMAL - Enum constant in enum class com.botwithus.bot.api.draw.DrawFont: The default.
NORTH - Enum constant in enum class com.botwithus.bot.api.snapshot.Direction
NORTH_EAST - Enum constant in enum class com.botwithus.bot.api.snapshot.Direction
NORTH_RAW - Static variable in record class com.botwithus.bot.api.snapshot.Orientation: The raw angle that faces north (+tileY).
NORTH_WEST - Enum constant in enum class com.botwithus.bot.api.snapshot.Direction
NOT_PERMITTED - Static variable in exception class com.botwithus.bot.api.script.LauncherException: The call is outside this script's targets, or not allowed on this surface.
NOTE - Enum constant in enum class com.botwithus.bot.api.inventory.Bank.WithdrawMode
notedId() - Method in record class com.botwithus.bot.api.model.ItemType: Returns the value of the notedId record component.
notMoving() - Static method in interface com.botwithus.bot.api.snapshot.NpcFilter
notMoving() - Static method in interface com.botwithus.bot.api.snapshot.PlayerFilter
npc(Npc) - Method in interface com.botwithus.bot.api.draw.DrawTarget: Highlight an NPC under the conventional auto key npc:<index>.
npc(String, Npc) - Method in interface com.botwithus.bot.api.draw.DrawTarget: Highlight an NPC, tracked.
npc(String, Npc, int, int) - Method in interface com.botwithus.bot.api.draw.DrawTarget: Highlight an NPC, tracked, with a footprint in tiles.
Npc - Class in com.botwithus.bot.api.entities: Rich wrapper around a snapshot Npc record plus the cached NpcType definition.
Npc - Record Class in com.botwithus.bot.api.snapshot: Snapshot of one NPC at the producer's current tick.
Npc(int, int, int, int, int, int, int, int, int, int, int, int) - Constructor for record class com.botwithus.bot.api.snapshot.Npc: Builds a row with an unknown facing; kept so pre-v21 callers compile unchanged.
Npc(int, int, int, int, int, int, int, int, int, int, int, int, Orientation) - Constructor for record class com.botwithus.bot.api.snapshot.Npc: Creates an instance of a Npc record class.
NPC - Enum constant in enum class com.botwithus.bot.api.draw.EntityRef: An NPC, by its server-side NPC slot.
NPC - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: NPCs.
NPC_CHAT_INTERFACE - Static variable in class com.botwithus.bot.api.dialog.Dialog: The text-only NPC-chat dialog interface (no options, just a continue button).
NPC_OPTIONS - Static variable in class com.botwithus.bot.api.inventory.ActionTypes: NPC option action IDs indexed by 1-based option slot (slot 0 unused).
NPC1 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
NPC2 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
NPC3 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
NPC4 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
NPC5 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
NPC6 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
NpcFilter - Interface in com.botwithus.bot.api.snapshot: Predicate for filtering Npc entries in a GameSnapshot.
npcs() - Method in interface com.botwithus.bot.api.GameAPI: NPC query facade.
npcs() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: NPC table accessor.
Npcs - Class in com.botwithus.bot.api.entities: NPC query facade.
Npcs(GameAPI) - Constructor for class com.botwithus.bot.api.entities.Npcs
Npcs.Query - Class in com.botwithus.bot.api.entities: Query subclass — wires the snapshot stream + name resolution to EntityQuery.
NpcType - Record Class in com.botwithus.bot.api.model: NPC definition from the game cache.
NpcType(int, String, int, boolean, boolean, List, int, int, List, Map) - Constructor for record class com.botwithus.bot.api.model.NpcType: Creates an instance of a NpcType record class.

O

OBJECT_OPTIONS - Static variable in class com.botwithus.bot.api.inventory.ActionTypes: Object option action IDs indexed by 1-based option slot.
OBJECT1 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
OBJECT2 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
OBJECT3 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
OBJECT4 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
OBJECT5 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
OBJECT6 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
objects() - Method in interface com.botwithus.bot.api.GameAPI: Scene-object query facade.
ObjVarChangeEvent - Record Class in com.botwithus.bot.api.event: Fired when a per-item obj var changes value.
ObjVarChangeEvent(int, int, int, int, int) - Constructor for record class com.botwithus.bot.api.event.ObjVarChangeEvent
ObjVarChangeEvent(int, int, int, int, int, long) - Constructor for record class com.botwithus.bot.api.event.ObjVarChangeEvent: Creates an instance of a ObjVarChangeEvent record class.
occupiedSlots() - Method in class com.botwithus.bot.api.inventory.InventoryContainer
of(long, int) - Static method in interface com.botwithus.bot.api.draw.DrawCaption: A number, scaled.
of(long, int, DrawFont) - Static method in interface com.botwithus.bot.api.draw.DrawCaption: A number, scaled, in a named style.
of(String) - Static method in interface com.botwithus.bot.api.draw.DrawCaption: A caption drawn as-is.
of(String, DrawFont) - Static method in interface com.botwithus.bot.api.draw.DrawCaption: A caption drawn as-is, in a named style.
offHand() - Method in record class com.botwithus.bot.api.model.SequenceType: Returns the value of the offHand record component.
ofType(ComponentType...) - Method in class com.botwithus.bot.api.component.ComponentQuery: Filter to any of the given categories.
OK - Enum constant in enum class com.botwithus.bot.api.script.LaunchedClient.LicenceState: The last refresh succeeded.
oldState() - Method in record class com.botwithus.bot.api.event.LoginStateChangeEvent: Returns the value of the oldState record component.
oldValue() - Method in record class com.botwithus.bot.api.event.ObjVarChangeEvent: Returns the value of the oldValue record component.
oldValue() - Method in record class com.botwithus.bot.api.event.VarbitChangeEvent: Returns the value of the oldValue record component.
oldValue() - Method in record class com.botwithus.bot.api.event.VarcChangeEvent: Returns the value of the oldValue record component.
oldValue() - Method in record class com.botwithus.bot.api.event.VarChangeEvent: Returns the value of the oldValue record component.
ON_CONFIG_UPDATE - Enum constant in enum class com.botwithus.bot.api.runtime.Phase
ON_LOOP - Enum constant in enum class com.botwithus.bot.api.runtime.Phase
ON_START - Enum constant in enum class com.botwithus.bot.api.runtime.Phase
ON_STOP - Enum constant in enum class com.botwithus.bot.api.runtime.Phase
onConfigUpdate(ScriptConfig) - Method in interface com.botwithus.bot.api.BotScript: Called when the script's configuration is updated (at startup from persisted values, or at runtime from the config UI).
onConfigUpdate(ScriptConfig) - Method in interface com.botwithus.bot.api.script.ManagementScript: Called when configuration is updated.
onConfigUpdate(ScriptConfig) - Method in class com.botwithus.bot.api.script.TaskScript
ONE - Enum constant in enum class com.botwithus.bot.api.inventory.Bank.TransferAmount
One script walks at a time - Section in interface com.botwithus.bot.api.domain.NavigationAPI
onEvent(Consumer) - Method in interface com.botwithus.bot.api.script.ClientLauncher: Registers a listener for launcher events.
onLoop() - Method in interface com.botwithus.bot.api.BotScript: Called repeatedly while the script is running.
onLoop() - Method in interface com.botwithus.bot.api.script.ManagementScript: Called repeatedly while the script is running.
onLoop() - Method in class com.botwithus.bot.api.script.TaskScript
onPlane(int) - Method in class com.botwithus.bot.api.entities.EntityQuery: Filter to a specific plane.
onPlane(int) - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
onPlane(int) - Static method in interface com.botwithus.bot.api.snapshot.GroundItemFilter
onPlane(int) - Static method in interface com.botwithus.bot.api.snapshot.LocationFilter
onPlane(int) - Static method in interface com.botwithus.bot.api.snapshot.NpcFilter
onPlane(int) - Static method in interface com.botwithus.bot.api.snapshot.PlayerFilter
onPlane(int) - Static method in interface com.botwithus.bot.api.snapshot.ProjectileFilter
onStart(ManagementContext) - Method in interface com.botwithus.bot.api.script.ManagementScript: Called once when the script is started.
onStart(ScriptContext) - Method in interface com.botwithus.bot.api.BotScript: Called once when the script is started.
onStart(ScriptContext) - Method in class com.botwithus.bot.api.script.TaskScript
onStop() - Method in interface com.botwithus.bot.api.BotScript: Called once when the script is stopped, either by returning -1 from BotScript.onLoop() or by an external stop request.
onStop() - Method in interface com.botwithus.bot.api.script.ManagementScript: Called once when the script is stopped.
onStop() - Method in class com.botwithus.bot.api.script.TaskScript
OPAQUE - Static variable in class com.botwithus.bot.api.draw.Colors: Fully opaque alpha, as it appears in the top byte of an ARGB value.
opcode() - Method in record class com.botwithus.bot.api.event.RadioGroupSelectEvent: Returns the value of the opcode record component.
openInterface(int) - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: The open sub-interface ifaceId with its open type, or empty when it is not in this snapshot's list.
OpenInterface - Record Class in com.botwithus.bot.api.snapshot: One open sub-interface as the snapshot publishes it (wire v23): its id, how the client opened it, and whether a client script rather than the server did the opening.
OpenInterface(int, int, boolean) - Constructor for record class com.botwithus.bot.api.snapshot.OpenInterface: Creates an instance of a OpenInterface record class.
openInterfaceCount() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: How many open sub-interfaces this snapshot lists — the set GameSnapshot.isInterfaceOpen(int) searches.
openInterfaces() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: Every open sub-interface this snapshot lists, with how each was opened (wire v23) — the same GameSnapshot.openInterfaceCount() entries GameSnapshot.isInterfaceOpen(int) searches, in the producer's order.
openInterfaceTotal() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: How many sub-interfaces the client itself reports open this tick, or 0 when that could not be read.
OpResult(boolean, String, String, String) - Constructor for record class com.botwithus.bot.api.script.ClientOrchestrator.OpResult: Creates an instance of a OpResult record class.
options() - Method in record class com.botwithus.bot.api.model.LocationType: Returns the value of the options record component.
options() - Method in record class com.botwithus.bot.api.model.NpcType: Returns the value of the options record component.
options() - Method in record class com.botwithus.bot.api.model.SceneObjectInfo: Returns the value of the options record component.
options(GameAPI) - Static method in class com.botwithus.bot.api.dialog.Dialog: The selectable options currently shown, in display order.
or(Predicate) - Method in interface com.botwithus.bot.api.snapshot.GroundItemFilter
or(Predicate) - Method in interface com.botwithus.bot.api.snapshot.LocationFilter
or(Predicate) - Method in interface com.botwithus.bot.api.snapshot.NpcFilter
or(Predicate) - Method in interface com.botwithus.bot.api.snapshot.PlayerFilter
or(Predicate) - Method in interface com.botwithus.bot.api.snapshot.ProjectileFilter
ORANGE - Static variable in class com.botwithus.bot.api.draw.Colors
orientation() - Method in class com.botwithus.bot.api.entities.Npc: Which way this NPC is facing (wire v21): its rendered facing, interpolated while it turns.
orientation() - Method in class com.botwithus.bot.api.entities.Player: Which way this player is facing (wire v21): its rendered facing, interpolated while it turns.
orientation() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Returns the value of the orientation record component.
orientation() - Method in record class com.botwithus.bot.api.snapshot.Npc: Returns the value of the orientation record component.
orientation() - Method in record class com.botwithus.bot.api.snapshot.Player: Returns the value of the orientation record component.
Orientation - Record Class in com.botwithus.bot.api.snapshot: Which way an entity is facing, as the client stores it (wire v21).
Orientation(int) - Constructor for record class com.botwithus.bot.api.snapshot.Orientation: Creates an instance of a Orientation record class.
origin() - Method in record class com.botwithus.bot.api.script.LaunchedClient: Returns the value of the origin record component.
originMapX() - Method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Minimum loaded MAPSQUARE X — the grid's origin.
originMapY() - Method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Minimum loaded MAPSQUARE Y — the grid's origin.
OTHER - Enum constant in enum class com.botwithus.bot.api.input.InputMode: A dialog is open in a mode this API has no verified limits for.
OTHER - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
outcome() - Method in interface com.botwithus.bot.api.script.LaunchHandle: Completes once, when the launch has an outcome: the host attached to the client, the launch failed, or the client was injected but the host could not attach to it.
outputTypeId() - Method in record class com.botwithus.bot.api.model.EnumType: Returns the value of the outputTypeId record component.
ownIndex() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: Local player's server index, or negative if not in-game.

P

packed() - Method in record class com.botwithus.bot.api.input.KeyStroke: The trigger argument this stroke travels as: (keyCode << 16) | keyChar, the code sign-carried in the high half.
packSource(int, int, int, int) - Static method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Packs a resolved source tile the way DynamicRegion.sourceOfPacked(int, int, int) returns it.
PARAM - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Params (struct/def attribute keys).
param1() - Method in record class com.botwithus.bot.api.event.ActionExecutedEvent: Returns the value of the param1 record component.
param1() - Method in record class com.botwithus.bot.api.model.ActionEntry: Returns the value of the param1 record component.
param1() - Method in record class com.botwithus.bot.api.model.GameAction: Returns the value of the param1 record component.
param2() - Method in record class com.botwithus.bot.api.event.ActionExecutedEvent: Returns the value of the param2 record component.
param2() - Method in record class com.botwithus.bot.api.model.ActionEntry: Returns the value of the param2 record component.
param2() - Method in record class com.botwithus.bot.api.model.GameAction: Returns the value of the param2 record component.
param3() - Method in record class com.botwithus.bot.api.event.ActionExecutedEvent: Returns the value of the param3 record component.
param3() - Method in record class com.botwithus.bot.api.model.ActionEntry: Returns the value of the param3 record component.
param3() - Method in record class com.botwithus.bot.api.model.GameAction: Returns the value of the param3 record component.
params() - Method in record class com.botwithus.bot.api.model.ItemType: Returns the value of the params record component.
params() - Method in record class com.botwithus.bot.api.model.LocationType: Returns the value of the params record component.
params() - Method in record class com.botwithus.bot.api.model.NpcType: Returns the value of the params record component.
params() - Method in record class com.botwithus.bot.api.model.QuestType: Returns the value of the params record component.
params() - Method in record class com.botwithus.bot.api.model.SequenceType: Returns the value of the params record component.
params() - Method in record class com.botwithus.bot.api.model.StructType: Returns the value of the params record component.
parent() - Method in class com.botwithus.bot.api.component.ComponentNode: Parent node, or null at the root / for a detached node.
parentIndex() - Method in record class com.botwithus.bot.api.model.ComponentTreeNode: Returns the value of the parentIndex record component.
path() - Method in record class com.botwithus.bot.api.model.PathResult: Returns the value of the path record component.
pathLength() - Method in record class com.botwithus.bot.api.model.PathResult: Returns the value of the pathLength record component.
PathResult - Record Class in com.botwithus.bot.api.model: Result of a pathfinding query.
PathResult(boolean, int, List) - Constructor for record class com.botwithus.bot.api.model.PathResult: Creates an instance of a PathResult record class.
payload() - Method in record class com.botwithus.bot.api.isc.ScriptMessage: Returns the value of the payload record component.
pendingCount() - Method in class com.botwithus.bot.api.draw.DrawFrame: How many commands are waiting to be sent, of both families.
pendingHighlightCount() - Method in class com.botwithus.bot.api.draw.DrawFrame: How many of the pending commands are highlights — which is how many round-trips beyond the batch a flush will cost, since none of them can be batched.
phase() - Method in record class com.botwithus.bot.api.runtime.LastCrash: Returns the value of the phase record component.
phase() - Method in record class com.botwithus.bot.api.script.LauncherEvent.DataUpdateAvailable: Returns the value of the phase record component.
Phase - Enum Class in com.botwithus.bot.api.runtime: Identifies which lifecycle hook of a BotScript was executing when an event of interest (typically a crash) occurred.
pickAt(int, int) - Method in class com.botwithus.bot.api.component.Components: Detached node for the component under a screen-space coordinate, or null when nothing is there.
pid() - Method in record class com.botwithus.bot.api.script.LaunchedClient.LaunchedBy: Returns the value of the pid record component.
pid() - Method in record class com.botwithus.bot.api.script.LaunchedClient: Returns the value of the pid record component.
ping() - Method in interface com.botwithus.bot.api.domain.SystemAPI: Tests connectivity to the game client.
placements() - Method in record class com.botwithus.bot.api.model.WorldMapElement: Returns the value of the placements record component.
plane() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Area: Returns the value of the plane record component.
plane() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Tile: Returns the value of the plane record component.
plane() - Method in interface com.botwithus.bot.api.entities.EntityContext: Plane / height level (0-3).
plane() - Method in class com.botwithus.bot.api.entities.GroundItem
plane() - Method in class com.botwithus.bot.api.entities.Npc
plane() - Method in class com.botwithus.bot.api.entities.Player
plane() - Method in class com.botwithus.bot.api.entities.Projectile
plane() - Method in class com.botwithus.bot.api.entities.SceneObject
plane() - Method in record class com.botwithus.bot.api.event.SpotAnimEvent: Returns the value of the plane record component.
plane() - Method in record class com.botwithus.bot.api.model.GroundItemInfo: Returns the value of the plane record component.
plane() - Method in record class com.botwithus.bot.api.model.SceneObjectInfo: Returns the value of the plane record component.
plane() - Method in record class com.botwithus.bot.api.model.WorldMapElement: Returns the value of the plane record component.
plane() - Method in record class com.botwithus.bot.api.model.WorldMapPlacement: Returns the value of the plane record component.
plane() - Method in record class com.botwithus.bot.api.snapshot.GroundItem: Returns the value of the plane record component.
plane() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Returns the value of the plane record component.
plane() - Method in record class com.botwithus.bot.api.snapshot.Location: Returns the value of the plane record component.
plane() - Method in record class com.botwithus.bot.api.snapshot.Npc: Returns the value of the plane record component.
plane() - Method in record class com.botwithus.bot.api.snapshot.Player: Returns the value of the plane record component.
plane() - Method in record class com.botwithus.bot.api.snapshot.Projectile: Returns the value of the plane record component.
plane() - Method in record class com.botwithus.bot.api.snapshot.SourceTile: Returns the value of the plane record component.
PLANE_COUNT - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion: Planes in a scene, and the outer dimension of the descriptor grid.
player(Player) - Method in interface com.botwithus.bot.api.draw.DrawTarget: Highlight another player under the conventional auto key player:<index>.
player(String, Player) - Method in interface com.botwithus.bot.api.draw.DrawTarget: Highlight another player, tracked.
Player - Class in com.botwithus.bot.api.entities: Rich wrapper around a snapshot Player record.
Player - Record Class in com.botwithus.bot.api.snapshot: Snapshot of one player at the producer's current tick.
Player(int, int, int, int, int, int, int, int, int, int) - Constructor for record class com.botwithus.bot.api.snapshot.Player: Builds a row with an unknown facing; kept so pre-v21 callers compile unchanged.
Player(int, int, int, int, int, int, int, int, int, int, Orientation) - Constructor for record class com.botwithus.bot.api.snapshot.Player: Creates an instance of a Player record class.
PLAYER - Enum constant in enum class com.botwithus.bot.api.draw.EntityRef: Another player, by its server-side player slot.
PLAYER_OPTIONS - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
PLAYER1 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
PLAYER10 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
PLAYER2 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
PLAYER3 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
PLAYER4 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
PLAYER5 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
PLAYER6 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
PLAYER7 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
PLAYER8 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
PLAYER9 - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
PlayerFilter - Interface in com.botwithus.bot.api.snapshot: Predicate for filtering Player entries in a GameSnapshot.
playerName() - Method in record class com.botwithus.bot.api.model.ChatMessage: Returns the value of the playerName record component.
players() - Method in interface com.botwithus.bot.api.GameAPI: Player query facade.
players() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: Player table accessor.
Players - Class in com.botwithus.bot.api.entities: Player query facade.
Players(GameAPI) - Constructor for class com.botwithus.bot.api.entities.Players
Players.Query - Class in com.botwithus.bot.api.entities
PlayerStat - Record Class in com.botwithus.bot.api.model: Snapshot of one of the local player's skill stats.
PlayerStat(int, int, int, int) - Constructor for record class com.botwithus.bot.api.model.PlayerStat: Creates an instance of a PlayerStat record class.
POCKET - Enum constant in enum class com.botwithus.bot.api.inventory.Equipment.Slot
points() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Poly: Returns the value of the points record component.
poly(String, List) - Method in interface com.botwithus.bot.api.draw.DrawTarget: Polyline over a flat [x, y, x, y, ...] list.
Poly(String, DrawSpace, DrawStyle, List) - Constructor for record class com.botwithus.bot.api.draw.DrawCommand.Poly: Creates an instance of a Poly record class.
POLY - Enum constant in enum class com.botwithus.bot.api.draw.DrawKind: Open or closed polyline of 2..32 points.
polySlotCapacity() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns the value of the polySlotCapacity record component.
polySlotsUsed() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns the value of the polySlotsUsed record component.
poppedOut() - Method in interface com.botwithus.bot.api.ui.ScriptUiHost: True when the UI is in its own pop-out window, false when docked in the host.
PRAYER - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
PRAYER - Static variable in class com.botwithus.bot.api.constants.InterfaceIds
PRAYER - Static variable in class com.botwithus.bot.api.util.Interfaces
PRAYER - Static variable in class com.botwithus.bot.api.util.Skills
presentFailures() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns the value of the presentFailures record component.
PRESETS - Enum constant in enum class com.botwithus.bot.api.inventory.Bank.BankSetting
priority() - Method in record class com.botwithus.bot.api.model.SequenceType: Returns the value of the priority record component.
priority() - Method in interface com.botwithus.bot.api.script.Task: Higher priority tasks are checked first.
progressVarbits() - Method in record class com.botwithus.bot.api.model.QuestType: Returns the value of the progressVarbits record component.
progressVarps() - Method in record class com.botwithus.bot.api.model.QuestType: Returns the value of the progressVarps record component.
Projectile - Class in com.botwithus.bot.api.entities: Rich wrapper around a snapshot Projectile record — one in-flight projectile at the producer's current tick (v17+).
Projectile - Record Class in com.botwithus.bot.api.snapshot: Snapshot of one in-flight projectile at the producer's current tick (v17+).
Projectile(int, int, int, int, int, int, int, int, int, int, int, int) - Constructor for record class com.botwithus.bot.api.snapshot.Projectile: Creates an instance of a Projectile record class.
ProjectileFilter - Interface in com.botwithus.bot.api.snapshot: Predicate for filtering Projectile entries in a GameSnapshot.
projectileId() - Method in class com.botwithus.bot.api.entities.Projectile: Graphic (spot-anim) id of the projectile.
projectileId() - Method in record class com.botwithus.bot.api.snapshot.Projectile: Returns the value of the projectileId record component.
projectiles() - Method in interface com.botwithus.bot.api.GameAPI: In-flight projectile query facade (v17+).
projectiles() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: In-flight projectiles table accessor (v17+).
Projectiles - Class in com.botwithus.bot.api.entities: In-flight projectile query facade (v17+).
Projectiles(GameAPI) - Constructor for class com.botwithus.bot.api.entities.Projectiles
Projectiles.Query - Class in com.botwithus.bot.api.entities: Query subclass — wires the snapshot stream to EntityQuery.
publish(GameEvent) - Method in interface com.botwithus.bot.api.event.EventBus: Publishes an event to all registered listeners of its type.
publish(String, String, Object) - Method in interface com.botwithus.bot.api.isc.MessageBus: Publishes a message to all subscribers of the given channel.
publishSeq() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: The producer's snapshot publish counter, incremented once per ~20 ms republish starting from 1 when the agent attached.
put(String, Object) - Method in interface com.botwithus.bot.api.isc.SharedState: Stores a value under the given key, replacing any existing value.

Q

quantity() - Method in class com.botwithus.bot.api.entities.GroundItem
quantity() - Method in record class com.botwithus.bot.api.model.GroundItemInfo: Returns the value of the quantity record component.
quantity() - Method in record class com.botwithus.bot.api.model.ResourceItem: Returns the value of the quantity record component.
quantity() - Method in record class com.botwithus.bot.api.snapshot.GroundItem: Returns the value of the quantity record component.
quantity() - Method in record class com.botwithus.bot.api.snapshot.InventoryItem: Returns the value of the quantity record component.
query() - Method in class com.botwithus.bot.api.entities.GroundItems
query() - Method in class com.botwithus.bot.api.entities.Npcs: Start a fluent query.
query() - Method in class com.botwithus.bot.api.entities.Players: Start a fluent query.
query() - Method in class com.botwithus.bot.api.entities.Projectiles: Start a fluent query.
query() - Method in class com.botwithus.bot.api.entities.SceneObjects
query() - Method in class com.botwithus.bot.api.entities.WorldMapElements
queryVarbits(List) - Method in interface com.botwithus.bot.api.domain.VariableAPI: Batch-resolves multiple varbit values.
queryWorldMapElements(Map) - Method in interface com.botwithus.bot.api.GameAPI: Low-level RPC: ask the producer for cache-resident world map elements matching filter.
QUEST - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Quests.
QUESTING - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
questItemSprite() - Method in record class com.botwithus.bot.api.model.QuestType: Returns the value of the questItemSprite record component.
questPointReq() - Method in record class com.botwithus.bot.api.model.QuestType: Returns the value of the questPointReq record component.
questPoints() - Method in record class com.botwithus.bot.api.model.QuestType: Returns the value of the questPoints record component.
QuestType - Record Class in com.botwithus.bot.api.model: Quest definition from the game cache.
QuestType(int, String, String, int, int, boolean, int, int, int, List, int, List, List, List, List, Map) - Constructor for record class com.botwithus.bot.api.model.QuestType: Creates an instance of a QuestType record class.
queueAction(GameAction) - Method in interface com.botwithus.bot.api.domain.ActionAPI: Queues a single game action for execution on the next game tick.
queueActions(List) - Method in interface com.botwithus.bot.api.domain.ActionAPI: Queues multiple game actions for execution.
queueComponentClick(int, int) - Method in class com.botwithus.bot.api.util.GrandExchange: Click an arbitrary GE component by id with the given right-click option.
QUEUED - Enum constant in enum class com.botwithus.bot.api.script.LaunchedClient.State
Quick start - Section in interface com.botwithus.bot.api.script.ManagementScript

R

RADIO_GROUP_SELECT - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
RadioGroupSelectEvent - Record Class in com.botwithus.bot.api.event: Fired when a radio-group option is selected, observed on the producer's outbound SendRadioButton packet builder.
RadioGroupSelectEvent(int, int, int, int, int) - Constructor for record class com.botwithus.bot.api.event.RadioGroupSelectEvent
RadioGroupSelectEvent(int, int, int, int, int, long) - Constructor for record class com.botwithus.bot.api.event.RadioGroupSelectEvent: Creates an instance of a RadioGroupSelectEvent record class.
random(int, int) - Static method in class com.botwithus.bot.api.util.Timing: Inclusive on both ends.
random(long, long) - Static method in class com.botwithus.bot.api.util.Timing: Inclusive on both ends.
RANGED - Static variable in class com.botwithus.bot.api.util.Skills
RATE_LIMITED - Static variable in exception class com.botwithus.bot.api.script.LauncherException: The automation launch budget is spent; see LauncherException.retryAfterMs().
raw() - Method in class com.botwithus.bot.api.entities.GroundItem
raw() - Method in class com.botwithus.bot.api.entities.Npc: The underlying snapshot record.
raw() - Method in class com.botwithus.bot.api.entities.Player
raw() - Method in class com.botwithus.bot.api.entities.Projectile: The underlying snapshot record.
raw() - Method in class com.botwithus.bot.api.entities.SceneObject
raw() - Method in record class com.botwithus.bot.api.snapshot.Orientation: Returns the value of the raw record component.
rawH() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the rawH record component.
rawType() - Method in class com.botwithus.bot.api.component.ComponentNode: Build-specific raw type byte.
rawW() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the rawW record component.
rawX() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the rawX record component.
rawY() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the rawY record component.
READBACK_TOLERANCE - Static variable in record class com.botwithus.bot.api.snapshot.Orientation: How far, in raw units, a facing read back from the client may sit from the angle that set it: the client's conversion truncates, so angle j can read back as j - 1.
Reading it - Section in interface com.botwithus.bot.api.snapshot.DynamicRegion
readVarbit(int) - Method in interface com.botwithus.bot.api.domain.VariableAPI: Reads a varbit with the state of its base variable.
readVarbits(List) - Method in interface com.botwithus.bot.api.domain.VariableAPI: Batch form of VariableAPI.readVarbit(int): one read per input id, in order.
readVarp(int) - Method in interface com.botwithus.bot.api.domain.VariableAPI: Reads a varp with its state.
readVarps(List) - Method in interface com.botwithus.bot.api.domain.VariableAPI: Batch form of VariableAPI.readVarp(int): one read per input id, in order.
reason() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ClientExited: Returns the value of the reason record component.
Reconnecting(long, int, long) - Constructor for record class com.botwithus.bot.api.runtime.ReconnectState.Reconnecting: Creates an instance of a Reconnecting record class.
ReconnectState - Interface in com.botwithus.bot.api.runtime: Closed state machine describing the lifecycle of a reconnect controller.
ReconnectState.Connected - Record Class in com.botwithus.bot.api.runtime
ReconnectState.Disconnected - Record Class in com.botwithus.bot.api.runtime
ReconnectState.GivingUp - Record Class in com.botwithus.bot.api.runtime
ReconnectState.Reconnecting - Record Class in com.botwithus.bot.api.runtime
ReconnectStateChangedEvent - Record Class in com.botwithus.bot.api.event: Fired whenever the ReconnectController transitions between ReconnectState variants.
ReconnectStateChangedEvent(String, ReconnectState) - Constructor for record class com.botwithus.bot.api.event.ReconnectStateChangedEvent
ReconnectStateChangedEvent(String, ReconnectState, long) - Constructor for record class com.botwithus.bot.api.event.ReconnectStateChangedEvent: Creates an instance of a ReconnectStateChangedEvent record class.
rect() - Method in record class com.botwithus.bot.api.draw.DrawEntry: Returns the value of the rect record component.
rect(String, int, int, int, int) - Method in interface com.botwithus.bot.api.draw.DrawTarget: Axis-aligned rectangle.
Rect(String, DrawSpace, DrawStyle, int, int, int, int) - Constructor for record class com.botwithus.bot.api.draw.DrawCommand.Rect: Creates an instance of a Rect record class.
RECT - Enum constant in enum class com.botwithus.bot.api.draw.DrawKind: Axis-aligned rectangle, stroked or filled.
RED - Static variable in class com.botwithus.bot.api.draw.Colors
ref() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Entity: Returns the value of the ref record component.
reloadLocal() - Method in interface com.botwithus.bot.api.script.ScriptManager: Reloads scripts from the local scripts/ directory.
remainingTtlMs() - Method in record class com.botwithus.bot.api.draw.DrawEntry: Returns the value of the remainingTtlMs record component.
remove(String) - Method in interface com.botwithus.bot.api.isc.SharedState: Removes the value stored under the given key.
removeFromGroup(String, String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Removes a client from a group.
render() - Method in interface com.botwithus.bot.api.ui.ScriptUI: Called every frame to render this script's UI.
replayMode() - Method in record class com.botwithus.bot.api.model.SequenceType: Returns the value of the replayMode record component.
request(String, String, Object, long) - Method in interface com.botwithus.bot.api.isc.MessageBus: Sends a request and waits for a response on the given channel.
requestId() - Method in record class com.botwithus.bot.api.isc.ScriptMessage: Returns the value of the requestId record component.
require(GamevalType, String) - Method in interface com.botwithus.bot.api.gameval.GamevalIndex: The id for a name, or throw.
requireCaption(DrawCaption) - Static method in interface com.botwithus.bot.api.draw.DrawCommand.Highlight: The caption, validated.
requiredChunks() - Method in interface com.botwithus.bot.api.snapshot.DynamicRegion: 4 * gridW * gridH as the producer computed it.
requireExtentTiles(int, String) - Static method in interface com.botwithus.bot.api.draw.DrawCommand.Highlight: A footprint side, in tiles: positive and inside the world.
requireKey(String) - Static method in interface com.botwithus.bot.api.draw.DrawCommand: The key, validated.
requirePlane(int) - Static method in interface com.botwithus.bot.api.draw.DrawCommand.Highlight: A plane, DrawLimits.MIN_PLANE to DrawLimits.MAX_PLANE.
requireTile(int, String) - Static method in interface com.botwithus.bot.api.draw.DrawCommand.Highlight: A tile coordinate or tile extent, validated against DrawLimits.MAX_WORLD_TILE.
resolve(GamevalIndex) - Method in record class com.botwithus.bot.api.gameval.GamevalRef: The id index resolves GamevalRef.gameval() to, or GamevalRef.fallbackId() when the name is unknown or no index is deployed.
RESOLVED_COMPONENTS_PER_TICK - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Component highlights the producer re-resolves per tick.
resolvedId() - Method in class com.botwithus.bot.api.entities.SceneObject: The loc id whose definition carries this object's name and right-click options, with the morphvarp ("multiloc") transform already applied by the producer.
resolvedId() - Method in record class com.botwithus.bot.api.model.SceneObjectInfo: Returns the value of the resolvedId record component.
resolvedId() - Method in record class com.botwithus.bot.api.snapshot.Location: Returns the value of the resolvedId record component.
resolveFailures() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns the value of the resolveFailures record component.
resolveOverflow() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns the value of the resolveOverflow record component.
resolveTransform() - Method in class com.botwithus.bot.api.entities.SceneObject: The producer resolves morphvarp transforms before publishing the snapshot and the result rides on the row as SceneObject.resolvedId(), so this is a no-op identity.
ResourceItem - Record Class in com.botwithus.bot.api.model: A single resource line on a WorldMapElement — typically an ore, fish, or log obtainable at the spot.
ResourceItem(int, int, int) - Constructor for record class com.botwithus.bot.api.model.ResourceItem: Creates an instance of a ResourceItem record class.
resources() - Method in record class com.botwithus.bot.api.model.WorldMapElement: Returns the value of the resources record component.
ResourceSection - Record Class in com.botwithus.bot.api.model: A group of ResourceItems available at a WorldMapElement, grouped under a display title (e.g.
ResourceSection(String, List) - Constructor for record class com.botwithus.bot.api.model.ResourceSection: Creates an instance of a ResourceSection record class.
respond(String, String, String, Object) - Method in interface com.botwithus.bot.api.isc.MessageBus: Sends a response to a previous request.
restart(String) - Method in interface com.botwithus.bot.api.script.ScriptManager: Stops and restarts a script.
restartOf() - Method in record class com.botwithus.bot.api.script.LaunchedClient: Returns the value of the restartOf record component.
restartScript(String, String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Restarts a script on a specific client.
restartScriptOnAll(String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Restarts a script on every connected client.
restartScriptOnGroup(String, String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Restarts a script on all clients in a group.
results() - Method in class com.botwithus.bot.api.component.ComponentQuery: Alias for ComponentQuery.all().
retryAfterMs() - Method in exception class com.botwithus.bot.api.script.LauncherException
RETRYING - Enum constant in enum class com.botwithus.bot.api.script.LaunchedClient.LicenceState: Refreshes are failing; the client keeps running for now.
returns() - Method in record class com.botwithus.bot.api.model.ScriptResult: Returns the value of the returns record component.
REVOKED - Enum constant in enum class com.botwithus.bot.api.runtime.Liveness: Stop was requested, the thread did not drain, and the runtime has cut the runner off from the game: every RPC it attempts from here on throws.
RING - Enum constant in enum class com.botwithus.bot.api.inventory.Equipment.Slot
risk() - Method in record class com.botwithus.bot.api.event.BreakStartedEvent: Returns the value of the risk record component.
root() - Method in class com.botwithus.bot.api.component.ComponentQuery: Root of the materialized subtree, or null when it didn't resolve.
root() - Method in class com.botwithus.bot.api.component.ComponentTree: The root node, or null when the subtree didn't resolve (empty tree).
rotateLocalX(int, int, int) - Static method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Source-local X for destination-local (localX, localY) within an 8x8 chunk rotated by rotation.
rotateLocalY(int, int, int) - Static method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Source-local Y counterpart of DynamicRegion.rotateLocalX(int, int, int).
rotateLocRotation(int, int) - Static method in interface com.botwithus.bot.api.snapshot.DynamicRegion: A Location's rotation as it appears in the instance, given its rotation in the source region and the chunk's rotation: the two compose additively mod 4.
rotation() - Method in class com.botwithus.bot.api.entities.SceneObject: How far this loc's model is turned, in quarter turns 0..3, exactly as the producer published it.
rotation() - Method in record class com.botwithus.bot.api.model.SceneObjectInfo: Returns the value of the rotation record component.
rotation() - Method in record class com.botwithus.bot.api.snapshot.Location: Returns the value of the rotation record component.
rotation() - Method in record class com.botwithus.bot.api.snapshot.SourceTile: Returns the value of the rotation record component.
ROTATION_COUNT - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion: Rotations are 0..3 in 90-degree steps.
ROTATION_MASK - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion: Composing two rotations wraps with this mask.
row() - Method in record class com.botwithus.bot.api.dialog.DialogOption: Returns the value of the row record component.
runAfter(String, Duration) - Method in interface com.botwithus.bot.api.script.ScriptScheduler: Starts a script after the given delay.
runAfter(String, Duration, Map) - Method in interface com.botwithus.bot.api.script.ScriptScheduler: Starts a script after the given delay with configuration.
runAt(String, Instant) - Method in interface com.botwithus.bot.api.script.ScriptScheduler: Starts a script at a specific time.
RUNECRAFTING - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
RUNECRAFTING - Static variable in class com.botwithus.bot.api.util.Skills
runEvery(String, Duration) - Method in interface com.botwithus.bot.api.script.ScriptScheduler: Repeats a script on a fixed interval.
runEvery(String, Duration, Duration) - Method in interface com.botwithus.bot.api.script.ScriptScheduler: Repeats a script on a fixed interval, automatically stopping it after maxDuration each time.
running() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScriptStatusEntry: Returns the value of the running record component.
running() - Method in record class com.botwithus.bot.api.script.ScriptInfo: Returns the value of the running record component.

S

SCENE_MODE_STATIC - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion: DynamicRegion.sceneMode() value for an ordinary, non-instanced scene.
sceneMode() - Method in interface com.botwithus.bot.api.snapshot.DynamicRegion: The client's scene mode: DynamicRegion.SCENE_MODE_STATIC for a static scene, 4..7 for the dynamic size classes.
SceneObject - Class in com.botwithus.bot.api.entities: Rich wrapper around SceneObjectInfo with lazy LocationType resolution and option-keyed interact.
SceneObjectInfo - Record Class in com.botwithus.bot.api.model: Wire-format record returned by query_locations for one live scene object.
SceneObjectInfo(int, int, int, int, int, int, String, List) - Constructor for record class com.botwithus.bot.api.model.SceneObjectInfo: Builds a row that carries no shape or rotation.
SceneObjectInfo(int, int, int, int, int, int, String, List, int, int) - Constructor for record class com.botwithus.bot.api.model.SceneObjectInfo: Creates an instance of a SceneObjectInfo record class.
SceneObjects - Class in com.botwithus.bot.api.entities: Scene-object query facade.
SceneObjects(GameAPI) - Constructor for class com.botwithus.bot.api.entities.SceneObjects
SceneObjects.Query - Class in com.botwithus.bot.api.entities
sceneVersion() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: Producer-side scene-shape version.
scheduleBreak(int) - Method in interface com.botwithus.bot.api.GameAPI: Schedules a break (action-queue gate) for the given duration.
ScheduledEntry(String, String, Instant, Duration, Duration) - Constructor for record class com.botwithus.bot.api.script.ScriptScheduler.ScheduledEntry: Creates an instance of a ScheduledEntry record class.
ScheduledScriptEntry(String, String, String, Instant, Duration, Duration) - Constructor for record class com.botwithus.bot.api.script.ClientOrchestrator.ScheduledScriptEntry: Creates an instance of a ScheduledScriptEntry record class.
scheduleId() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScheduledScriptEntry: Returns the value of the scheduleId record component.
scheduleId() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScheduleOpResult: Returns the value of the scheduleId record component.
ScheduleOpResult(boolean, String, String, String, String) - Constructor for record class com.botwithus.bot.api.script.ClientOrchestrator.ScheduleOpResult: Creates an instance of a ScheduleOpResult record class.
scheduleScript(String, String, Duration) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Schedules a one-shot start of a script after delay.
scheduleScript(String, String, Duration, Map) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Schedules a one-shot start of a script after delay, applying config before start.
scheduleScriptAt(String, String, Instant) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Schedules a one-shot start of a script at the given instant.
scheduleScriptEvery(String, String, Duration) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Schedules a script to repeat on a fixed interval.
scheduleScriptEvery(String, String, Duration, Duration) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Schedules a script to repeat on a fixed interval, auto-stopping after maxDuration each cycle.
scheduleScriptOnAll(String, Duration) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Schedules a one-shot start of a script on every connected client.
scheduleScriptOnAll(String, Duration, Map) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Schedules a one-shot start of a script on every connected client, applying config before start.
scheduleScriptOnAllAt(String, Instant) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Schedules a one-shot start at the given instant on every connected client.
scheduleScriptOnAllEvery(String, Duration) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Schedules a recurring script on every connected client.
scheduleScriptOnAllEvery(String, Duration, Duration) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Schedules a recurring script on every connected client with an auto-stop after maxDuration each cycle.
scheduleScriptOnGroup(String, String, Duration) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Schedules a one-shot start of a script on every client in a group.
scheduleScriptOnGroup(String, String, Duration, Map) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Schedules a one-shot start of a script on every client in a group, applying config before start.
scheduleScriptOnGroupAt(String, String, Instant) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Schedules a one-shot start at the given instant on every client in a group.
scheduleScriptOnGroupEvery(String, String, Duration) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Schedules a recurring script on every client in a group.
scheduleScriptOnGroupEvery(String, String, Duration, Duration) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Schedules a recurring script on every client in a group with an auto-stop after maxDuration each cycle.
screen() - Method in class com.botwithus.bot.api.draw.DrawBuilder: Client-area pixels, origin top-left.
screen() - Method in class com.botwithus.bot.api.draw.DrawCaptionBuilder: Client-area pixels, origin top-left.
SCREEN - Enum constant in enum class com.botwithus.bot.api.draw.DrawSpace: Client-area pixels, origin top-left.
ScriptCategory - Enum Class in com.botwithus.bot.api: Categories for classifying BotScript implementations.
ScriptConfig - Record Class in com.botwithus.bot.api.config: Immutable snapshot of a script's configuration values.
ScriptConfig(Map) - Constructor for record class com.botwithus.bot.api.config.ScriptConfig: Creates an instance of a ScriptConfig record class.
ScriptContext - Interface in com.botwithus.bot.api: Context object passed to BotScript.onStart(ScriptContext) providing access to the game API and the event bus.
ScriptContextPublisher - Interface in com.botwithus.bot.api.debug: Fire-and-forget publisher for the agent's script.context broker topic.
ScriptCrashedEvent - Record Class in com.botwithus.bot.api.event: Fired by the runtime when a script's lifecycle hook throws.
ScriptCrashedEvent(String, String, LastCrash) - Constructor for record class com.botwithus.bot.api.event.ScriptCrashedEvent
ScriptCrashedEvent(String, String, LastCrash, long) - Constructor for record class com.botwithus.bot.api.event.ScriptCrashedEvent: Creates an instance of a ScriptCrashedEvent record class.
ScriptHealth - Record Class in com.botwithus.bot.api.runtime: Immutable snapshot of a script's failure history.
ScriptHealth(Optional, long) - Constructor for record class com.botwithus.bot.api.runtime.ScriptHealth: Creates an instance of a ScriptHealth record class.
scriptId() - Method in record class com.botwithus.bot.api.model.ComponentTrigger: Returns the value of the scriptId record component.
ScriptInfo - Record Class in com.botwithus.bot.api.script: Read-only snapshot of a script's metadata and current state.
ScriptInfo(String, String, String, String, ScriptCategory, boolean, String) - Constructor for record class com.botwithus.bot.api.script.ScriptInfo: Creates an instance of a ScriptInfo record class.
ScriptLoadFailedEvent - Record Class in com.botwithus.bot.api.event: Fired when the script loader fails to load a JAR (module-info parse error, missing provides clause for BotScript, ServiceLoader instantiation failure, classpath / module-path mismatch, etc.).
ScriptLoadFailedEvent(Path, Throwable) - Constructor for record class com.botwithus.bot.api.event.ScriptLoadFailedEvent
ScriptLoadFailedEvent(Path, Throwable, long) - Constructor for record class com.botwithus.bot.api.event.ScriptLoadFailedEvent: Creates an instance of a ScriptLoadFailedEvent record class.
ScriptManager - Interface in com.botwithus.bot.api.script: Per-Connection script lifecycle manager: lists, starts, stops, reloads, and schedules scripts running against one Client.
ScriptManifest - Annotation Interface in com.botwithus.bot.api: Annotation for BotScript implementations to declare script metadata.
ScriptMessage - Record Class in com.botwithus.bot.api.isc: An immutable message sent over a named ISC channel.
ScriptMessage(String, String, Object, long) - Constructor for record class com.botwithus.bot.api.isc.ScriptMessage: Backward-compatible constructor for pub/sub messages.
ScriptMessage(String, String, Object, long, String) - Constructor for record class com.botwithus.bot.api.isc.ScriptMessage: Creates an instance of a ScriptMessage record class.
scriptName() - Method in record class com.botwithus.bot.api.event.ScriptCrashedEvent: Returns the value of the scriptName record component.
scriptName() - Method in exception class com.botwithus.bot.api.runtime.ScriptRevokedException: The script whose access was withdrawn.
scriptName() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.OpResult: Returns the value of the scriptName record component.
scriptName() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScheduledScriptEntry: Returns the value of the scriptName record component.
scriptName() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScheduleOpResult: Returns the value of the scriptName record component.
scriptName() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScriptStatusEntry: Returns the value of the scriptName record component.
scriptName() - Method in record class com.botwithus.bot.api.script.ManagementTarget.ClientScript: Returns the value of the scriptName record component.
scriptName() - Method in record class com.botwithus.bot.api.script.ScriptScheduler.ScheduledEntry: Returns the value of the scriptName record component.
ScriptResult - Record Class in com.botwithus.bot.api.model: The result of executing a client script via the pipe RPC.
ScriptResult(List) - Constructor for record class com.botwithus.bot.api.model.ScriptResult: Creates an instance of a ScriptResult record class.
ScriptRevokedException - Exception Class in com.botwithus.bot.api.runtime: Thrown when a script that was asked to stop — and did not — tries to act on the game.
ScriptRevokedException(String) - Constructor for exception class com.botwithus.bot.api.runtime.ScriptRevokedException
ScriptScheduler - Interface in com.botwithus.bot.api.script: Schedules scripts to run at a future time or on a recurring interval.
ScriptScheduler.ScheduledEntry - Record Class in com.botwithus.bot.api.script: A snapshot of one scheduled entry.
ScriptStatusEntry(String, String, String, boolean, boolean) - Constructor for record class com.botwithus.bot.api.script.ClientOrchestrator.ScriptStatusEntry: Creates an instance of a ScriptStatusEntry record class.
ScriptUI - Interface in com.botwithus.bot.api.ui: Interface for scripts that provide custom UI.
ScriptUiHost - Interface in com.botwithus.bot.api.ui: The host's handle on a script's UI, passed to ScriptUI.attach(ScriptUiHost) before every frame.
select() - Method in record class com.botwithus.bot.api.dialog.DialogOption: Queue the selection of this option.
select(GameAPI, int) - Static method in class com.botwithus.bot.api.dialog.Dialog: Selects the option with the given 1-based index (as shown by its "N." cell).
select(GameAPI, String) - Static method in class com.botwithus.bot.api.dialog.Dialog: Selects the first option whose label contains text (case-insensitive, markup-stripped, whitespace-normalized).
SELECT_COMPONENT - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
SELECT_COMPONENT_ITEM - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
SELECT_GROUND_ITEM - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
SELECT_NPC - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
SELECT_OBJECT - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
SELECT_PLAYER - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
SELECT_TILE - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
selectDialogOption() - Method in class com.botwithus.bot.api.component.ComponentNode: Queue selection of this component as a multi-choice dialogue option.
self() - Method in interface com.botwithus.bot.api.draw.DrawTarget: Highlight the local player under the conventional auto key self.
self() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: The local player, or null if not currently in-game.
self(String) - Method in interface com.botwithus.bot.api.draw.DrawTarget: Highlight the local player, tracked.
SELF - Enum constant in enum class com.botwithus.bot.api.draw.EntityRef: The local player, with no index at all — the producer re-resolves the slot every tick so the highlight survives a world hop.
sender() - Method in record class com.botwithus.bot.api.isc.ScriptMessage: Returns the value of the sender record component.
SEQ - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Animation sequences.
SequenceType - Record Class in com.botwithus.bot.api.model: Animation sequence definition from the game cache.
SequenceType(int, int, List, int, int, int, int, int, int, int, int, boolean, Map) - Constructor for record class com.botwithus.bot.api.model.SequenceType: Creates an instance of a SequenceType record class.
serverIndex() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Entity: Returns the value of the serverIndex record component.
serverIndex() - Method in class com.botwithus.bot.api.entities.Npc
serverIndex() - Method in class com.botwithus.bot.api.entities.Player
serverIndex() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Returns the value of the serverIndex record component.
serverIndex() - Method in record class com.botwithus.bot.api.snapshot.Npc: Returns the value of the serverIndex record component.
serverIndex() - Method in record class com.botwithus.bot.api.snapshot.Player: Returns the value of the serverIndex record component.
serverIndex(int) - Static method in interface com.botwithus.bot.api.snapshot.NpcFilter
serverIndex(int) - Static method in interface com.botwithus.bot.api.snapshot.PlayerFilter
serverTick() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot: The server-tick counter: the 0.6-second game-logic step the server runs on.
SERVICE_STOPPED - Static variable in exception class com.botwithus.bot.api.script.LauncherException: The user stopped the service from the tray.
SERVICE_UNAVAILABLE - Static variable in exception class com.botwithus.bot.api.script.LauncherException: No service is reachable, or it did not answer in time.
ServiceLost(String) - Constructor for record class com.botwithus.bot.api.script.LauncherEvent.ServiceLost: Creates an instance of a ServiceLost record class.
ServiceRestored() - Constructor for record class com.botwithus.bot.api.script.LauncherEvent.ServiceRestored: Creates an instance of a ServiceRestored record class.
ServiceShuttingDown(boolean) - Constructor for record class com.botwithus.bot.api.script.LauncherEvent.ServiceShuttingDown: Creates an instance of a ServiceShuttingDown record class.
SET - Enum constant in enum class com.botwithus.bot.api.model.VarpState: The client holds a value for the varp; VarpRead.value() is it.
Set, default, missing, unknown - Section in interface com.botwithus.bot.api.domain.VariableAPI
setActionsBlocked(boolean) - Method in interface com.botwithus.bot.api.domain.ActionAPI: Enables or disables action blocking.
setAutoLogin(boolean) - Method in interface com.botwithus.bot.api.GameAPI: Enables or disables the producer's auto-login state machine.
setDrawEnabled(boolean) - Method in interface com.botwithus.bot.api.domain.DrawAPI: Switch drawing on or off (debug_draw_enable), answering the state that took effect.
setEnabled(boolean) - Method in class com.botwithus.bot.api.draw.Draw: Switch drawing on or off, answering the state that took effect.
setGroupDescription(String, String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Sets the description of a group.
setting() - Method in class com.botwithus.bot.api.inventory.Bank: Bank interface setting — standard transfer or preset selector.
SETTINGS - Static variable in class com.botwithus.bot.api.util.Interfaces
setTransferMode(Bank.TransferAmount) - Method in class com.botwithus.bot.api.inventory.Bank: Select the bank's quantity-mode button.
setWorld(int) - Method in interface com.botwithus.bot.api.GameAPI: Initiates a world hop to the given world id.
sha() - Method in record class com.botwithus.bot.api.script.LauncherEvent.AgentUpdated: Returns the value of the sha record component.
sha() - Method in record class com.botwithus.bot.api.script.LauncherEvent.DataUpdateApplied: Returns the value of the sha record component.
shape() - Method in class com.botwithus.bot.api.entities.SceneObject: The scenery shape code as published on the wire, which says what kind of placement this loc is: a wall, a wall decoration, a ground decoration, a centrepiece and so on.
shape() - Method in record class com.botwithus.bot.api.model.SceneObjectInfo: Returns the value of the shape record component.
shape() - Method in record class com.botwithus.bot.api.snapshot.Location: Returns the value of the shape record component.
SharedState - Interface in com.botwithus.bot.api.isc: Thread-safe key-value store for sharing state between scripts.
SHIELD - Enum constant in enum class com.botwithus.bot.api.inventory.Equipment.Slot
shift() - Method in record class com.botwithus.bot.api.event.KeyInputEvent: Returns the value of the shift record component.
shopPrice() - Method in record class com.botwithus.bot.api.model.ItemType: Returns the value of the shopPrice record component.
shortcutCost() - Method in record class com.botwithus.bot.api.model.WorldPathConfig: Returns the value of the shortcutCost record component.
shortcutCost(float) - Method in class com.botwithus.bot.api.model.WorldPathConfig.Builder
shortDelay() - Static method in class com.botwithus.bot.api.util.Timing: 150–300ms.
sizeX() - Method in record class com.botwithus.bot.api.model.LocationType: Returns the value of the sizeX record component.
sizeY() - Method in record class com.botwithus.bot.api.model.LocationType: Returns the value of the sizeY record component.
Skill - Record Class in com.botwithus.bot.api.snapshot: One row of the local player's skills array.
Skill(int, int, int, int) - Constructor for record class com.botwithus.bot.api.snapshot.Skill: Creates an instance of a Skill record class.
skillId() - Method in record class com.botwithus.bot.api.model.PlayerStat: Returns the value of the skillId record component.
skillId() - Method in record class com.botwithus.bot.api.model.SkillRequirement: Returns the value of the skillId record component.
SKILLING - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
skillName() - Method in record class com.botwithus.bot.api.model.SkillRequirement: Returns the value of the skillName record component.
SkillRequirement - Record Class in com.botwithus.bot.api.model: A skill requirement associated with a WorldMapElement.
SkillRequirement(int, int, String) - Constructor for record class com.botwithus.bot.api.model.SkillRequirement: Creates an instance of a SkillRequirement record class.
skillRequirements() - Method in record class com.botwithus.bot.api.model.QuestType: Returns the value of the skillRequirements record component.
skillRequirements() - Method in record class com.botwithus.bot.api.model.WorldMapElement: Returns the value of the skillRequirements record component.
skills() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Returns the value of the skills record component.
Skills - Class in com.botwithus.bot.api.util: Skill ID constants and stat lookup helpers for RS3.
SKILLS - Static variable in class com.botwithus.bot.api.constants.InterfaceIds
SKILLS - Static variable in class com.botwithus.bot.api.util.Interfaces
SLAYER - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
SLAYER - Static variable in class com.botwithus.bot.api.util.Skills
sleep(long) - Static method in class com.botwithus.bot.api.util.Timing: Sleeps for the specified duration.
sleep(long, long) - Static method in class com.botwithus.bot.api.util.Humanize: Sleeps for a gaussian-distributed duration.
sleepGaussian(long, long) - Static method in class com.botwithus.bot.api.util.Timing: Sleep for a gaussian-distributed random duration.
sleepRandom(long, long) - Static method in class com.botwithus.bot.api.util.Timing: Sleeps for a uniformly random duration between minMs and maxMs.
sleepTick() - Static method in class com.botwithus.bot.api.util.Timing: ~600ms with small random jitter.
slot() - Method in record class com.botwithus.bot.api.event.ObjVarChangeEvent: Returns the value of the slot record component.
slot() - Method in record class com.botwithus.bot.api.snapshot.InventoryItem: Returns the value of the slot record component.
SLOT_COUNT - Static variable in class com.botwithus.bot.api.util.GrandExchange: Number of offer slots.
slotCount() - Method in class com.botwithus.bot.api.inventory.InventoryContainer: Slot count from the snapshot header (0 when not published).
slotCount() - Method in record class com.botwithus.bot.api.snapshot.Inventory: Returns the value of the slotCount record component.
SMALL - Enum constant in enum class com.botwithus.bot.api.draw.DrawFont
SMITHING - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
SMITHING - Static variable in class com.botwithus.bot.api.constants.AnimationIds
SMITHING - Static variable in class com.botwithus.bot.api.util.Skills
snapshot() - Method in interface com.botwithus.bot.api.Client: Returns a tick-scoped read view of the producer's current game state.
snapshot() - Method in interface com.botwithus.bot.api.GameAPI: Returns a tick-scoped read view over the producer's published snapshot, or null if no shared-memory region is bound (e.g.
snapshot() - Method in interface com.botwithus.bot.api.isc.SharedState: Returns an immutable snapshot of all key-value pairs currently stored.
solidType() - Method in record class com.botwithus.bot.api.model.LocationType: Returns the value of the solidType record component.
sortByDistance() - Method in class com.botwithus.bot.api.entities.EntityQuery: Sort results by distance from the local player, ascending.
sortByDistance() - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
SOUND - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Sound effects.
sourceIndex() - Method in class com.botwithus.bot.api.entities.Projectile: Server index of the source entity, or -1 when the projectile originates from a fixed tile rather than an entity.
sourceIndex() - Method in record class com.botwithus.bot.api.snapshot.Projectile: Returns the value of the sourceIndex record component.
sourceNpc() - Method in class com.botwithus.bot.api.entities.Projectile: Resolve the source endpoint to a live NPC, or null if no NPC in this tick's snapshot carries that server index.
sourceOf(int, int, int) - Method in interface com.botwithus.bot.api.snapshot.DynamicRegion: The static-map tile that world tile (tileX, tileY, plane) was copied from, or empty if this tile has no source — because the scene is static, because the tile is outside the descriptor grid, or because the instance has a hole there.
sourceOfPacked(int, int, int) - Method in interface com.botwithus.bot.api.snapshot.DynamicRegion: DynamicRegion.sourceOf(int, int, int) without the allocation: the source tile packed into a long, or DynamicRegion.NO_SOURCE.
sourcePlayer() - Method in class com.botwithus.bot.api.entities.Projectile: Resolve the source endpoint to a live player.
SourceTile - Record Class in com.botwithus.bot.api.snapshot: The static-map tile an instance tile was copied from (v19+).
SourceTile(int, int, int, int) - Constructor for record class com.botwithus.bot.api.snapshot.SourceTile: Creates an instance of a SourceTile record class.
sourceType() - Method in class com.botwithus.bot.api.entities.Projectile: Raw engine entity-type tag for the source endpoint, surfaced unmodified.
sourceType() - Method in record class com.botwithus.bot.api.snapshot.Projectile: Returns the value of the sourceType record component.
SOUTH - Enum constant in enum class com.botwithus.bot.api.snapshot.Direction
SOUTH_EAST - Enum constant in enum class com.botwithus.bot.api.snapshot.Direction
SOUTH_WEST - Enum constant in enum class com.botwithus.bot.api.snapshot.Direction
space() - Method in record class com.botwithus.bot.api.draw.DrawCommand.ComponentTarget: Returns the value of the space record component.
space() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Ellipse: Returns the value of the space record component.
space() - Method in interface com.botwithus.bot.api.draw.DrawCommand.Highlight: Always DrawSpace.WORLD.
space() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Line: Returns the value of the space record component.
space() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Poly: Returns the value of the space record component.
space() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Rect: Returns the value of the space record component.
space() - Method in interface com.botwithus.bot.api.draw.DrawCommand: The coordinate space this command's geometry is expressed in.
space() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Text: Returns the value of the space record component.
space() - Method in record class com.botwithus.bot.api.draw.DrawEntry: Returns the value of the space record component.
SPAWNING - Enum constant in enum class com.botwithus.bot.api.script.LaunchedClient.State
SpotAnimEvent - Record Class in com.botwithus.bot.api.event: Fired when a new spot animation (graphic) starts playing.
SpotAnimEvent(int, int, int, int, int, int) - Constructor for record class com.botwithus.bot.api.event.SpotAnimEvent
SpotAnimEvent(int, int, int, int, int, int, long) - Constructor for record class com.botwithus.bot.api.event.SpotAnimEvent: Creates an instance of a SpotAnimEvent record class.
spotAnimId() - Method in class com.botwithus.bot.api.entities.Npc: First active spot anim (graphic) id playing on this NPC, or -1 if none.
spotAnimId() - Method in class com.botwithus.bot.api.entities.Player: First active spot anim (graphic) id playing on this player, or -1 if none.
spotAnimId() - Method in record class com.botwithus.bot.api.event.SpotAnimEvent: Returns the value of the spotAnimId record component.
spotAnimId() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Returns the value of the spotAnimId record component.
spotAnimId() - Method in record class com.botwithus.bot.api.snapshot.Npc: Returns the value of the spotAnimId record component.
spotAnimId() - Method in record class com.botwithus.bot.api.snapshot.Player: Returns the value of the spotAnimId record component.
SPRITE - Enum constant in enum class com.botwithus.bot.api.component.ComponentType
spriteId() - Method in class com.botwithus.bot.api.component.ComponentNode
spriteId() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the spriteId record component.
spriteId() - Method in record class com.botwithus.bot.api.model.WorldMapElement: Returns the value of the spriteId record component.
SRC_PLANE_MASK - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion
SRC_PLANE_SHIFT - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion
SRC_ROTATION_MASK - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion
SRC_ROTATION_SHIFT - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion
SRC_TILE_MASK - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion
SRC_TILE_X_SHIFT - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion
SRC_TILE_Y_SHIFT - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion
srcPlane(long) - Static method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Source plane out of a DynamicRegion.sourceOfPacked(int, int, int) result.
srcRotation(long) - Static method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Chunk rotation out of a DynamicRegion.sourceOfPacked(int, int, int) result.
srcTileX(long) - Static method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Source tile X out of a DynamicRegion.sourceOfPacked(int, int, int) result.
srcTileY(long) - Static method in interface com.botwithus.bot.api.snapshot.DynamicRegion: Source tile Y out of a DynamicRegion.sourceOfPacked(int, int, int) result.
STABLE_COPY_ATTEMPTS - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion: Copy attempts DynamicRegion.copyOfStable(GameSnapshot) makes before giving up.
stackable() - Method in record class com.botwithus.bot.api.model.ItemType: Returns the value of the stackable record component.
stackTrace() - Method in record class com.botwithus.bot.api.runtime.LastCrash: Renders the throwable as the conventional multi-line stack trace string.
stage() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ClientStateChanged: Returns the value of the stage record component.
STAGED - Enum constant in enum class com.botwithus.bot.api.script.LauncherEvent.DataPhase
stagedSha() - Method in record class com.botwithus.bot.api.script.LauncherEvent.DataUpdateAvailable: Returns the value of the stagedSha record component.
STALLED - Enum constant in enum class com.botwithus.bot.api.runtime.Liveness: Still inside a single onLoop call past the watchdog's threshold.
stanceId() - Method in class com.botwithus.bot.api.entities.Npc
stanceId() - Method in class com.botwithus.bot.api.entities.Player
stanceId() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Returns the value of the stanceId record component.
stanceId() - Method in record class com.botwithus.bot.api.snapshot.Npc: Returns the value of the stanceId record component.
stanceId() - Method in record class com.botwithus.bot.api.snapshot.Player: Returns the value of the stanceId record component.
start(String) - Method in interface com.botwithus.bot.api.script.ScriptManager: Starts a script by name.
start(String, Map) - Method in interface com.botwithus.bot.api.script.ScriptManager: Starts a script with the given configuration values.
startCycle() - Method in class com.botwithus.bot.api.entities.Projectile: Game cycle the projectile was launched.
startCycle() - Method in record class com.botwithus.bot.api.snapshot.Projectile: Returns the value of the startCycle record component.
startDepositX(int) - Method in class com.botwithus.bot.api.inventory.Bank: Open the deposit-X dialog for itemId.
startedAtMs() - Method in record class com.botwithus.bot.api.script.LaunchedClient: Returns the value of the startedAtMs record component.
startingWith(GamevalType, String, int) - Method in interface com.botwithus.bot.api.gameval.GamevalIndex: Names in type starting with prefix, ordered by name.
startLocations() - Method in record class com.botwithus.bot.api.model.QuestType: Returns the value of the startLocations record component.
startScript(String, String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Starts a script on a specific client.
startScriptOnAll(String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Starts a script on every connected client.
startScriptOnGroup(String, String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Starts a script on all clients in a group.
startTileX() - Method in class com.botwithus.bot.api.entities.Projectile: Absolute world tile X of the launch point.
startTileX() - Method in record class com.botwithus.bot.api.snapshot.Projectile: Returns the value of the startTileX record component.
startTileY() - Method in class com.botwithus.bot.api.entities.Projectile: Absolute world tile Y of the launch point.
startTileY() - Method in record class com.botwithus.bot.api.snapshot.Projectile: Returns the value of the startTileY record component.
startWithdrawX(int) - Method in class com.botwithus.bot.api.inventory.Bank: Open the withdraw-X dialog for itemId.
state() - Method in record class com.botwithus.bot.api.event.ReconnectStateChangedEvent: Returns the value of the state record component.
state() - Method in record class com.botwithus.bot.api.model.LoginState: Returns the value of the state record component.
state() - Method in record class com.botwithus.bot.api.model.VarbitRead: Returns the value of the state record component.
state() - Method in record class com.botwithus.bot.api.model.VarpRead: Returns the value of the state record component.
state() - Method in record class com.botwithus.bot.api.model.WalkStatus: Returns the value of the state record component.
state() - Method in record class com.botwithus.bot.api.script.LaunchedClient.Licence: Returns the value of the state record component.
state() - Method in record class com.botwithus.bot.api.script.LaunchedClient: Returns the value of the state record component.
state() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ClientStateChanged: Returns the value of the state record component.
state() - Method in record class com.botwithus.bot.api.script.LauncherEvent.LicenceChanged: Returns the value of the state record component.
state(String) - Method in interface com.botwithus.bot.api.debug.ScriptContextPublisher: Lifecycle state notification with no further detail.
state(String, String) - Method in interface com.botwithus.bot.api.debug.ScriptContextPublisher: Lifecycle state notification with an optional human-readable detail.
STATIC - Static variable in interface com.botwithus.bot.api.snapshot.DynamicRegion: The scene nobody modelled as an instance: not an instance, no grid, no chunks.
stats() - Method in class com.botwithus.bot.api.draw.Draw: The producer's overlay counters and renderer health.
STEAM - Enum constant in enum class com.botwithus.bot.api.script.LaunchedClient.Kind
stop(String) - Method in interface com.botwithus.bot.api.script.ScriptManager: Stops a running script.
stop(String, StopMode) - Method in interface com.botwithus.bot.api.script.ClientLauncher: Stops a client.
stopAll() - Method in interface com.botwithus.bot.api.script.ScriptManager: Stops all running scripts.
stopAllScriptsOnAll() - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Stops all scripts on every connected client.
stopAllScriptsOnGroup(String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Stops all scripts on all clients in a group.
StopMode - Enum Class in com.botwithus.bot.api.script: How ClientLauncher.stop(String, StopMode) ends a client.
STOPPED - Enum constant in enum class com.botwithus.bot.api.script.LauncherEvent.ExitReason: ClientLauncher.stop(String, StopMode) or the launcher stopped it.
stopScript(String, String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Stops a script on a specific client.
stopScriptOnAll(String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Stops a script on every connected client.
stopScriptOnGroup(String, String) - Method in interface com.botwithus.bot.api.script.ClientOrchestrator: Stops a script on all clients in a group.
stopSelf() - Method in interface com.botwithus.bot.api.ScriptContext: Request that this script terminate.
stream() - Method in class com.botwithus.bot.api.component.ComponentQuery: Stream over the materialized result list (filter + limit already applied).
stream() - Method in class com.botwithus.bot.api.entities.EntityQuery: Stream over the materialised result list (filters/sort already applied).
stream() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.GroundItems
stream() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Inventories
stream() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Locations
stream() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Npcs
stream() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Players
stream() - Method in interface com.botwithus.bot.api.snapshot.GameSnapshot.Projectiles
STRENGTH - Static variable in class com.botwithus.bot.api.util.Skills
STRING - Enum constant in enum class com.botwithus.bot.api.model.VarKind: A string.
stringDefault() - Method in record class com.botwithus.bot.api.model.EnumType: Returns the value of the stringDefault record component.
stringField(String, String, String) - Static method in interface com.botwithus.bot.api.config.ConfigField
StringField(String, String, String) - Constructor for record class com.botwithus.bot.api.config.ConfigField.StringField: Creates an instance of a StringField record class.
STRUCT - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Structs (param bags).
StructType - Record Class in com.botwithus.bot.api.model: Struct definition from the game cache.
StructType(int, Map) - Constructor for record class com.botwithus.bot.api.model.StructType: Creates an instance of a StructType record class.
StubGuard - Class in com.botwithus.bot.api.diag: Warns once per method-name when a producer-side stub is invoked.
StubGuard() - Constructor for class com.botwithus.bot.api.diag.StubGuard: Default sink — logs at WARN to the StubGuard logger.
StubGuard(Consumer) - Constructor for class com.botwithus.bot.api.diag.StubGuard: Custom sink — receives the method name on first call only.
style() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Area: Returns the value of the style record component.
style() - Method in record class com.botwithus.bot.api.draw.DrawCommand.ComponentTarget: Returns the value of the style record component.
style() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Ellipse: Returns the value of the style record component.
style() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Entity: Returns the value of the style record component.
style() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Line: Returns the value of the style record component.
style() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Poly: Returns the value of the style record component.
style() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Rect: Returns the value of the style record component.
style() - Method in interface com.botwithus.bot.api.draw.DrawCommand: Colour, stroke, fill, order and lifetime.
style() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Text: Returns the value of the style record component.
style() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Tile: Returns the value of the style record component.
STYLESHEET - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Interface style sheets.
subId() - Method in class com.botwithus.bot.api.component.ComponentNode
subId() - Method in record class com.botwithus.bot.api.event.RadioGroupSelectEvent: Returns the value of the subId record component.
subId() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the subId record component.
submit() - Method in class com.botwithus.bot.api.draw.DrawBuilder: Send the command, and answer the key it is stored under — which is also how you clear it later.
submit() - Method in class com.botwithus.bot.api.draw.DrawCaptionBuilder: Send the command, and answer the key it is stored under.
submit() - Method in class com.botwithus.bot.api.draw.HighlightBuilder: Send the highlight, and answer the key it is stored under — which is also how you clear it later.
submit() - Method in class com.botwithus.bot.api.input.InputDialog: Press Enter.
submit(DrawCommand) - Method in class com.botwithus.bot.api.draw.Draw: Route a fully-built command, answering the key it is stored under.
submit(DrawCommand) - Method in class com.botwithus.bot.api.draw.DrawFrame: Route a fully-built command, answering the key it is stored under.
submit(DrawCommand) - Method in interface com.botwithus.bot.api.draw.DrawTarget: Route a fully-built command, answering the key it is stored under.
submitted() - Method in record class com.botwithus.bot.api.draw.DrawBatchResult: Total commands the batch carried.
subscribe(Class, Consumer) - Method in interface com.botwithus.bot.api.event.EventBus: Subscribes a listener to receive events of the specified type.
subscribe(String, Consumer) - Method in interface com.botwithus.bot.api.isc.MessageBus: Subscribes a handler to receive messages on the given channel.
SUBTILE_SCALE - Static variable in class com.botwithus.bot.api.draw.DrawLimits: Fixed-point sub-tile divisions per tile, for DrawSpace.WORLD geometry.
success() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.OpResult: Returns the value of the success record component.
success() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScheduleOpResult: Returns the value of the success record component.
SUMMONING - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
SUMMONING - Static variable in class com.botwithus.bot.api.util.Skills
Surface (for framework callers that hold a ScriptManager instance) - Section in interface com.botwithus.bot.api.script.ScriptManager
Surface (for framework callers that hold a ScriptScheduler instance) - Section in interface com.botwithus.bot.api.script.ScriptScheduler
surfaceHeight() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns the value of the surfaceHeight record component.
surfaceWidth() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns the value of the surfaceWidth record component.
SystemAPI - Interface in com.botwithus.bot.api.domain: System-level operations: connectivity and client info.

T

TABLE - Enum constant in enum class com.botwithus.bot.api.component.ComponentType
targetIndex() - Method in class com.botwithus.bot.api.entities.Projectile: Server index of the target entity, or -1 when the projectile is aimed at a fixed tile.
targetIndex() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Returns the value of the targetIndex record component.
targetIndex() - Method in record class com.botwithus.bot.api.snapshot.Projectile: Returns the value of the targetIndex record component.
targetNpc() - Method in class com.botwithus.bot.api.entities.Projectile: Resolve the target endpoint to a live NPC.
targetPlayer() - Method in class com.botwithus.bot.api.entities.Projectile: Resolve the target endpoint to a live player.
targets() - Method in interface com.botwithus.bot.api.script.ManagementContext: Returns what the user has told this script to manage, as it is now.
targetServerIndex() - Method in record class com.botwithus.bot.api.event.SpotAnimEvent: Returns the value of the targetServerIndex record component.
targetsLocalPlayer() - Method in class com.botwithus.bot.api.entities.Projectile: true when this projectile is aimed at the local player — the "is this incoming at me" predicate.
targetType() - Method in class com.botwithus.bot.api.entities.Projectile: Raw engine entity-type tag for the target endpoint.
targetType() - Method in record class com.botwithus.bot.api.event.SpotAnimEvent: Returns the value of the targetType record component.
targetType() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Returns the value of the targetType record component.
targetType() - Method in record class com.botwithus.bot.api.snapshot.Projectile: Returns the value of the targetType record component.
targetX() - Method in record class com.botwithus.bot.api.event.WalkArrivedEvent: Returns the value of the targetX record component.
targetX() - Method in record class com.botwithus.bot.api.event.WalkCancelledEvent: Returns the value of the targetX record component.
targetX() - Method in record class com.botwithus.bot.api.event.WalkFailedEvent: Returns the value of the targetX record component.
targetX() - Method in record class com.botwithus.bot.api.model.WalkStatus: Returns the value of the targetX record component.
targetY() - Method in record class com.botwithus.bot.api.event.WalkArrivedEvent: Returns the value of the targetY record component.
targetY() - Method in record class com.botwithus.bot.api.event.WalkCancelledEvent: Returns the value of the targetY record component.
targetY() - Method in record class com.botwithus.bot.api.event.WalkFailedEvent: Returns the value of the targetY record component.
targetY() - Method in record class com.botwithus.bot.api.model.WalkStatus: Returns the value of the targetY record component.
Task - Interface in com.botwithus.bot.api.script: A discrete unit of work within a TaskScript.
TaskScript - Class in com.botwithus.bot.api.script: Base class for task-based scripts.
TEN - Enum constant in enum class com.botwithus.bot.api.inventory.Bank.TransferAmount
text() - Method in class com.botwithus.bot.api.component.ComponentNode
text() - Method in record class com.botwithus.bot.api.dialog.DialogOption: Returns the value of the text record component.
text() - Method in record class com.botwithus.bot.api.draw.DrawCaption.Literal: Returns the value of the text record component.
text() - Method in record class com.botwithus.bot.api.draw.DrawEntry: Returns the value of the text record component.
text() - Method in class com.botwithus.bot.api.input.InputDialog: The text typed so far, or empty when the dialog is closed.
text() - Method in record class com.botwithus.bot.api.model.ChatMessage: Returns the value of the text record component.
text() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the text record component.
text(String, int, int, String) - Method in interface com.botwithus.bot.api.draw.DrawTarget: A caption anchored at (x, y), drawn as-is.
Text(String, DrawSpace, DrawStyle, int, int, DrawCaption) - Constructor for record class com.botwithus.bot.api.draw.DrawCommand.Text: Creates an instance of a Text record class.
TEXT - Enum constant in enum class com.botwithus.bot.api.component.ComponentType
TEXT - Enum constant in enum class com.botwithus.bot.api.draw.DrawKind: A UTF-8 string anchored at a point.
textMatching(String) - Method in class com.botwithus.bot.api.component.ComponentQuery: Filter by label regex (full match against the label).
textSlotCapacity() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns the value of the textSlotCapacity record component.
textSlotsUsed() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns the value of the textSlotsUsed record component.
The text→component correlation - Section in class com.botwithus.bot.api.dialog.Dialog
thickness() - Method in record class com.botwithus.bot.api.draw.DrawEntry: Returns the value of the thickness record component.
thickness() - Method in record class com.botwithus.bot.api.draw.DrawStyle: Returns the value of the thickness record component.
thickness(int) - Method in class com.botwithus.bot.api.draw.DrawBuilder: Stroke width, DrawLimits.MIN_THICKNESS to DrawLimits.MAX_THICKNESS.
thickness(int) - Method in class com.botwithus.bot.api.draw.DrawCaptionBuilder: Stroke width, for the box a component highlight draws around its rect.
thickness(int) - Method in class com.botwithus.bot.api.draw.HighlightBuilder: Stroke width for the box drawn around the resolved marker.
THIEVING - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
THIEVING - Static variable in class com.botwithus.bot.api.util.Skills
Three ways this surprises people - Section in interface com.botwithus.bot.api.snapshot.DynamicRegion
tick() - Method in record class com.botwithus.bot.api.event.TickEvent: Returns the value of the tick record component.
TICK_MS - Static variable in class com.botwithus.bot.api.util.Timing
TickEvent - Record Class in com.botwithus.bot.api.event: Fired each game tick when the server tick counter advances.
TickEvent(int) - Constructor for record class com.botwithus.bot.api.event.TickEvent
TickEvent(int, long) - Constructor for record class com.botwithus.bot.api.event.TickEvent: Creates an instance of a TickEvent record class.
ticksToMs(int) - Static method in class com.botwithus.bot.api.util.Timing: Converts game ticks to milliseconds.
tile(int, int, int) - Method in interface com.botwithus.bot.api.draw.DrawTarget: Highlight one game tile under the conventional auto key tile:<x>:<y>:<plane>.
tile(String, int, int) - Method in interface com.botwithus.bot.api.draw.DrawTarget: Highlight one game tile on the ground floor, in whole tiles.
tile(String, int, int, int) - Method in interface com.botwithus.bot.api.draw.DrawTarget: Highlight one game tile on a named plane, in whole tiles.
Tile(String, DrawStyle, int, int, int, DrawCaption) - Constructor for record class com.botwithus.bot.api.draw.DrawCommand.Tile: Creates an instance of a Tile record class.
TILE - Enum constant in enum class com.botwithus.bot.api.draw.DrawKind: A ground footprint on one plane, named in whole tiles.
tileX() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Area: Returns the value of the tileX record component.
tileX() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Tile: Returns the value of the tileX record component.
tileX() - Method in interface com.botwithus.bot.api.entities.EntityContext: Absolute world tile X.
tileX() - Method in class com.botwithus.bot.api.entities.GroundItem
tileX() - Method in class com.botwithus.bot.api.entities.Npc
tileX() - Method in class com.botwithus.bot.api.entities.Player
tileX() - Method in class com.botwithus.bot.api.entities.Projectile: Impact tile X — see the position-semantics note on the class.
tileX() - Method in class com.botwithus.bot.api.entities.SceneObject
tileX() - Method in record class com.botwithus.bot.api.event.SpotAnimEvent: Returns the value of the tileX record component.
tileX() - Method in record class com.botwithus.bot.api.model.GroundItemInfo: Returns the value of the tileX record component.
tileX() - Method in record class com.botwithus.bot.api.model.SceneObjectInfo: Returns the value of the tileX record component.
tileX() - Method in record class com.botwithus.bot.api.model.WorldMapElement: Returns the value of the tileX record component.
tileX() - Method in record class com.botwithus.bot.api.model.WorldMapPlacement: Returns the value of the tileX record component.
tileX() - Method in record class com.botwithus.bot.api.snapshot.GroundItem: Returns the value of the tileX record component.
tileX() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Returns the value of the tileX record component.
tileX() - Method in record class com.botwithus.bot.api.snapshot.Location: Returns the value of the tileX record component.
tileX() - Method in record class com.botwithus.bot.api.snapshot.Npc: Returns the value of the tileX record component.
tileX() - Method in record class com.botwithus.bot.api.snapshot.Player: Returns the value of the tileX record component.
tileX() - Method in record class com.botwithus.bot.api.snapshot.SourceTile: Returns the value of the tileX record component.
tileY() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Area: Returns the value of the tileY record component.
tileY() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Tile: Returns the value of the tileY record component.
tileY() - Method in interface com.botwithus.bot.api.entities.EntityContext: Absolute world tile Y.
tileY() - Method in class com.botwithus.bot.api.entities.GroundItem
tileY() - Method in class com.botwithus.bot.api.entities.Npc
tileY() - Method in class com.botwithus.bot.api.entities.Player
tileY() - Method in class com.botwithus.bot.api.entities.Projectile: Impact tile Y — see the position-semantics note on the class.
tileY() - Method in class com.botwithus.bot.api.entities.SceneObject
tileY() - Method in record class com.botwithus.bot.api.event.SpotAnimEvent: Returns the value of the tileY record component.
tileY() - Method in record class com.botwithus.bot.api.model.GroundItemInfo: Returns the value of the tileY record component.
tileY() - Method in record class com.botwithus.bot.api.model.SceneObjectInfo: Returns the value of the tileY record component.
tileY() - Method in record class com.botwithus.bot.api.model.WorldMapElement: Returns the value of the tileY record component.
tileY() - Method in record class com.botwithus.bot.api.model.WorldMapPlacement: Returns the value of the tileY record component.
tileY() - Method in record class com.botwithus.bot.api.snapshot.GroundItem: Returns the value of the tileY record component.
tileY() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Returns the value of the tileY record component.
tileY() - Method in record class com.botwithus.bot.api.snapshot.Location: Returns the value of the tileY record component.
tileY() - Method in record class com.botwithus.bot.api.snapshot.Npc: Returns the value of the tileY record component.
tileY() - Method in record class com.botwithus.bot.api.snapshot.Player: Returns the value of the tileY record component.
tileY() - Method in record class com.botwithus.bot.api.snapshot.SourceTile: Returns the value of the tileY record component.
TIMEOUT - Enum constant in enum class com.botwithus.bot.api.model.WalkResult: The walk timed out waiting for a result.
timestamp() - Method in record class com.botwithus.bot.api.event.ActionExecutedEvent: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.event.BreakEndedEvent: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.event.BreakStartedEvent: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.event.ChatMessageEvent: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.event.ConnectionLostEvent: Returns the value of the timestamp record component.
timestamp() - Method in interface com.botwithus.bot.api.event.GameEvent: Timestamp at which the event was constructed, in milliseconds since epoch.
timestamp() - Method in record class com.botwithus.bot.api.event.KeyInputEvent: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.event.LoginStateChangeEvent: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.event.ObjVarChangeEvent: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.event.RadioGroupSelectEvent: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.event.ReconnectStateChangedEvent: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.event.ScriptCrashedEvent: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.event.ScriptLoadFailedEvent: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.event.SpotAnimEvent: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.event.TickEvent: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.event.VarbitChangeEvent: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.event.VarcChangeEvent: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.event.VarChangeEvent: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.event.WalkArrivedEvent: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.event.WalkCancelledEvent: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.event.WalkFailedEvent: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.isc.ScriptMessage: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.model.ActionEntry: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.runtime.ReconnectState.Connected: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.runtime.ReconnectState.Disconnected: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.runtime.ReconnectState.GivingUp: Returns the value of the timestamp record component.
timestamp() - Method in record class com.botwithus.bot.api.runtime.ReconnectState.Reconnecting: Returns the value of the timestamp record component.
timestamp() - Method in interface com.botwithus.bot.api.runtime.ReconnectState
Timing - Section in class com.botwithus.bot.api.input.InputDialog
Timing - Class in com.botwithus.bot.api.util: Tick-aware timing utilities for bot scripts.
title() - Method in record class com.botwithus.bot.api.model.ResourceSection: Returns the value of the title record component.
tooltip() - Method in record class com.botwithus.bot.api.model.WorldMapElement: Returns the value of the tooltip record component.
TOOLTIP - Enum constant in enum class com.botwithus.bot.api.component.ComponentType
TOP_LEVEL_COMPONENT - Static variable in interface com.botwithus.bot.api.GameAPI: Sub-component id meaning "the component itself" in a component trigger.
toString() - Method in class com.botwithus.bot.api.component.ComponentNode
toString() - Method in record class com.botwithus.bot.api.config.ConfigField.BoolField: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.config.ConfigField.ChoiceField: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.config.ConfigField.IntField: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.config.ConfigField.ItemIdField: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.config.ConfigField.StringField: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.config.ScriptConfig: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.dialog.DialogOption: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.draw.DrawBatchResult: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.draw.DrawCaption.FixedPoint: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.draw.DrawCaption.Literal: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.draw.DrawCaption.None: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Area: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.draw.DrawCommand.ComponentTarget: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Ellipse: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Entity: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Line: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Poly: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Rect: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Text: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Tile: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.draw.DrawEntry: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.draw.DrawStats: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.draw.DrawStyle: Returns a string representation of this record class.
toString() - Method in class com.botwithus.bot.api.entities.GroundItem
toString() - Method in class com.botwithus.bot.api.entities.Npc
toString() - Method in class com.botwithus.bot.api.entities.Player
toString() - Method in class com.botwithus.bot.api.entities.Projectile
toString() - Method in class com.botwithus.bot.api.entities.SceneObject
toString() - Method in record class com.botwithus.bot.api.event.ActionExecutedEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.event.BreakEndedEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.event.BreakStartedEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.event.ChatMessageEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.event.ConnectionLostEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.event.KeyInputEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.event.LoginStateChangeEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.event.ObjVarChangeEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.event.RadioGroupSelectEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.event.ReconnectStateChangedEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.event.ScriptCrashedEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.event.ScriptLoadFailedEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.event.SpotAnimEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.event.TickEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.event.VarbitChangeEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.event.VarcChangeEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.event.VarChangeEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.event.WalkArrivedEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.event.WalkCancelledEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.event.WalkFailedEvent: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.gameval.GamevalEntry: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.gameval.GamevalRef: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.input.KeyStroke: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.isc.ScriptMessage: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.ActionEntry: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.ChatMessage: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.Component: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.ComponentRef: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.ComponentTreeNode: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.ComponentTrigger: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.EnumType: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.GameAction: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.GroundItemInfo: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.ItemType: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.LocationType: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.LoginState: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.NpcType: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.PathResult: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.PlayerStat: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.QuestType: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.ResourceItem: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.ResourceSection: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.SceneObjectInfo: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.ScriptResult: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.SequenceType: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.SkillRequirement: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.StructType: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.VarbitRead: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.VarbitType: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.VarbitValue: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.VarpRead: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.WalkStatus: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.WorldMapElement: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.WorldMapPlacement: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.model.WorldPathConfig: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.runtime.LastCrash: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.runtime.ReconnectState.Connected: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.runtime.ReconnectState.Disconnected: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.runtime.ReconnectState.GivingUp: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.runtime.ReconnectState.Reconnecting: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.runtime.ScriptHealth: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.OpResult: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScheduledScriptEntry: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScheduleOpResult: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScriptStatusEntry: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.LaunchedClient.LaunchedBy: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.LaunchedClient.Licence: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.LaunchedClient: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.LauncherAccount: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.LauncherEvent.AgentUpdated: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ClientExited: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ClientStarted: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ClientStateChanged: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.LauncherEvent.DataUpdateApplied: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.LauncherEvent.DataUpdateAvailable: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.LauncherEvent.EventsDropped: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.LauncherEvent.LicenceChanged: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ServiceLost: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ServiceRestored: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.LauncherEvent.ServiceShuttingDown: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.LaunchOptions: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.LaunchOutcome.Attached: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.LaunchOutcome.AttachFailed: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.LaunchOutcome.Failed: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.ManagementTarget.ClientScript: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.ManagementTarget.Group: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.ManagementTarget.WholeHost: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.ScriptInfo: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.script.ScriptScheduler.ScheduledEntry: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.snapshot.GroundItem: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.snapshot.Inventory: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.snapshot.InventoryItem: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.snapshot.Location: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.snapshot.Npc: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.snapshot.OpenInterface: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.snapshot.Orientation: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.snapshot.Player: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.snapshot.Projectile: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.snapshot.Skill: Returns a string representation of this record class.
toString() - Method in record class com.botwithus.bot.api.snapshot.SourceTile: Returns a string representation of this record class.
totalCrashes() - Method in record class com.botwithus.bot.api.runtime.ScriptHealth: Returns the value of the totalCrashes record component.
totalNavSteps() - Method in record class com.botwithus.bot.api.model.WalkStatus: Returns the value of the totalNavSteps record component.
totalSteps() - Method in record class com.botwithus.bot.api.model.WalkStatus: Returns the value of the totalSteps record component.
toTarget(int) - Static method in interface com.botwithus.bot.api.snapshot.ProjectileFilter: Projectiles aimed at the given target entity (NPC/player server index).
toTile() - Static method in interface com.botwithus.bot.api.snapshot.ProjectileFilter: Projectiles aimed at a fixed tile rather than an entity.
trace(String, Object...) - Method in interface com.botwithus.bot.api.log.BotLogger
trace(String, String) - Method in interface com.botwithus.bot.api.debug.ScriptContextPublisher: Free-form trace line.
TRACE - Enum constant in enum class com.botwithus.bot.api.log.LogLevel
TRANSFER - Enum constant in enum class com.botwithus.bot.api.inventory.Bank.BankSetting
transferMode() - Method in class com.botwithus.bot.api.inventory.Bank: Currently selected transfer mode (1 / 5 / 10 / custom / all).
transforms() - Method in record class com.botwithus.bot.api.model.LocationType: Returns the value of the transforms record component.
transforms() - Method in record class com.botwithus.bot.api.model.NpcType: Returns the value of the transforms record component.
transitionCost() - Method in record class com.botwithus.bot.api.model.WorldPathConfig: Returns the value of the transitionCost record component.
transitionCost(float) - Method in class com.botwithus.bot.api.model.WorldPathConfig.Builder
transportCost() - Method in record class com.botwithus.bot.api.model.WorldPathConfig: Returns the value of the transportCost record component.
transportCost(float) - Method in class com.botwithus.bot.api.model.WorldPathConfig.Builder
tree() - Method in class com.botwithus.bot.api.component.ComponentQuery: The materialized subtree (one fetch, cached for this query).
TRIGGER_TYPE_CLICK - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
TRIGGER_TYPE_KEY - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
triggers() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the triggers record component.
ttl(long) - Method in class com.botwithus.bot.api.draw.DrawBuilder: Lifetime in milliseconds.
ttl(long) - Method in class com.botwithus.bot.api.draw.DrawCaptionBuilder: Lifetime in milliseconds.
ttl(long) - Method in class com.botwithus.bot.api.draw.HighlightBuilder: Lifetime in milliseconds.
ttl(Duration) - Method in class com.botwithus.bot.api.draw.DrawBuilder: Lifetime as a Duration, truncated to whole milliseconds.
ttl(Duration) - Method in class com.botwithus.bot.api.draw.DrawCaptionBuilder: Lifetime as a Duration, truncated to whole milliseconds.
ttl(Duration) - Method in class com.botwithus.bot.api.draw.HighlightBuilder: Lifetime as a Duration, truncated to whole milliseconds.
TTL_UNTIL_CLEARED - Static variable in class com.botwithus.bot.api.draw.DrawLimits: TTL meaning "until replaced, cleared, or my connection closes".
ttlMs() - Method in record class com.botwithus.bot.api.draw.DrawStyle: Returns the value of the ttlMs record component.
tweened() - Method in record class com.botwithus.bot.api.model.SequenceType: Returns the value of the tweened record component.
type() - Method in class com.botwithus.bot.api.component.ComponentNode: Stable semantic category (decoded from the wire category code).
type() - Method in interface com.botwithus.bot.api.event.GameEvent: Returns the event's simple class name as a stable string discriminator.
type() - Method in record class com.botwithus.bot.api.gameval.GamevalEntry: Returns the value of the type record component.
type() - Method in exception class com.botwithus.bot.api.gameval.GamevalNotFoundException: Namespace the lookup was made in.
type() - Method in record class com.botwithus.bot.api.gameval.GamevalRef: Returns the value of the type record component.
type() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the type record component.
type() - Method in record class com.botwithus.bot.api.model.ComponentTrigger: Returns the value of the type record component.
type() - Method in record class com.botwithus.bot.api.snapshot.OpenInterface: Returns the value of the type record component.
TYPE_CLIENT_CHILD - Static variable in record class com.botwithus.bot.api.snapshot.OpenInterface: A child opened by a client script, closed along with its parent.
TYPE_MASK - Static variable in record class com.botwithus.bot.api.snapshot.OpenInterface: Bits 0-2 of a wire flags byte: the open type.
TYPE_MODAL - Static variable in record class com.botwithus.bot.api.snapshot.OpenInterface: Closes when the player moves; the bank and dialogues.
TYPE_OVERLAY - Static variable in record class com.botwithus.bot.api.snapshot.OpenInterface: HUD panels and other persistent overlays.
TYPE_UNKNOWN - Static variable in record class com.botwithus.bot.api.snapshot.OpenInterface: The client's type was out of the publishable range.
typeId() - Method in class com.botwithus.bot.api.entities.Npc
typeId() - Method in class com.botwithus.bot.api.entities.SceneObject: The loc id the server sent.
typeId() - Method in record class com.botwithus.bot.api.model.SceneObjectInfo: Returns the value of the typeId record component.
typeId() - Method in record class com.botwithus.bot.api.snapshot.Location: Returns the value of the typeId record component.
typeId() - Method in record class com.botwithus.bot.api.snapshot.Npc: Returns the value of the typeId record component.
typeId() - Method in record class com.botwithus.bot.api.snapshot.Skill: Returns the value of the typeId record component.
typeId(int) - Static method in interface com.botwithus.bot.api.snapshot.LocationFilter
typeId(int) - Static method in interface com.botwithus.bot.api.snapshot.NpcFilter

U

UI - Enum constant in enum class com.botwithus.bot.api.script.LaunchedClient.Origin
UI_ANIM - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Interface animations.
UI_ANIM_CURVE - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Interface animation curves.
unavailable() - Static method in interface com.botwithus.bot.api.script.ClientLauncher: A launcher whose every call throws LauncherException.SERVICE_UNAVAILABLE: what a host that does not talk to the launcher service offers.
UNAVAILABLE - Enum constant in enum class com.botwithus.bot.api.model.VarpState: The read could not be made: not in game, still entering the world, an invalid id, or a timed-out read.
UNCATEGORIZED - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
under(int, int) - Method in class com.botwithus.bot.api.component.Components: Start a query over the subtree rooted at (interfaceId, componentId).
under(String) - Method in class com.botwithus.bot.api.component.Components: Query over the subtree rooted at the component named by its gameval, e.g.
unequip(Equipment.Slot) - Method in class com.botwithus.bot.api.inventory.Equipment: Convenience: try the standard unequip options ("Remove" / "Unequip") on the slot.
unknown() - Static method in record class com.botwithus.bot.api.snapshot.Orientation: An orientation that was not read.
UNKNOWN - Enum constant in enum class com.botwithus.bot.api.component.ComponentType
UNKNOWN - Enum constant in enum class com.botwithus.bot.api.model.VarKind: Not reported: the varp is not set, or the agent predates kinds.
UNKNOWN - Enum constant in enum class com.botwithus.bot.api.script.LaunchedClient.Kind
UNKNOWN - Enum constant in enum class com.botwithus.bot.api.script.LaunchedClient.LicenceState
UNKNOWN - Enum constant in enum class com.botwithus.bot.api.script.LaunchedClient.Origin
UNKNOWN - Enum constant in enum class com.botwithus.bot.api.script.LaunchedClient.State
UNKNOWN - Enum constant in enum class com.botwithus.bot.api.script.LauncherEvent.DataPhase
UNKNOWN - Enum constant in enum class com.botwithus.bot.api.script.LauncherEvent.ExitReason
UNKNOWN_RAW - Static variable in record class com.botwithus.bot.api.snapshot.Orientation: Orientation.raw() when the facing is not known.
UNKNOWN_ROTATION - Static variable in record class com.botwithus.bot.api.model.SceneObjectInfo: SceneObjectInfo.rotation() for a row built without one.
UNKNOWN_SHAPE - Static variable in record class com.botwithus.bot.api.model.SceneObjectInfo: SceneObjectInfo.shape() for a row built without one.
UNRESOLVED_VARIABLE - Static variable in interface com.botwithus.bot.api.GameAPI: Value the gameval-named variable reads return when the name does not resolve — the same "no value" sentinel VariableAPI.getVarp(int) yields for a varp that does not exist or could not be read.
unsubscribe(Class, Consumer) - Method in interface com.botwithus.bot.api.event.EventBus: Removes a previously registered listener for the specified event type.
unsubscribe(String, Consumer) - Method in interface com.botwithus.bot.api.isc.MessageBus: Removes a previously registered handler from the given channel.
untilCleared() - Method in class com.botwithus.bot.api.draw.DrawBuilder: Keep this command until it is replaced, cleared, or the script's connection closes.
untilCleared() - Method in class com.botwithus.bot.api.draw.DrawCaptionBuilder: Keep until replaced, cleared, or the script's connection closes.
untilCleared() - Method in class com.botwithus.bot.api.draw.HighlightBuilder: Keep this highlight until it is replaced, cleared, or the script's connection closes.
UNTRACKED - Enum constant in enum class com.botwithus.bot.api.script.LaunchedClient.LicenceState: The service could not take the licence over after a restart.
use(int) - Method in class com.botwithus.bot.api.inventory.Backpack: Convenience: equivalent to InventoryContainer.interactFirst(int, String) for clarity.
UTILITY - Enum constant in enum class com.botwithus.bot.api.ScriptCategory

V

validate() - Method in interface com.botwithus.bot.api.script.Task: Returns true if this task should execute on the current loop iteration.
value() - Method in record class com.botwithus.bot.api.config.ConfigField.BoolField: Returns the value of the value record component.
value() - Method in record class com.botwithus.bot.api.config.ConfigField.ChoiceField: Returns the value of the value record component.
value() - Method in record class com.botwithus.bot.api.config.ConfigField.IntField: Returns the value of the value record component.
value() - Method in record class com.botwithus.bot.api.config.ConfigField.ItemIdField: Returns the value of the value record component.
value() - Method in record class com.botwithus.bot.api.config.ConfigField.StringField: Returns the value of the value record component.
value() - Method in record class com.botwithus.bot.api.draw.DrawCaption.FixedPoint: Returns the value of the value record component.
value() - Method in record class com.botwithus.bot.api.event.RadioGroupSelectEvent: Returns the value of the value record component.
value() - Method in record class com.botwithus.bot.api.model.VarbitRead: Returns the value of the value record component.
value() - Method in record class com.botwithus.bot.api.model.VarbitValue: Returns the value of the value record component.
value() - Method in record class com.botwithus.bot.api.model.VarpRead: Returns the value of the value record component.
value(long) - Method in class com.botwithus.bot.api.draw.DrawCaptionBuilder: Draw this whole number.
value(long) - Method in class com.botwithus.bot.api.draw.HighlightBuilder: Caption with a whole number.
value(long, int) - Method in class com.botwithus.bot.api.draw.DrawCaptionBuilder: Draw this scaled number: value(1234, 2) renders "12.34".
value(long, int) - Method in class com.botwithus.bot.api.draw.HighlightBuilder: Caption with a scaled number: value(1234, 2) renders "12.34".
value(String, int, int, long, int) - Method in interface com.botwithus.bot.api.draw.DrawTarget: A scaled number anchored at (x, y): value(key, x, y, 1234, 2) draws "12.34".
value64() - Method in record class com.botwithus.bot.api.model.VarpRead: Returns the value of the value64 record component.
valueOf(String) - Static method in enum class com.botwithus.bot.api.component.ComponentType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.draw.DrawFont: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.draw.DrawKind: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.draw.DrawSpace: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.draw.EntityRef: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.gameval.GamevalType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.input.InputMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.inventory.Bank.BankSetting: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.inventory.Bank.SideView: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.inventory.Bank.TransferAmount: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.inventory.Bank.WithdrawMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.inventory.Equipment.Slot: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.log.LogLevel: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.model.VarKind: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.model.VarpState: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.model.WalkResult: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.runtime.Liveness: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.runtime.Phase: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.script.LaunchedClient.Kind: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.script.LaunchedClient.LicenceState: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.script.LaunchedClient.Origin: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.script.LaunchedClient.State: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.script.LauncherEvent.DataPhase: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.script.LauncherEvent.ExitReason: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.script.StopMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.ScriptCategory: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.botwithus.bot.api.snapshot.Direction: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.botwithus.bot.api.component.ComponentType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Method in record class com.botwithus.bot.api.config.ScriptConfig: Returns the value of the values record component.
values() - Static method in enum class com.botwithus.bot.api.draw.DrawFont: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.draw.DrawKind: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.draw.DrawSpace: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.draw.EntityRef: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.gameval.GamevalType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.input.InputMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.inventory.Bank.BankSetting: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.inventory.Bank.SideView: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.inventory.Bank.TransferAmount: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.inventory.Bank.WithdrawMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.inventory.Equipment.Slot: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.log.LogLevel: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.model.VarKind: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.model.VarpState: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.model.WalkResult: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.runtime.Liveness: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.runtime.Phase: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.script.LaunchedClient.Kind: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.script.LaunchedClient.LicenceState: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.script.LaunchedClient.Origin: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.script.LaunchedClient.State: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.script.LauncherEvent.DataPhase: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.script.LauncherEvent.ExitReason: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.script.StopMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.ScriptCategory: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.botwithus.bot.api.snapshot.Direction: Returns an array containing the constants of this enum class, in the order they are declared.
VAR_CLAN - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Clan variables.
VAR_CLAN_SETTING - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Clan-setting variables.
VAR_CLIENT - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Client variables.
VAR_NPC - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: NPC variables.
VAR_OBJECT - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Scenery variables.
VAR_PLAYER_GROUP - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Player-group variables.
VARBIT - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Player variable bits.
VARBIT_CLAN - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Clan variable bits.
VARBIT_CLAN_SETTING - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Clan-setting variable bits.
VARBIT_NPC - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: NPC variable bits.
VARBIT_OBJECT - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Scenery variable bits.
VarbitChangeEvent - Record Class in com.botwithus.bot.api.event: Fired when a varbit changes value.
VarbitChangeEvent(int, int, int) - Constructor for record class com.botwithus.bot.api.event.VarbitChangeEvent
VarbitChangeEvent(int, int, int, long) - Constructor for record class com.botwithus.bot.api.event.VarbitChangeEvent: Creates an instance of a VarbitChangeEvent record class.
varbitId() - Method in record class com.botwithus.bot.api.model.LocationType: Returns the value of the varbitId record component.
varbitId() - Method in record class com.botwithus.bot.api.model.NpcType: Returns the value of the varbitId record component.
varbitId() - Method in record class com.botwithus.bot.api.model.VarbitValue: Returns the value of the varbitId record component.
VarbitRead - Record Class in com.botwithus.bot.api.model: One varbit read.
VarbitRead(int, VarpState, int, boolean) - Constructor for record class com.botwithus.bot.api.model.VarbitRead: Creates an instance of a VarbitRead record class.
VarbitType - Record Class in com.botwithus.bot.api.model: Varbit (variable bit) definition from the game cache.
VarbitType(int, int, int, int, int) - Constructor for record class com.botwithus.bot.api.model.VarbitType: Creates an instance of a VarbitType record class.
VarbitValue - Record Class in com.botwithus.bot.api.model: A resolved varbit value: the varbit id paired with its current decoded value.
VarbitValue(int, int) - Constructor for record class com.botwithus.bot.api.model.VarbitValue: Creates an instance of a VarbitValue record class.
VarcChangeEvent - Record Class in com.botwithus.bot.api.event: Fired when a client variable (varc) changes value.
VarcChangeEvent(int, int, int) - Constructor for record class com.botwithus.bot.api.event.VarcChangeEvent
VarcChangeEvent(int, int, int, long) - Constructor for record class com.botwithus.bot.api.event.VarcChangeEvent: Creates an instance of a VarcChangeEvent record class.
VarChangeEvent - Record Class in com.botwithus.bot.api.event: Fired when a player variable (varp) changes value.
VarChangeEvent(int, int, int) - Constructor for record class com.botwithus.bot.api.event.VarChangeEvent
VarChangeEvent(int, int, int, long) - Constructor for record class com.botwithus.bot.api.event.VarChangeEvent: Creates an instance of a VarChangeEvent record class.
VariableAPI - Interface in com.botwithus.bot.api.domain: Game variable access: varps (player variables), varbits (bit-ranges of a base variable), and varcs (client variables, int- and string-valued).
varId() - Method in record class com.botwithus.bot.api.event.ObjVarChangeEvent: Returns the value of the varId record component.
varId() - Method in record class com.botwithus.bot.api.event.VarbitChangeEvent: Returns the value of the varId record component.
varId() - Method in record class com.botwithus.bot.api.event.VarcChangeEvent: Returns the value of the varId record component.
varId() - Method in record class com.botwithus.bot.api.event.VarChangeEvent: Returns the value of the varId record component.
varId() - Method in record class com.botwithus.bot.api.model.VarbitType: Returns the value of the varId record component.
VarKind - Enum Class in com.botwithus.bot.api.model: How the client stores a set varp's value.
VARP - Enum constant in enum class com.botwithus.bot.api.gameval.GamevalType: Player variables.
varpId() - Method in record class com.botwithus.bot.api.model.LocationType: Returns the value of the varpId record component.
varpId() - Method in record class com.botwithus.bot.api.model.NpcType: Returns the value of the varpId record component.
VarpRead - Record Class in com.botwithus.bot.api.model: One varp read: its state, and the value the game would read for it.
VarpRead(int, VarpState, int, long, VarKind, boolean) - Constructor for record class com.botwithus.bot.api.model.VarpRead: Creates an instance of a VarpRead record class.
varpState(int) - Method in interface com.botwithus.bot.api.domain.VariableAPI: Just the state of a varp: whether it is set, at its default, missing, or unknown.
VarpState - Enum Class in com.botwithus.bot.api.model: What a varp read found out about the variable.
version() - Method in record class com.botwithus.bot.api.script.ClientOrchestrator.ScriptStatusEntry: Returns the value of the version record component.
version() - Method in record class com.botwithus.bot.api.script.ScriptInfo: Returns the value of the version record component.
version() - Element in annotation interface com.botwithus.bot.api.ScriptManifest: The version string of the script.
view() - Method in class com.botwithus.bot.api.inventory.Bank: Side-panel view alongside the bank grid.
visible() - Method in class com.botwithus.bot.api.component.ComponentQuery: Keep only visible components (treats unsupported-hidden as visible).
visible() - Method in class com.botwithus.bot.api.entities.EntityQuery: Convenience shim — the snapshot only carries visible entities, so this method is a no-op chain.
visible() - Method in record class com.botwithus.bot.api.model.NpcType: Returns the value of the visible record component.
visible() - Static method in interface com.botwithus.bot.api.snapshot.LocationFilter

W

w() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Ellipse: Returns the value of the w record component.
w() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Rect: Returns the value of the w record component.
WALK - Static variable in class com.botwithus.bot.api.inventory.ActionTypes
WalkArrivedEvent - Record Class in com.botwithus.bot.api.event: Fired when the walker reaches its destination.
WalkArrivedEvent(int, int) - Constructor for record class com.botwithus.bot.api.event.WalkArrivedEvent
WalkArrivedEvent(int, int, long) - Constructor for record class com.botwithus.bot.api.event.WalkArrivedEvent: Creates an instance of a WalkArrivedEvent record class.
walkCancel() - Method in interface com.botwithus.bot.api.domain.NavigationAPI: Cancels the walk this script started.
WalkCancelledEvent - Record Class in com.botwithus.bot.api.event: Fired when a walk is cancelled (explicitly via walkCancel(), or implicitly when an action interrupts it).
WalkCancelledEvent(int, int) - Constructor for record class com.botwithus.bot.api.event.WalkCancelledEvent
WalkCancelledEvent(int, int, long) - Constructor for record class com.botwithus.bot.api.event.WalkCancelledEvent: Creates an instance of a WalkCancelledEvent record class.
WalkFailedEvent - Record Class in com.botwithus.bot.api.event: Fired when a walk fails (pathfinding failure, stuck timeout, context loss, etc.).
WalkFailedEvent(int, int) - Constructor for record class com.botwithus.bot.api.event.WalkFailedEvent
WalkFailedEvent(int, int, long) - Constructor for record class com.botwithus.bot.api.event.WalkFailedEvent: Creates an instance of a WalkFailedEvent record class.
walkingPrecedence() - Method in record class com.botwithus.bot.api.model.SequenceType: Returns the value of the walkingPrecedence record component.
walkRefusalCount() - Method in interface com.botwithus.bot.api.domain.NavigationAPI: How many of the calling script's walk requests have been refused because another script held the character.
WalkResult - Enum Class in com.botwithus.bot.api.model: Result of a blocking walk operation.
WalkStatus - Record Class in com.botwithus.bot.api.model: Current walker state.
WalkStatus(String, int, int, int, int, int, int, boolean, boolean, boolean) - Constructor for record class com.botwithus.bot.api.model.WalkStatus: Creates an instance of a WalkStatus record class.
walkTo(int, int) - Method in interface com.botwithus.bot.api.Navigation: Walks to a tile using local A* pathfinding and blocks until completion.
walkTo(int, int, long) - Method in interface com.botwithus.bot.api.Navigation: Walks to a tile using local A* pathfinding and blocks until completion or timeout.
walkToAsync(int, int) - Method in interface com.botwithus.bot.api.domain.NavigationAPI: Starts a local A* walk to the given tile.
walkWorldPath(int, int) - Method in interface com.botwithus.bot.api.GameAPI: No-plane convenience for NavigationAPI.walkWorldPathAsync(int, int, int) — uses the local player's current plane, falling back to plane 0 when not in-game.
walkWorldPath(int, int) - Method in interface com.botwithus.bot.api.Navigation: Walks a world path on plane 0 and blocks until completion.
walkWorldPath(int, int, int) - Method in interface com.botwithus.bot.api.domain.NavigationAPI: Plane-aware convenience — equivalent to walkWorldPathAsync(x, y, plane).
walkWorldPath(int, int, int) - Method in interface com.botwithus.bot.api.Navigation: Walks a world path (with teleport/door/shortcut support) and blocks until completion.
walkWorldPath(int, int, int, boolean) - Method in interface com.botwithus.bot.api.Navigation: Walks a world path with exact destination tile control and blocks until completion.
walkWorldPath(int, int, int, boolean, WorldPathConfig) - Method in interface com.botwithus.bot.api.Navigation: Walks a world path with full pathfinder configuration and blocks until completion.
walkWorldPath(int, int, int, boolean, WorldPathConfig, long) - Method in interface com.botwithus.bot.api.Navigation: Walks a world path with full pathfinder configuration and blocks until completion or timeout.
walkWorldPath(int, int, int, long) - Method in interface com.botwithus.bot.api.Navigation: Walks a world path and blocks until completion or timeout.
walkWorldPathAsync(int, int, int) - Method in interface com.botwithus.bot.api.domain.NavigationAPI: Starts a world-scale walk using HPA*/flat A* with teleport, door, shortcut, and transport support.
walkWorldPathAsync(int, int, int, boolean) - Method in interface com.botwithus.bot.api.domain.NavigationAPI: Starts a world-scale walk with exact destination tile control.
walkWorldPathAsync(int, int, int, boolean, WorldPathConfig) - Method in interface com.botwithus.bot.api.domain.NavigationAPI: Starts a world-scale walk with full pathfinder configuration.
warn(String, Object...) - Method in interface com.botwithus.bot.api.log.BotLogger
WARN - Enum constant in enum class com.botwithus.bot.api.log.LogLevel
warnOnce(String) - Method in class com.botwithus.bot.api.diag.StubGuard: Fires the sink the first time methodName is observed; suppresses subsequent calls for the same name.
WEAPON - Enum constant in enum class com.botwithus.bot.api.inventory.Equipment.Slot
wearpos() - Method in record class com.botwithus.bot.api.model.ItemType: Returns the value of the wearpos record component.
wearpos2() - Method in record class com.botwithus.bot.api.model.ItemType: Returns the value of the wearpos2 record component.
wearpos3() - Method in record class com.botwithus.bot.api.model.ItemType: Returns the value of the wearpos3 record component.
WEST - Enum constant in enum class com.botwithus.bot.api.snapshot.Direction
when() - Method in record class com.botwithus.bot.api.runtime.LastCrash: Returns the value of the when record component.
WHITE - Static variable in class com.botwithus.bot.api.draw.Colors
WholeHost() - Constructor for record class com.botwithus.bot.api.script.ManagementTarget.WholeHost: Creates an instance of a WholeHost record class.
width() - Method in class com.botwithus.bot.api.component.ComponentNode
width() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the width record component.
widthTiles() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Area: Returns the value of the widthTiles record component.
widthTiles() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Entity: Returns the value of the widthTiles record component.
wire() - Method in enum class com.botwithus.bot.api.gameval.GamevalType: The etype key this type is stored under in the index.
WIRE_UNKNOWN - Static variable in record class com.botwithus.bot.api.snapshot.Orientation: What the producer publishes on the wire for "not known": an all-ones u16.
wireName() - Method in enum class com.botwithus.bot.api.draw.DrawFont: The lower-case token this style is spelled as in the font field.
wireName() - Method in enum class com.botwithus.bot.api.draw.DrawKind: The lower-case token this kind is spelled as in the kind field.
wireName() - Method in enum class com.botwithus.bot.api.draw.DrawSpace: The lower-case token this space is spelled as in the space field.
wireName() - Method in enum class com.botwithus.bot.api.draw.EntityRef: The lower-case token this reference is spelled as — both as the highlight_entity parameter name and as the auto key's prefix.
withAlpha(int, int) - Static method in class com.botwithus.bot.api.draw.Colors: The same colour at a different 0..255 alpha.
withCategory(int) - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
withCrash(LastCrash) - Method in record class com.botwithus.bot.api.runtime.ScriptHealth: Returns a new ScriptHealth with the given crash recorded and ScriptHealth.totalCrashes incremented by one.
withDescription() - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
withdraw(int, Bank.TransferAmount) - Method in class com.botwithus.bot.api.inventory.Bank: Withdraw one stack of itemId with the given transfer amount.
withdrawAll(int) - Method in class com.botwithus.bot.api.inventory.Bank: Withdraw the entire stack of itemId.
withdrawMode() - Method in class com.botwithus.bot.api.inventory.Bank: Withdraw mode — items as-is or as bank notes.
withdrawPreset(int) - Method in class com.botwithus.bot.api.inventory.Bank: Withdraw a saved bank preset (1-18) through the quick-preset buttons, flipping to the preset's page first when needed (presets 10-18 live on the second page).
withFont(DrawFont) - Method in record class com.botwithus.bot.api.draw.DrawCaption.FixedPoint
withFont(DrawFont) - Method in record class com.botwithus.bot.api.draw.DrawCaption.Literal
withFont(DrawFont) - Method in record class com.botwithus.bot.api.draw.DrawCaption.None
withFont(DrawFont) - Method in interface com.botwithus.bot.api.draw.DrawCaption: This caption in a different style.
withGameval(String...) - Method in class com.botwithus.bot.api.component.ComponentQuery: Filter by gameval symbolic name, e.g.
withGameval(String...) - Method in class com.botwithus.bot.api.entities.GroundItems.Query: Filter by the item's gameval symbolic name, e.g.
withGameval(String...) - Method in class com.botwithus.bot.api.entities.Npcs.Query: Filter by gameval symbolic name, e.g.
withGameval(String...) - Method in class com.botwithus.bot.api.entities.SceneObjects.Query: Filter by gameval symbolic name, e.g.
withHealth(int, int) - Method in record class com.botwithus.bot.api.snapshot.LocalPlayer: Copy of this record carrying the supplied health reading.
withId(int) - Method in class com.botwithus.bot.api.component.ComponentQuery: Filter by component id within the interface.
withId(int) - Method in class com.botwithus.bot.api.entities.EntityQuery: Filter by type/definition id.
within(int, int, int) - Method in class com.botwithus.bot.api.entities.EntityQuery: Filter to entities within radius tiles (Chebyshev) of the given world tile.
withinDistance(int) - Method in class com.botwithus.bot.api.entities.EntityQuery: Filter to entities within radius tiles of the local player.
withItemId(int) - Method in class com.botwithus.bot.api.component.ComponentQuery: Filter by displayed item id (ModelComponent).
withItemId(int) - Method in class com.botwithus.bot.api.entities.GroundItems.Query: Convenience alias for withId.
withItemId(int) - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
withResourceNamed(String) - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
withResources() - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
withSkill(int) - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
withSkill(int, int, int) - Method in class com.botwithus.bot.api.entities.WorldMapElements.Query
withSpriteId(int) - Method in class com.botwithus.bot.api.component.ComponentQuery: Filter by primary sprite id.
withText(String) - Method in class com.botwithus.bot.api.component.ComponentQuery: Filter by exact label text (case-insensitive).
withType(ComponentType) - Method in class com.botwithus.bot.api.component.ComponentQuery: Filter to a single semantic category.
WOODCUTTING - Enum constant in enum class com.botwithus.bot.api.ScriptCategory
WOODCUTTING - Static variable in class com.botwithus.bot.api.constants.AnimationIds: Woodcutting chop animation.
WOODCUTTING - Static variable in class com.botwithus.bot.api.util.Skills
WOODCUTTING_LEGACY - Static variable in class com.botwithus.bot.api.constants.AnimationIds: The value this constant held before it was measured.
world() - Method in class com.botwithus.bot.api.draw.DrawBuilder: Game-world coordinates, projected to the screen by the producer.
world() - Method in class com.botwithus.bot.api.draw.DrawCaptionBuilder: Game-world coordinates, projected by the producer.
WORLD - Enum constant in enum class com.botwithus.bot.api.draw.DrawSpace: Game-world coordinates in fixed point (tile * 256 + subtile — see DrawLimits.SUBTILE_SCALE), bounded by DrawLimits.MAX_WORLD_COORDINATE rather than by the screen bound.
WORLD_MAP - Static variable in class com.botwithus.bot.api.util.Interfaces
WorldMapElement - Record Class in com.botwithus.bot.api.model: A world-map element from the game cache.
WorldMapElement(int, int, int, int, int, int, int, String, String, String, int, int, int, int, List, List, List) - Constructor for record class com.botwithus.bot.api.model.WorldMapElement: Creates an instance of a WorldMapElement record class.
WorldMapElements - Class in com.botwithus.bot.api.entities: World-map element query facade.
WorldMapElements(GameAPI) - Constructor for class com.botwithus.bot.api.entities.WorldMapElements
WorldMapElements.Query - Class in com.botwithus.bot.api.entities: Fluent filter builder for world-map element queries.
WorldMapPlacement - Record Class in com.botwithus.bot.api.model: A single placement of a WorldMapElement on the world map.
WorldMapPlacement(int, int, int, boolean) - Constructor for record class com.botwithus.bot.api.model.WorldMapPlacement: Creates an instance of a WorldMapPlacement record class.
WorldPathConfig - Record Class in com.botwithus.bot.api.model: Configuration for world-scale pathfinding.
WorldPathConfig(int, int, boolean, boolean, boolean, boolean, boolean, boolean, float, float, float, float, float, float, float) - Constructor for record class com.botwithus.bot.api.model.WorldPathConfig: Creates an instance of a WorldPathConfig record class.
WorldPathConfig.Builder - Class in com.botwithus.bot.api.model

X

x() - Method in class com.botwithus.bot.api.component.ComponentNode
x() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Ellipse: Returns the value of the x record component.
x() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Rect: Returns the value of the x record component.
x() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Text: Returns the value of the x record component.
x() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the x record component.
x1() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Line: Returns the value of the x1 record component.
x2() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Line: Returns the value of the x2 record component.
xPosMode() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the xPosMode record component.
xSizeMode() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the xSizeMode record component.

Y

y() - Method in class com.botwithus.bot.api.component.ComponentNode
y() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Ellipse: Returns the value of the y record component.
y() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Rect: Returns the value of the y record component.
y() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Text: Returns the value of the y record component.
y() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the y record component.
y1() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Line: Returns the value of the y1 record component.
y2() - Method in record class com.botwithus.bot.api.draw.DrawCommand.Line: Returns the value of the y2 record component.
YELLOW - Static variable in class com.botwithus.bot.api.draw.Colors
yPosMode() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the yPosMode record component.
ySizeMode() - Method in record class com.botwithus.bot.api.model.Component: Returns the value of the ySizeMode record component.

Z

z() - Method in record class com.botwithus.bot.api.draw.DrawEntry: Returns the value of the z record component.
z() - Method in record class com.botwithus.bot.api.draw.DrawStyle: Returns the value of the z record component.
z(int) - Method in class com.botwithus.bot.api.draw.DrawBuilder: Draw order; higher is drawn in front.
z(int) - Method in class com.botwithus.bot.api.draw.DrawCaptionBuilder: Draw order; higher is drawn in front.
z(int) - Method in class com.botwithus.bot.api.draw.HighlightBuilder: Draw order; higher is drawn in front.

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form