Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- abandonArmed - Variable in class privbot.mechanics.SpecialAttackPolicy.State
- absent() - Static method in class privbot.api.Observed
-
A successful read that observed nothing.
- absent(String) - Static method in class privbot.api.Observed
-
A successful read that observed nothing, with a note saying what was looked for.
- ABSENT - Enum constant in enum privbot.api.Observed.State
-
The read succeeded and observed that there is nothing.
- ABSENT - Static variable in class privbot.hooks.bank.BankWidgetOps
-
The actions were read and none is the wanted option.
- absentSamples - Variable in class privbot.mechanics.OpponentLock
- accent - Variable in class privbot.ui.overlay.OverlayPalette
-
The resolved colours, all opaque: card
backgroundandborder,title, rowlabelandvalue,accent(LEVEL bars), and the status coloursinfo,good,warn,muted. - accent() - Method in enum privbot.ui.PanelStatus
-
The badge colour, from
ModernTheme. - ACCENT - Enum constant in enum privbot.ui.overlay.PaletteSettings.Slot
- ACCENT - Static variable in class privbot.ui.GearTheme
-
Primary accent (emerald).
- ACCENT_BORDER - Static variable in class privbot.ui.GearTheme
-
Translucent accent for outlines.
- ACCENT_CYAN - Static variable in class privbot.ui.ModernTheme
-
Highlight accent (cyan).
- ACCENT_DANGER - Static variable in class privbot.ui.ModernTheme
-
Danger, errors and Stop (red).
- ACCENT_DANGER_MUTED - Static variable in class privbot.ui.ModernTheme
-
Dark red for danger fills.
- ACCENT_HOVER - Static variable in class privbot.ui.GearTheme
-
Primary accent under the mouse.
- ACCENT_INFO - Static variable in class privbot.ui.ModernTheme
-
Informational accent (blue).
- ACCENT_MUTED - Static variable in class privbot.ui.GearTheme
-
Translucent accent fill for selected rows and chips.
- ACCENT_ORANGE - Static variable in class privbot.ui.GearTheme
-
Secondary orange accent.
- ACCENT_ORANGE - Static variable in class privbot.ui.ModernTheme
-
Condition accent (orange).
- ACCENT_PRIMARY - Static variable in class privbot.ui.ModernTheme
-
Primary action accent (indigo).
- ACCENT_PRIMARY_HOVER - Static variable in class privbot.ui.ModernTheme
-
Primary accent under the mouse.
- ACCENT_PURPLE - Static variable in class privbot.ui.GearTheme
-
Secondary purple accent.
- ACCENT_PURPLE - Static variable in class privbot.ui.ModernTheme
-
Special accent (purple).
- ACCENT_SUCCESS - Static variable in class privbot.ui.ModernTheme
-
Success, enabled and running (green).
- ACCENT_SUCCESS_MUTED - Static variable in class privbot.ui.ModernTheme
-
Dark green for success fills.
- ACCENT_WARNING - Static variable in class privbot.ui.ModernTheme
-
Warnings and paused states (amber).
- accept() - Method in class privbot.hooks.Trade
-
Accepts the trade screen that is open (the confirmation screen first).
- accept(Events.Frame) - Method in class privbot.hooks.Events
-
Dispatches one already-read frame (tests, and sources driven by something other than
Events.onGameTick()). - accepted() - Method in class privbot.actions.confirm.ActionHandle
-
Dispatch receipt only; true does not mean the effect was observed.
- accepted() - Method in class privbot.actions.confirm.ActionSnapshot
- accepted() - Method in class privbot.movement.pathing.ExactStepHandle
- ACCEPTED - Enum constant in enum privbot.actions.confirm.DispatchStatus
-
The dispatch API explicitly accepted the action.
- acceptFirst() - Method in class privbot.hooks.Trade
-
Accepts the first trade screen, the way the client's own Accept click is sent.
- acceptRequest(String) - Method in class privbot.hooks.Trade
-
Accept an INCOMING trade request from
playerName— the chat link, not the trade screen. - acceptSecond() - Method in class privbot.hooks.Trade
-
Accepts the second trade screen, the way the client's own Accept click is sent.
- acted(String, String) - Static method in class privbot.mechanics.SustainOutcome
-
An item was consumed (proved by its count dropping); no combo was involved or it did not land.
- acted(String, String, boolean) - Static method in class privbot.mechanics.SustainOutcome
-
An item was consumed (proved by its count dropping).
- ACTED - Enum constant in enum privbot.mechanics.SustainOutcome.Kind
- action() - Method in class privbot.mechanics.SustainChoice
- action() - Method in class privbot.movement.pathing.ExactStepHandle
- action(String, Color, Runnable) - Method in class privbot.ui.PrivBotPanel.Builder
-
An extra action button below Settings.
- Action(PvpArbiter.Kind, String, CombatStyle, String, Boolean, boolean) - Constructor for class privbot.mechanics.PvpArbiter.Action
- ActionHandle - Class in privbot.actions.confirm
-
A caller-driven proof.
- actions - Variable in class privbot.context.PrivContext
-
Factories for worker-polled action-confirmation trackers; each plugin owns its own.
- actions - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.actions. - actions() - Method in class privbot.hooks.container.ItemContainerSnapshot.Item
- actions() - Method in class privbot.mechanics.ConsumePlanner.Plan
- actions() - Method in class privbot.mechanics.EmergencyConsume.Decision
- actions() - Method in class privbot.mechanics.InstantMaulPlan.Plan
- actions() - Method in class privbot.mechanics.KnockoutWeaponPlan.Plan
- actions() - Method in class privbot.mechanics.PvpActionPlanner.Plan
- actions() - Method in class privbot.mechanics.PvpFinisherCoordinator.Plan
- actions() - Method in class privbot.mechanics.PvpKoCoordinator.Plan
- actions() - Method in class privbot.mechanics.PvpMaulCoordinator.Plan
- Actions - Class in privbot.hooks
-
Factories for worker-polled action proof; each plugin owns and invalidates its own tracker.
- Actions() - Constructor for class privbot.hooks.Actions
- ActionSnapshot - Class in privbot.actions.confirm
-
Immutable confirmation observation; safe to publish to an overlay or event consumer.
- ActionStatus - Enum in privbot.actions.confirm
- ActionTracker - Class in privbot.actions.confirm
-
Tracks already-dispatched actions without a polling thread.
- ActionTracker() - Constructor for class privbot.actions.confirm.ActionTracker
- ActionTracker(LongSupplier, int) - Constructor for class privbot.actions.confirm.ActionTracker
- activate(String) - Method in class privbot.hooks.Prayer
-
Activates the prayer with this in-game name ("Protect from Melee") if it is not already active.
- activateSpecialAttack() - Method in class privbot.hooks.Combat
-
Arms the special attack orb unless it already reads armed.
- activateSpecialAttackWithImpactFallback(int) - Method in class privbot.hooks.Combat
-
Arms the current Impact special orb, using the supplied weapon widget only if the live holder has not populated its active-row field yet.
- active() - Method in class privbot.restock.RestockCycle
- active() - Method in enum privbot.restock.RestockCycle.Stage
-
A trip is under way.
- ACTIVE - Enum constant in enum privbot.effects.EffectObservation.State
- activeLine(ToIntFunction<String>) - Method in class privbot.hooks.bank.WithdrawPlan
- activeLine(ToIntFunction<String>) - Method in class privbot.hooks.shop.BuyPlan
- activePrayers() - Method in class privbot.mechanics.ThreatSnapshot
- actor - Variable in class privbot.hooks.Events.AnimationEvent
-
The actor; valid only during dispatch.
- actor - Variable in class privbot.hooks.Events.HitsplatEvent
-
The actor hit; valid only during dispatch (may be null for a forwarded event without one).
- actorName - Variable in class privbot.hooks.Events.HitsplatEvent
-
The actor's name when it could be read, else null.
- add(WorldPoint, int) - Method in class privbot.mechanics.HazardMap
- add(WorldPoint, int, int) - Method in class privbot.mechanics.HazardMap
-
Marks
tiledangerous untilnowTick + ttlTicks(exclusive). - addActionButton(String, Color, ActionListener) - Method in class privbot.ui.PrivBotPanel
-
Adds an action button to the button row.
- addChild(Child<C>) - Method in class privbot.task.Parent
-
Adds a child to this group, normally from the subclass constructor.
- addConfigSections(Config, ConfigManager) - Method in class privbot.ui.fx.FxStudioShell.Builder
-
One generated page per
@ConfigSection, or a single Settings page. - addContent(Component) - Method in class privbot.ui.CollapsibleSection
-
Adds a component to the content area.
- addFormRow(GridPane, int, String, Node) - Static method in class privbot.ui.fx.FxFormKit
-
Adds a right-aligned label in column 0 and
fieldin column 1 ofrow. - addFormRow(JPanel, int, String, JComponent) - Static method in class privbot.ui.ModernTheme
-
Adds a label + component row to a GridBagLayout form panel.
- addFormRow(JPanel, int, String, JComponent) - Static method in class privbot.ui.SwingFormKit
-
ModernTheme.addFormRow(javax.swing.JPanel, int, java.lang.String, javax.swing.JComponent): adds a label + input row and returns the next row index. - addFxSection(String, String, String, String, Supplier<Node>, boolean) - Method in class privbot.ui.fx.FxStudioShell.Builder
-
A JavaFX page (e.g.
- addGameMessage(String) - Method in class privbot.hooks.Chat
-
Adds a local game message to the chatbox (only this client sees it; nothing is sent).
- addNode(AutomationStage, TaskNode<C>) - Method in class privbot.task.StagedTaskRunner
-
Registers a node for a stage.
- addNode(TaskNode<C>) - Method in class privbot.task.CompositeTaskNode
-
Adds a child task node.
- addNode(TaskNode<C>) - Method in class privbot.task.TaskNodeRunner
-
Registers a node.
- addNodes(TaskNode<C>...) - Method in class privbot.task.TaskNodeRunner
-
Registers tasks.
- addPersistent(WorldPoint) - Method in class privbot.mechanics.HazardMap
- addStatusListener(Consumer<String>) - Method in class privbot.task.SimpleNode
-
Registers a listener that is notified whenever
SimpleNode.status(String, Object...)is called. - addSwingSection(String, String, String, String, JComponent, boolean) - Method in class privbot.ui.fx.FxStudioShell.Builder
-
A legacy Swing page; the shell draws its heading and frames the panel.
- addTicks(int, double, int, int) - Method in class privbot.behavior.Human
-
With probability
chance, adds a random tick offset in[minAdd, maxAdd]toatTick. - advance(long) - Method in class privbot.restock.RestockCycle
-
The current stage's step was confirmed: the next stage.
- after(int, int, String) - Method in class privbot.mechanics.Commitment
-
Folds one plan's commit set, decided on
tickagainstopponentId(-1: no opponent in the state, which keeps the one we have). - after(int, int, String, int) - Method in class privbot.mechanics.Commitment
-
As above, with
specFiredTick: the tick the last spec fired as the decision on this state saw it, orCommitment.NEVER(the engine passesNEVERwhile the orb is still latched, so an armed read lagging the fire is that spec, not a second one). - afterAttack() - Method in class privbot.mechanics.PvpArbiter.Action
- afterDeath(RecoveryPlan) - Method in class privbot.hooks.Recovery
-
Starts the job that gets the player back to work after dying.
- afterTicks(int, int) - Method in class privbot.behavior.Human
-
Inclusive random tick count in
[minTicks, maxTicks]— add togetTickCount()for a “ready after” gate. - against - Variable in class privbot.mechanics.Commitment
-
The opponent this commitment belongs to; -1 before the first.
- alive() - Method in class privbot.query.NPCQuery
-
Excludes dead NPCs using
PrivNPC.isAlive(). - ALIVE - Enum constant in enum privbot.mechanics.DeathWatch.State
-
Hitpoints are above 0 and no death is being tracked.
- all - Variable in class privbot.hooks.bank.WithdrawPlan.Line
-
True for a "withdraw everything of this" line.
- all() - Method in class privbot.hooks.Production.Make
-
Make all (default).
- all() - Static method in class privbot.mechanics.PvpQuery
- all() - Static method in class privbot.mechanics.ThreatQuery
- all(String) - Static method in class privbot.hooks.bank.WithdrawOption
-
The unbounded
Withdraw-Alloption. - ALL - Static variable in class privbot.hooks.bank.WithdrawOption
-
Sentinel amount for the unbounded
Withdraw-Alloption. - ALL - Static variable in class privbot.hooks.bank.WithdrawPlan
-
A quantity at or above this means "all of it", matching the GUI's 0-or-blank convention.
- allOf(List<WithdrawOption>) - Static method in class privbot.hooks.bank.WithdrawOption
-
The
Withdraw-Allentry, or null when this server has none PrivBot can send. - allowed() - Method in enum privbot.api.ApiVersion.Status
- allowed() - Method in class privbot.api.ApiVersion.Verdict
- allowItemTeleports - Variable in class privbot.movement.pathing.NavigationOptions
- allowTeleports - Variable in class privbot.movement.pathing.NavigationOptions
- allowTransports - Variable in class privbot.movement.pathing.NavigationOptions
- allowWebRoute - Variable in class privbot.movement.pathing.NavigationOptions
-
Allow the movement-web node graph to plan the route when it covers both endpoints.
- allowWorkflowFallback() - Method in class privbot.hooks.TransportRequest
- allowWorldObjectTransports - Variable in class privbot.movement.pathing.NavigationOptions
-
Learned world OBJECT crossings, independent of legacy generic transport workflows.
- allowWorldRoute - Variable in class privbot.movement.pathing.NavigationOptions
-
Allow the world routing layer (learned atlas + doors + transports) to plan this trip.
- allSent() - Method in class privbot.mechanics.SwitchResult
- alpha(Color, int) - Static method in class privbot.ui.overlay.OverlayTheme
-
The same hue with a different alpha.
- ALREADY_SATISFIED - Enum constant in enum privbot.hooks.bank.WithdrawCapacity.Outcome
-
Already holding at least
target; nothing to do. - alsoIds(int...) - Method in class privbot.mechanics.TargetSpec
-
Also matches these NPC ids, whatever their name (adds ids to a spec built with
TargetSpec.named(java.lang.String...)). - ALWAYS_KEPT - Enum constant in enum privbot.mechanics.RiskValuation.Disposition
- ALWAYS_LOST - Enum constant in enum privbot.mechanics.RiskValuation.Disposition
- AMMUNITION - Enum constant in enum privbot.mechanics.GearSetup.Role
- amount - Variable in class privbot.hooks.Events.HitsplatEvent
-
The displayed damage.
- amount - Variable in class privbot.mechanics.ThreatMemory.Hit
- amount() - Method in class privbot.hooks.bank.WithdrawCapacity
-
Units withdrawable now; 0 unless
WithdrawCapacity.outcome()isWithdrawCapacity.Outcome.WITHDRAW. - amount() - Method in class privbot.hooks.bank.WithdrawOption
-
Units withdrawn per click, or
WithdrawOption.ALLfor the unbounded option. - amount() - Method in class privbot.hooks.shop.ShopOption
-
How many units this option buys per click.
- anchor - Variable in class privbot.hooks.Places.Place
-
The tile the place is anchored on.
- anchorSceneX() - Method in class privbot.hooks.GameObjects.ToaRewardsRoomChest.Config
- anchorSceneY() - Method in class privbot.hooks.GameObjects.ToaRewardsRoomChest.Config
- animation() - Method in class privbot.hooks.LocalPlayer
-
The player's current animation id in this server's numbering;
-1is a real answer (no animation). - animation() - Method in class privbot.mechanics.NpcView
- animation() - Method in class privbot.mechanics.PlayerView
- animation(int) - Method in interface privbot.api.Ids
-
This server's actor animation (sequence) id for OSRS animation
osrsId. - animation(int) - Method in class privbot.mechanics.AttackCues
- animation(int, CombatStyle) - Method in class privbot.mechanics.AttackCues.Builder
- AnimationEvent(Actor, boolean, int, int, int, int, int) - Constructor for class privbot.hooks.Events.AnimationEvent
- animations(Set<Integer>, CombatStyle) - Method in class privbot.mechanics.AttackCues.Builder
- any() - Static method in class privbot.mechanics.TargetSpec
-
A spec matching every NPC; narrow it with
TargetSpec.ignore(java.lang.String...)orTargetSpec.within(net.runelite.api.coords.WorldArea). - apiVersion() - Static method in class privbot.sdk.PrivBotAPI
-
The plugin API version this PrivBot provides, for example
"1.0.0". - ApiVersion - Class in privbot.api
-
The PrivBot plugin API version, and the rule that decides whether a plugin built against one version may run on another.
- ApiVersion.Status - Enum in privbot.api
- ApiVersion.Verdict - Class in privbot.api
-
A load decision with a message fit to show the user.
- apply(ConfigMigration.ConfigAccess) - Method in interface privbot.config.ConfigMigration.Step
- applyFastVerticalScroll(ScrollPane, double) - Static method in class privbot.ui.fx.FxFormKit
-
Makes the outer page
ScrollPanerespond faster to mouse wheel / trackpad (studio-wide). - applyQualityRendering(Graphics2D) - Static method in class privbot.ui.overlay.PrivBotChatboxOverlayComponents
-
Turns on antialiasing, LCD text antialiasing and quality rendering for
g. - applyTo(Scene) - Static method in class privbot.ui.fx.PrivBotFxStyles
-
Adds
PrivBotFxStyles.STYLESHEET_RESOURCEto the scene if it is present on the classpath. - applyToggleStyle(ToggleButton) - Static method in class privbot.ui.fx.FxFormKit
-
Sets the on/off style class from the toggle's selected state; call it after each change.
- approachTile(WorldPoint, int, SceneReachability) - Method in interface privbot.hooks.CombatCollision
-
A standable cardinal tile from which a melee attack reaches the target, preferring tiles the reachability read can walk to.
- area(WorldArea, Color) - Method in class privbot.ui.overlay.SceneCanvas
-
Every tile of
area(its plane is ignored; the current plane projects). - ARM - Enum constant in enum privbot.mechanics.PvpArbiter.Kind
- ARM - Enum constant in enum privbot.mechanics.SpecialAttackPolicy.Phase
- ARM_IN_FLIGHT - Enum constant in enum privbot.mechanics.SpecialAttackPolicy.Phase
- armed - Variable in class privbot.mechanics.SpecialAttackPolicy.State
- ARMED - Enum constant in enum privbot.mechanics.SpecialAttackPolicy.Phase
- armInFlight - Variable in class privbot.mechanics.SpecialAttackPolicy.State
- armRequiresAttackAcceptance() - Method in class privbot.mechanics.InstantMaulPlan.Plan
-
If true, skip the orb unless the same-tick attack resend against
InstantMaulPlan.Plan.opponent()was accepted. - armRequiresAttackAcceptance() - Method in class privbot.mechanics.PvpFinisherCoordinator.Plan
- armRequiresAttackAcceptance() - Method in class privbot.mechanics.PvpMaulCoordinator.Plan
-
Skip the orb if the same-tick attack resend was rejected.
- armRequiresEquipAcceptance() - Method in class privbot.mechanics.InstantMaulPlan.Plan
-
When true, dispatch the orb only after this plan's equip dispatch was accepted on the same tick.
- armRequiresEquipAcceptance() - Method in class privbot.mechanics.PvpFinisherCoordinator.Plan
- armRequiresEquipAcceptance() - Method in class privbot.mechanics.PvpMaulCoordinator.Plan
-
Skip the orb if the same-tick equip dispatch was rejected.
- ARRIVED - Enum constant in enum privbot.movement.pathing.NavigationSession.Result
- arriveRadius - Variable in class privbot.movement.pathing.NavigationOptions
- assess(int, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer) - Static method in class privbot.mechanics.KnockoutRisk
-
An eat is due when readable HP is at or below the estimated danger line and now is at or past the last send tick that could process the eat one tick before the predicted hit.
- assessCandidates(int, Integer, Integer, List<KnockoutRisk.Candidate>, Integer, Integer, Integer, Integer, Integer) - Static method in class privbot.mechanics.KnockoutRisk
-
Assess all supplied possible next attacks and take their highest danger line.
- at(String, WorldPoint, int) - Static method in class privbot.mechanics.Destination
- atDestination() - Method in interface privbot.restock.RestockHost
-
The player is back where the activity happens (the return teleport landed).
- atHome(int, int) - Method in class privbot.restock.RestockRoute
-
Within the home landing; the plane is not compared (the landing's plane differs by how the scene is loaded).
- atMs() - Method in class privbot.mechanics.PrayerToggleGuard.Toggle
- attach(Client, MouseManager, OverlayMoveMode, Supplier<Dimension>) - Static method in class privbot.ui.overlay.OverlayMoveInput
-
Starts listening, or returns null when there is no mouse source to listen to.
- attach(ClientToolbar, String, Supplier<PrivBotPanel>, Class<?>, String) - Static method in class privbot.ui.PluginUi
-
Build the panel on the EDT and add its navigation button.
- attach(ClientToolbar, String, PrivBotPanel, Class<?>, String) - Static method in class privbot.ui.PluginUi
-
PluginUi.attach(ClientToolbar, String, Supplier, Class, String)for an already-built panel. - attack - Variable in class privbot.mechanics.ConsumePlanner.State
- attack() - Method in class privbot.mechanics.CombatLevels
- attack() - Method in class privbot.wrappers.PrivNPC
-
Attacks this NPC using its live
Attackmenu option. - attack(String) - Method in class privbot.hooks.Combat
-
Attacks the loaded player whose name equals
playerName(ignore case). - attack(String...) - Method in class privbot.hooks.NPCs
-
Attacks the closest NPC matching any supplied name.
- attack(PlayerView, CombatStyle) - Static method in class privbot.mechanics.PvpArbiter.Action
-
Construct an attack proposal against a detached player; resolve the target again at dispatch.
- ATTACK - Enum constant in enum privbot.mechanics.PvpArbiter.Kind
- attackClosest(String...) - Method in class privbot.hooks.NPCs
-
Attacks the closest NPC matching any supplied name.
- AttackCues - Class in privbot.mechanics
-
Maps the cues an NPC shows when it attacks (its animation id, its projectile id) to the
CombatStylethe attack demands, plus the animation ids that are known to be harmless and how many cycles pass between an animation and its projectile launching. - AttackCues.Builder - Class in privbot.mechanics
-
Collects cues.
- AttackExpiryTracker - Class in privbot.mechanics
-
Single-owner count of consecutive accepted attacks whose pending windows expired without an observed fire.
- AttackExpiryTracker() - Constructor for class privbot.mechanics.AttackExpiryTracker
- AttackFireDetector - Class in privbot.mechanics
-
Detects attack fires from caller-supplied, server-ID-space cues and separately confirmed spec-energy fires.
- AttackFireDetector(Map<Integer, CombatStyle>, Set<Integer>, Set<Integer>) - Constructor for class privbot.mechanics.AttackFireDetector
-
The inputs must already use the server's IDs; missing mappings must not be guessed.
- AttackFireDetector.Result - Class in privbot.mechanics
- AttackFireDetector.Status - Enum in privbot.mechanics
- AttackHistory - Class in privbot.mechanics
-
Single-owner record of accepted attack sends and independently confirmed fires, eats and clearing exits.
- AttackHistory() - Constructor for class privbot.mechanics.AttackHistory
- AttackHistory.Family - Enum in privbot.mechanics
- attackPlayer(String) - Method in class privbot.hooks.Combat
- attackPlayer(Player) - Method in class privbot.hooks.Combat
- attackReal - Variable in class privbot.mechanics.ConsumePlanner.State
- attackReal() - Method in class privbot.mechanics.CombatLevels
- attackRequiresEquipAcceptance() - Method in class privbot.mechanics.InstantMaulPlan.Plan
-
If true, skip the attack resend unless the same-tick equip dispatch was accepted.
- attackRequiresEquipAcceptance() - Method in class privbot.mechanics.PvpFinisherCoordinator.Plan
- attackRequiresEquipAcceptance() - Method in class privbot.mechanics.PvpMaulCoordinator.Plan
-
Skip the attack resend if the same-tick equip dispatch was rejected.
- AttackTiming - Class in privbot.mechanics
-
Pure attack timing calculations, adapted from ElorinPvP's AttackClock.
- AttackTiming.Window - Class in privbot.mechanics
-
A step-out interval, inclusive at both ends.
- attempt(String, Supplier<Observed<T>>) - Static method in class privbot.api.Observed
-
Runs a read and turns any exception it throws into UNREADABLE.
- attempted(long) - Method in class privbot.mechanics.BoostDosePolicy
-
A dose was tried but not confirmed consumed: throttle the next try.
- ATTEMPTED - Enum constant in enum privbot.actions.confirm.DispatchStatus
-
A void/uncertain dispatch was attempted; acceptance is not known.
- atTile(WorldPoint) - Method in class privbot.query.ObjectQuery
-
Keeps objects whose world location equals
tile(same x, y, plane). - attributedOpponentHit - Variable in class privbot.mechanics.PvpFightHistory.Inputs
- AUTO - Enum constant in enum privbot.context.GameThreadPolicy
-
Derive the route from what is known about the client's threads.
- AUTO_SAVE_IDLE_MS - Static variable in class privbot.ui.overlay.OverlayMoveMode
-
A move is saved this long after the last drag ended.
- autoAttacking(Boolean) - Method in class privbot.mechanics.OwnAttackClock
-
Whether a confirmed melee or ranged fire is repeating while the player still faces the locked opponent.
- autocast(String) - Method in class privbot.hooks.Magic
-
Selects the named spell for autocast.
- autocastSpellWidgetId() - Method in class privbot.hooks.Magic
-
Current autocast selection, or null if the profile cannot observe it.
- autocastWidget(int, String) - Method in class privbot.hooks.Magic
-
Turns autocast back on with the spell whose spellbook widget is
widgetId(one the caller saw the server accept), for a spell PrivBot does not know by name. - AutomationStage - Enum in privbot.task
-
Ordered automation stages for
StagedTaskRunner. - available - Variable in class privbot.hooks.container.ItemContainerSnapshot
-
False means unavailable, not an observed empty container.
- available - Variable in class privbot.movement.pathing.SceneReachability
- awaiting(String, int) - Method in class privbot.mechanics.OffensivePrayerUpkeep
-
Whether a click on
prayeris still waiting for its read.
B
- back() - Method in class privbot.mechanics.RecoveryPlan
- back(Destination) - Method in class privbot.mechanics.RecoveryPlan.Builder
- BACK_TO_MAIN - Enum constant in enum privbot.mechanics.KnockoutWeaponDecision.Kind
- background - Variable in class privbot.ui.overlay.OverlayPalette
-
The resolved colours, all opaque: card
backgroundandborder,title, rowlabelandvalue,accent(LEVEL bars), and the status coloursinfo,good,warn,muted. - background() - Method in class privbot.ui.overlay.PrivBotOverlayPanel
-
The background this panel paints with (re-applied on every frame).
- BACKGROUND - Enum constant in enum privbot.ui.overlay.PaletteSettings.Slot
- backingOff(int) - Method in class privbot.mechanics.SwitchCheck
- BACKOFF_AFTER - Static variable in class privbot.mechanics.SwitchCheck
-
Failures in a row that start a back-off.
- BACKOFF_TICKS - Static variable in class privbot.mechanics.SwitchCheck
-
Ticks a back-off lasts.
- backoffMs - Variable in class privbot.movement.pathing.NavigationSession.Policy
- BAD - Static variable in class privbot.ui.overlay.OverlayTheme
-
Danger or failure (red).
- badgeText(String) - Method in enum privbot.ui.PanelStatus
-
"● RUNNING", or"● <text>"when the caller supplies its own word. - BAIT - Enum constant in enum privbot.mechanics.PvpArbiter.Kind
- band(int, int, int, int, int, int, int, int, WildernessModel.Rounding) - Static method in class privbot.mechanics.WildernessModel.Zone
-
A verified rectangular band: level = rounded((y - baseY) / bandWidth) + offset.
- bank - Variable in class privbot.context.PrivContext
-
Bank interface: open, withdraw, deposit and bank contents (
ctx.bank). - bank - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.bank. - bank() - Method in class privbot.hooks.Places
-
Nearest configured bank to the player (falls back to the first configured bank when offline).
- Bank - Class in privbot.hooks
-
Bank queries and interactions through the game client.
- BANK - Enum constant in enum privbot.query.ItemContainerKind
-
Bank contents;
PrivItem.exists()is false while the bank reads closed. - BANK - Enum constant in enum privbot.restock.RestockCycle.Stage
- BANK_CLOSE - Enum constant in enum privbot.api.Capability
- BANK_DEPOSIT - Enum constant in enum privbot.api.Capability
- BANK_OPEN - Enum constant in enum privbot.api.Capability
- BANK_READ - Enum constant in enum privbot.api.Capability
- BANK_WITHDRAW - Enum constant in enum privbot.api.Capability
- bankerAction() - Static method in class privbot.hooks.Bank
-
Last-resort banker interaction when no bank object is found (server-specific; uses injected adapter).
- bankerNpc - Variable in class privbot.restock.RestockRoute
- bankNames() - Method in class privbot.hooks.Places
-
Names of this server's banks that
Places.resolve(java.lang.String)can reach (they have a dest tile), in config order. - bankObjects - Variable in class privbot.restock.RestockRoute
- bankSearchTiles - Variable in class privbot.restock.RestockRoute
- BankSeen - Class in privbot.hooks
-
The bank contents the player last saw, so AI Builder can answer "what is in my bank" without the bank being open.
- BankSession - Class in privbot.hooks.bank
-
Bank chrome buttons: deposit-inventory, deposit-worn, close.
- BankSlot - Class in privbot.hooks.bank
-
One occupied slot in the bank's item container.
- BankSlot(int, int, int, String, int) - Constructor for class privbot.hooks.bank.BankSlot
- BankWidgetOps - Class in privbot.hooks.bank
-
The menu identifier of a bank item option on a RuneLite-shaped (EventBus) client, read from the slot widget's own action list instead of assumed.
- barrageGraphics() - Static method in class privbot.mechanics.ElorinPvpCues
-
Historically observed barrage-family graphics.
- base(String) - Static method in class privbot.mechanics.GearNames
-
The name with any charge count or degrade tier taken off — the item's identity, used as the key for anything learned about it (a glory's slot is learned once for every charge).
- begin(int, int, ItemContainerSnapshot) - Static method in class privbot.mechanics.FoodProof
-
A readable pre-send inventory containing this item is required; null means no baseline can be established.
- begin(int, String, ItemContainerSnapshot) - Static method in class privbot.mechanics.DrinkProof
-
Returns null unless the selected potion and its complete readable dose baseline can be established.
- begin(String, long) - Method in class privbot.restock.RestockCycle
-
Begins a trip from IDLE.
- bestFor(List<WithdrawOption>, int) - Static method in class privbot.hooks.bank.WithdrawOption
-
Picks the largest fixed option that does not exceed
remaining. - bestFor(List<ShopOption>, int) - Static method in class privbot.hooks.shop.ShopOption
-
Picks the largest option that does not exceed
remaining. - bestProseGroup() - Method in class privbot.hooks.Dialogue
-
The on-screen text group that most reads like a dialogue message, or null.
- BG_CANVAS - Static variable in class privbot.ui.GearTheme
-
Main content background.
- BG_CANVAS - Static variable in class privbot.ui.ModernTheme
-
Darkest background: the main canvas.
- BG_CARD - Static variable in class privbot.ui.GearTheme
-
Card surface.
- BG_CARD - Static variable in class privbot.ui.ModernTheme
-
Card and elevated surface.
- BG_CARD_HOVER - Static variable in class privbot.ui.GearTheme
-
Card surface under the mouse.
- BG_CARD_HOVER - Static variable in class privbot.ui.ModernTheme
-
Card surface under the mouse.
- BG_ELEVATED - Static variable in class privbot.ui.GearTheme
-
Raised surfaces such as popups and menus.
- BG_ELEVATED - Static variable in class privbot.ui.ModernTheme
-
Raised surfaces: dropdowns, popups, tooltips.
- BG_HEADER - Static variable in class privbot.ui.ModernTheme
-
Header and status bars.
- BG_INPUT - Static variable in class privbot.ui.GearTheme
-
Input field background.
- BG_INPUT - Static variable in class privbot.ui.ModernTheme
-
Input field background.
- BG_ROOT - Static variable in class privbot.ui.GearTheme
-
Deepest background: the window root.
- BG_SIDEBAR - Static variable in class privbot.ui.GearTheme
-
Sidebar background.
- BG_SIDEBAR - Static variable in class privbot.ui.ModernTheme
-
Sidebar and panel background.
- BG_TOOLBAR - Static variable in class privbot.ui.ModernTheme
-
Toolbar background.
- bind(String, Keybind) - Method in class privbot.hooks.Hotkeys
- Blackboard - Class in privbot.hooks
-
Run/script-scoped key-value scratchpad ("memory") for workflow flows and plugins.
- Blackboard() - Constructor for class privbot.hooks.Blackboard
- blocked(int) - Method in class privbot.mechanics.OverheadWatch
-
The one style their overhead has blocked for at least the debounce window.
- blockedFor(CombatStyle) - Method in class privbot.mechanics.OverheadWatch
-
How many readable ticks in a row their overhead has blocked
style, regardless of the debounce; 0 when the current overhead does not block it or nothing readable has been seen. - blockedSet(int) - Method in class privbot.mechanics.OverheadWatch
-
Every style their overhead has blocked for at least the debounce window; empty when none, when nothing readable has been seen, or when
tickis before the newest reading. - blockedSince() - Method in class privbot.mechanics.OverheadWatch
-
The first tick of the current run when its overhead blocks any style (debounced or not), else
OverheadWatch.NEVER. - blocks(String) - Static method in class privbot.mechanics.OverheadWatch
-
The styles an overhead name blocks; empty for null,
"NONE"or a non-protection prayer. - blocksGameInput() - Method in class privbot.ui.overlay.OverlayMoveInput
-
True when a consumed press is kept from the game (both paths now).
- boost(Skill, BoostDosePolicy, String...) - Method in class privbot.mechanics.SustainPlan.Builder
-
Keep a stat boost up.
- BOOST - Enum constant in enum privbot.mechanics.SustainChoice.Kind
- BoostDosePolicy - Class in privbot.mechanics
-
Decides when to drink another dose of a stat boost (overload, super combat, and so on) from the boost the account actually shows.
- BoostDosePolicy(Predicate<String>, int, long, int) - Constructor for class privbot.mechanics.BoostDosePolicy
- boosted(String) - Method in class privbot.hooks.Skills
- boosted(Skill) - Method in class privbot.hooks.Skills
- boosted(Skill) - Method in class privbot.hooks.User
- boostPolicy(Skill) - Method in class privbot.mechanics.SustainPlan
- boostRedoseLevels - Variable in class privbot.mechanics.ConsumePlanner.Settings
- boosts - Variable in class privbot.mechanics.ConsumePlanner.Settings
- boostSkillFor(String) - Method in class privbot.mechanics.SustainPlan
- boostSkills() - Method in class privbot.mechanics.SustainPlan
- border - Variable in class privbot.ui.overlay.OverlayPalette
-
The resolved colours, all opaque: card
backgroundandborder,title, rowlabelandvalue,accent(LEVEL bars), and the status coloursinfo,good,warn,muted. - BORDER - Enum constant in enum privbot.ui.overlay.PaletteSettings.Slot
- BORDER_DEFAULT - Static variable in class privbot.ui.GearTheme
-
Default border.
- BORDER_DEFAULT - Static variable in class privbot.ui.ModernTheme
-
Default border.
- BORDER_FOCUS - Static variable in class privbot.ui.GearTheme
-
Focus ring (the accent).
- BORDER_FOCUS - Static variable in class privbot.ui.ModernTheme
-
Focus ring.
- BORDER_SUBTLE - Static variable in class privbot.ui.GearTheme
-
Subtle separators.
- BORDER_SUBTLE - Static variable in class privbot.ui.ModernTheme
-
Subtle separators.
- bountyTarget() - Method in class privbot.hooks.PlayersHook
-
The current Bounty Hunter target's display name (tags and colour codes removed), or
nullwhen none is assigned or the server offers no readable source. - bountyTargetReadable() - Method in class privbot.hooks.PlayersHook
-
True when this server/profile exposes the Bounty Hunter target at all.
- brand(String, String) - Method in class privbot.ui.fx.FxStudioShell.Builder
-
Masthead:
brandTitlebecomes the mark and name,brandSubtitlethe product line. - BREW - Enum constant in enum privbot.mechanics.SustainChoice.Kind
- brewBelowPct(int) - Method in class privbot.mechanics.SustainPlan.Builder
-
Drink a brew when HP is below this percent of max HP (0 turns it off).
- brews - Variable in class privbot.mechanics.ConsumePlanner.Settings
- brews(String...) - Method in class privbot.mechanics.SustainPlan.Builder
-
Brews in preference order; each must carry the "Drink" action.
- brighten(Color, int) - Static method in class privbot.ui.GearTheme
-
Adds
amountto each RGB channel (capped at 255), keeping alpha. - brighten(Color, int) - Static method in class privbot.ui.ModernTheme
-
Adds
amountto each RGB channel (capped at 255), keeping alpha. - BROKEN - Enum constant in enum privbot.mechanics.FreezeClock.Move
-
Earlier, past the grace: they were not frozen (or it broke), and no immunity follows.
- build() - Method in class privbot.hooks.Events.Frame.Builder
- build() - Method in class privbot.hooks.Restock.Builder
- build() - Method in class privbot.mechanics.AttackCues.Builder
- build() - Method in class privbot.mechanics.LootSpec.Builder
- build() - Method in class privbot.mechanics.RecoveryPlan.Builder
- build() - Method in class privbot.mechanics.RestockTarget.Builder
- build() - Method in class privbot.mechanics.SustainPlan.Builder
- build() - Method in class privbot.ui.fx.FxStudioShell.Builder
-
Creates the shell and assembles its window on the EDT (waiting when called elsewhere).
- build() - Method in class privbot.ui.PrivBotPanel.Builder
-
Creates the panel, polls once, and starts the refresh timer when anything needs polling.
- builder() - Static method in class privbot.hooks.Events.Frame
- builder() - Static method in class privbot.mechanics.AttackCues
- builder() - Static method in class privbot.mechanics.LootSpec
- builder() - Static method in class privbot.mechanics.RecoveryPlan
- builder() - Static method in class privbot.mechanics.RestockTarget
- builder() - Static method in class privbot.mechanics.SustainPlan
- builder() - Static method in class privbot.ui.fx.FxStudioShell
-
A blank builder for bespoke studios: add pages with
FxStudioShell.Builder.addConfigSections(net.runelite.client.config.Config, net.runelite.client.config.ConfigManager),FxStudioShell.Builder.addFxSection(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.function.Supplier<javafx.scene.Node>, boolean)orFxStudioShell.Builder.addSwingSection(java.lang.String, java.lang.String, java.lang.String, java.lang.String, javax.swing.JComponent, boolean). - builder(String) - Static method in class privbot.ui.PrivBotPanel
-
A sidebar described rather than assembled: Start/Stop that polls the plugin's own state, the standard Settings button, and stats read from suppliers by the refresh timer.
- Builder() - Constructor for class privbot.hooks.Events.Frame.Builder
- Builder() - Constructor for class privbot.hooks.Restock.Builder
- Builder() - Constructor for class privbot.ui.fx.FxStudioShell.Builder
- buildPageWithScroll(String, String, Node, Node) - Static method in class privbot.ui.fx.FxFormKit
-
Page chrome: title, subtitle, scrollable body, optional footer below the scroll area.
- buildUI() - Method in class privbot.ui.PrivBotFrame
-
Builds the UI after all sections have been registered.
- busy - Variable in class privbot.mechanics.OpponentLockPolicy.Candidate
- busy() - Method in class privbot.mechanics.NpcView
-
True when the NPC is fighting someone else, so it is not ours to take.
- button() - Method in class privbot.ui.PluginUi
-
The navigation button added to the client toolbar.
- buy(String, int) - Method in class privbot.hooks.Shop
-
Buys
quantityof the named stock item from the open shop, using the buy quantities this server's shop offers (ShopInterfaceon Impact, Elorin and SpawnPK; the shop-stock widget'sBuy 1/5/10/50actions elsewhere). - buy(ShopSlot, int) - Method in class privbot.hooks.shop.ShopInterface
-
Clicks the best available buy option for
remainingunits. - buyOptions() - Method in class privbot.hooks.shop.ShopInterface
-
The purchase quantities PrivBot can send on this server, largest first.
- BuyPlan - Class in privbot.hooks.shop
-
Tracks progress through a list of
(item, quantity)purchase lines. - BuyPlan(List<BuyPlan.Line>) - Constructor for class privbot.hooks.shop.BuyPlan
- BuyPlan.Line - Class in privbot.hooks.shop
-
One
(item, quantity)pair. - BuyPlan.Skip - Enum in privbot.hooks.shop
-
Why a line was retired without reaching its target.
- buyX(ShopSlot) - Method in class privbot.hooks.shop.ShopInterface
-
Opens the Buy X amount prompt on a stock slot.
- byName() - Method in class privbot.mechanics.SwitchResult
- byName(String) - Method in class privbot.hooks.Vars
-
The value of a variable by name, from this server's evidence-backed names (
VarRegistry).
C
- cancel() - Method in class privbot.actions.confirm.ActionHandle
- cancel() - Method in interface privbot.hooks.Events.Subscription
-
Removes the listener.
- cancel() - Method in class privbot.hooks.Workflows
-
Requests cancellation of the currently running async workflow.
- cancel() - Method in interface privbot.mechanics.Job
-
Stops the job: it ends FAILED with reason "cancelled", stops any background work it started (a route, a sub-job, a worker), and a later
Job.step(privbot.task.PrivTaskContext)never clicks. - cancel() - Method in class privbot.movement.pathing.ExactStepHandle
- cancel() - Method in interface privbot.movement.pathing.NavigationHandle
- cancel() - Method in class privbot.movement.pathing.NavigationSession
- CANCELLED - Enum constant in enum privbot.actions.confirm.ActionStatus
- canContinue() - Method in class privbot.hooks.Dialogue
-
Returns true if any visible widget has a "Continue" action — the universal signal for a click-through dialogue.
- candidate() - Method in class privbot.mechanics.StylePlanner.Decision
- candidate(CombatStyle, GearSetup, FightFrame, Boolean, Boolean, boolean, boolean) - Static method in class privbot.mechanics.StylePlanner
-
Derive one style candidate from a worn setup and a same-tick frame.
- Candidate(int, String, Boolean, Boolean, Boolean, Boolean, Integer) - Constructor for class privbot.mechanics.OpponentLockPolicy.Candidate
- Candidate(CombatStyle, int, Boolean, Boolean, Boolean, boolean) - Constructor for class privbot.mechanics.StylePlanner.Candidate
- candidates(String) - Static method in class privbot.hooks.shop.TradeVerb
-
Ordered verbs to try when the entity's action list cannot be read directly — game objects are resolved by asking the object helper for each candidate in turn.
- canRun(ApiVersion) - Method in class privbot.api.ApiVersion
-
True when this runtime version can run a plugin built against
plugin. - canvasPoint(WorldPoint, int) - Method in class privbot.ui.overlay.SceneProjection
-
The canvas point of a tile's centre raised by
heightOffset(0 = ground), or null. - capabilities - Variable in class privbot.context.PrivContext
-
What the unified API supports on this server (
privbot/api/capabilities.json). - capabilities - Variable in class privbot.task.PrivTaskContext
-
Mirrors
PrivContext.capabilities. - Capabilities - Interface in privbot.api
-
What the unified API supports on the server this plugin runs on.
- Capability - Enum in privbot.api
-
One thing a plugin can ask the unified API to read or do.
- capture - Variable in class privbot.context.PrivContext
-
Passive recording to
~/.privbot/captures; writes nothing untilstart. - capture - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.capture. - capture(List<Object[]>, long) - Static method in class privbot.hooks.BankSeen
-
Stores a snapshot.
- capture(Client) - Static method in class privbot.movement.pathing.SceneReachability
- Capture - Class in privbot.hooks
-
Passive recording for a plugin:
ctx.capture. - captureCarried() - Method in class privbot.hooks.Loadouts
-
Reads what is carried, one entry per item id, with the role of each.
- captureCarried(ItemContainerSnapshot) - Static method in class privbot.mechanics.GearSetup
-
Captures what is carried: a stack split over several slots is merged into one entry per item id (it keeps the first slot it was seen in).
- captureWorn() - Method in class privbot.hooks.Loadouts
-
Reads what is worn, by slot.
- captureWorn(ItemContainerSnapshot) - Static method in class privbot.mechanics.GearSetup
-
Captures what is worn, by slot, at the quantity worn now.
- CARD_BG - Static variable in class privbot.ui.overlay.OverlayTheme
-
Translucent card behind a HUD panel.
- CARD_BORDER - Static variable in class privbot.ui.overlay.OverlayTheme
-
1 px card outline.
- cardBackground(int) - Static method in class privbot.ui.overlay.OverlayTheme
-
OverlayTheme.CARD_BGatopacityPercent(0..100, clamped) instead of its fixed alpha: the per-panel background of a HUD whose opacity is a setting. - carried() - Method in class privbot.mechanics.RestockTarget
- carried(GearSetup) - Method in class privbot.mechanics.RestockTarget.Builder
- carried(GearSetup, ItemContainerSnapshot) - Static method in class privbot.mechanics.SetupDiff
-
Compares the inventory with a carried setup.
- CARRIED - Enum constant in enum privbot.mechanics.GearSetup.Kind
- cast(String) - Method in class privbot.hooks.Magic
-
Casts the spell whose in-game label matches
name(display name, enum constant, or colour-stripped menu target). - castOnInventoryItem(String, int, int) - Method in class privbot.hooks.Magic
-
Casts
name(e.g. - castOnNpc(String, PrivNPC) - Method in class privbot.hooks.Magic
-
Casts a spell by in-game name on an NPC.
- castOnObject(String, PrivObject) - Method in class privbot.hooks.Magic
-
Casts a spell by in-game name on a scene object.
- castOnPlayer(String, PrivPlayer) - Method in class privbot.hooks.Magic
-
Casts
nameontarget. - castOnPlayerOutcome(String, PrivPlayer) - Method in class privbot.hooks.Magic
-
Casts
nameontargetand reports what happened to the target click. - CastResult(Magic.CastOutcome, String) - Constructor for class privbot.hooks.Magic.CastResult
- castTeleport(String) - Method in class privbot.hooks.Teleporter
- castVengeance() - Method in class privbot.hooks.Combat
-
Casts Vengeance (Lunar spellbook; by name through the spellbook on Elorin).
- cause - Variable in class privbot.hooks.Events.DeathEvent
-
What showed it:
"hitpoints 0"or"animation <id>". - CEILING - Enum constant in enum privbot.mechanics.WildernessModel.Rounding
- Change(String, String, String) - Constructor for class privbot.config.ConfigMigration.Change
- chat - Variable in class privbot.context.PrivContext
-
Chatbox reads and sending chat lines or commands.
- chat - Variable in class privbot.hooks.Events.Needs
-
Read the chat list.
- chat - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.chat. - chat(List<Events.ChatEvent>) - Method in class privbot.hooks.Events.Frame.Builder
- Chat - Class in privbot.hooks
-
Chat message reading and sending via the RuneLite
Client. - Chat(Client) - Constructor for class privbot.hooks.Chat
- CHAT_DEATH - Enum constant in enum privbot.effects.EffectObservation.Source
-
The server's death message cleared the effect.
- CHAT_ENDED - Enum constant in enum privbot.effects.EffectObservation.Source
-
A recognized server message reported that the effect ended.
- CHAT_ESTIMATE - Enum constant in enum privbot.effects.EffectObservation.Source
-
A recognized server chat message started a duration estimate.
- CHAT_READ - Enum constant in enum privbot.api.Capability
- CHAT_SEND - Enum constant in enum privbot.api.Capability
- CHAT_WARNING_INVALIDATED - Enum constant in enum privbot.effects.EffectObservation.Source
-
Source policy discarded the timer on an 'about to' warning; actual state is unknown.
- ChatEvent(ChatMessageType, String, String, int, boolean) - Constructor for class privbot.hooks.Events.ChatEvent
-
A chat line without a client message-node id (de-duplicated by content within the tick).
- ChatEvent(ChatMessageType, String, String, int, boolean, String) - Constructor for class privbot.hooks.Events.ChatEvent
-
A chat line with a stable identity (sources and tests).
- check(String, String) - Static method in class privbot.api.ApiVersion
-
The load decision for a plugin on this runtime: compatibility plus the legacy rule (a plugin without an API version loads only from the "first-party" channel).
- check(String, String, String) - Static method in class privbot.api.ApiVersion
-
ApiVersion.check(String, String)against an explicit runtime version. - Child<C> - Class in privbot.task
-
Shared base class for child task behaviors owned by a
Parent. - Child(String) - Constructor for class privbot.task.Child
-
Creates a child with priority
0. - Child(String, int) - Constructor for class privbot.task.Child
- childTextLower(int, int) - Method in class privbot.hooks.Widgets
-
Lowercase text from
client.getWidget(parentPackedId).getChild(childIndex)when the parent is non-hidden; otherwise empty string. - ChipToggle(String, Color) - Constructor for class privbot.ui.ModernTheme.ChipToggle
- choice() - Method in class privbot.mechanics.EatDeferral.Decision
- choose(Boolean, CombatStyle, Boolean, Boolean, CombatStyle, CombatStyle) - Static method in class privbot.mechanics.IncomingStyleDecision
-
Apply the flagship priority: an avoidable due shot, active magic tell, eligible opponent, then the hit ledger.
- choose(String, List<String>) - Static method in class privbot.mechanics.GearNames
-
The index of the candidate to use for
wanted: the exact name if it is there, otherwise the first variant of it, otherwise-1. - choose(List<NpcView>, int, WorldPoint, TargetSpec) - Method in class privbot.mechanics.TargetLock
-
Picks the target, in this order: the current target, if it matches and is alive and not busy; the locked NPC, if present with the same index and id, still matching the spec, alive and not busy; the first matching NPC that targets us and is alive; the nearest matching NPC that is alive and not busy, ties to the lower index. A locked NPC seen dead counts a kill if it had targeted us or been our current target.
- choose(Set<CombatStyle>, Set<CombatStyle>, Map<CombatStyle, Integer>, Random) - Static method in class privbot.mechanics.StylePolicy
-
Picks an available style that is not blocked, weighted.
- clamp(Rectangle, Dimension) - Static method in class privbot.ui.overlay.OverlayPlacement
-
rpushed insideviewport; a side longer than the viewport starts at 0. - CLASSIC - Enum constant in enum privbot.ui.overlay.PaletteSettings.Scheme
- classify(String) - Static method in class privbot.mechanics.WeaponStyles
-
A name-based style guess, or null for an unknown name; it is not proof of an opponent's next attack.
- classify(Client, GameObjects.ToaRewardsRoomChest.Config) - Static method in class privbot.hooks.GameObjects.ToaRewardsRoomChest
-
Classifies the sarcophagus on the anchor tile.
- classifyMove(int, int, int) - Static method in class privbot.mechanics.FreezeClock
-
What a move of theirs at
moveTickwas, for a freeze that landed atstart. - cleanBountyTarget(String) - Static method in class privbot.hooks.PlayersHook
-
Normalised target name; blank, "null" and "None" (the overlay's empty spellings) are no target.
- cleanup() - Method in class privbot.task.CompositeTaskNode
-
Propagates cleanup to all children.
- cleanup() - Method in class privbot.task.Parent
-
Calls
TaskNode.cleanup()on every child. - cleanup() - Method in class privbot.task.SimpleNode
-
Called when the script shuts down or the task tree is torn down.
- cleanup() - Method in interface privbot.task.TaskNode
-
Cleanup lifecycle hook called when the script shuts down or the tree is torn down.
- clear() - Static method in class privbot.hooks.BankSeen
-
Forgets the snapshot: another account logged in (
SessionAccount). - clear() - Method in class privbot.hooks.Blackboard
-
Removes all entries.
- clear() - Method in class privbot.hooks.Events
-
Removes every listener (call from Stop / shutDown) and forgets the baselines.
- clear() - Method in class privbot.mechanics.AttackExpiryTracker
-
Forget the run at a new lock or session.
- clear() - Method in class privbot.mechanics.CueTimeline
- clear() - Method in class privbot.mechanics.HazardMap
-
Forgets everything, timed and persistent.
- clear() - Method in class privbot.mechanics.HealthHistory
-
Clear at a session boundary, death or restart.
- clear() - Method in class privbot.mechanics.OpponentEnergy
-
Reset on a new opponent, lock, death, disconnect or client session.
- clear() - Method in class privbot.mechanics.ShotTracker
- clear() - Method in class privbot.mechanics.ThreatMemory
-
Forget all prior fight and session observations.
- clear() - Method in class privbot.ui.overlay.Snapshot
-
Forget the value; overlays composed from this snapshot stop rendering until the next publish.
- clear() - Method in class privbot.ui.SearchField
-
Empties the field and fires the text-changed callback with
"". - clearAll() - Method in class privbot.effects.EffectTracker
-
Clears local bookkeeping without asserting that any in-game effect ended.
- cleared(int) - Method in class privbot.mechanics.AttackHistory
-
Record a confirmed clearing exit that happened after the send, not a merely dispatched action.
- cleared(int) - Method in class privbot.mechanics.OwnAttackClock
-
Record a clearing effect only after it is observed and attributed to an action after the send.
- clearMessageBuffer() - Static method in class privbot.hooks.Chat
-
Clear the message buffer (e.g.
- clearNodes() - Method in class privbot.task.StagedTaskRunner
-
Removes every registered node.
- clearNodes() - Method in class privbot.task.TaskNodeRunner
-
Removes all registered nodes.
- clearTimer(String) - Method in class privbot.effects.EffectTracker
- clickContinue() - Method in class privbot.hooks.Dialogue
-
Clicks the first visible widget with a "Continue" action.
- clicked(String, int) - Method in class privbot.mechanics.OffensivePrayerUpkeep
- client() - Method in class privbot.ui.overlay.SceneProjection
-
The client this projection reads the camera from.
- CLIENT_THREAD - Enum constant in enum privbot.context.GameThreadPolicy
-
Inline on the client thread only; anything else waits on the
ClientThreadqueue. - CLIENT_THREAD_QUEUE - Enum constant in enum privbot.context.GameThreadRouting.Route
-
Queued on the
ClientThread; awaited byensure, fire-and-forget forinvokeLater. - clipToWidth(Graphics2D, String, int) - Static method in class privbot.ui.overlay.PrivBotChatboxOverlayComponents
-
textcut to fitmaxWidthin the value font, ending in"..."when cut; null gives"-". - close() - Method in class privbot.hooks.Bank
-
Closes the bank interface.
- close() - Method in class privbot.hooks.Dialogue
-
Elorin's dialogue close action is Escape (the installed client API explicitly selects it).
- close() - Method in interface privbot.hooks.Events.Subscription
-
Same as
Events.Subscription.cancel(). - close() - Method in class privbot.ui.overlay.OverlayMoveInput
-
Stops listening (unregisters the listener or pops the event filter).
- close() - Method in class privbot.ui.overlay.OverlaySet
-
Removes every overlay from the manager; call it in
shutDown(). - CLOSE - Enum constant in enum privbot.mechanics.PvpArbiter.Kind
- CLOSE - Enum constant in enum privbot.mechanics.PvpMovement.Kind
- CLOSE_PARAM0 - Static variable in class privbot.hooks.bank.BankSession
-
The Close button's
param0: child index 11 ofBankSession.CLOSE_WIDGET. - CLOSE_WIDGET - Static variable in class privbot.hooks.bank.BankSession
-
Packed widget id of the Close button on Orion, Roat Pkz and SpawnPK.
- closeBank() - Method in class privbot.hooks.Bank
-
Deprecated.
- closeOutcome() - Method in class privbot.hooks.Bank
-
Bank.close()with an explicit outcome. - closest() - Method in class privbot.query.GraphicsObjectQuery
-
The graphic nearest the local player in tile steps, ignoring other planes (null if none is on the player's plane).
- closest() - Method in class privbot.query.GroundItemQuery
-
The stack nearest the local player in tile steps; stacks on another plane rank last.
- closest() - Method in class privbot.query.NPCQuery
-
The NPC nearest the local player in tile steps.
- closest() - Method in class privbot.query.ObjectQuery
-
Closest by Euclidean distance to the local player.
- closest() - Method in interface privbot.query.PlayerSearch
- closest(String...) - Method in class privbot.hooks.GameObjects
-
Closest object matching any of the supplied names, or
null. - closest(String...) - Method in class privbot.hooks.GroundItems
-
Nearest ground item matching any supplied name, or
null. - closest(String...) - Method in class privbot.hooks.NPCs
-
Closest NPC matching any of the supplied names, or
null. - closest(String...) - Method in class privbot.hooks.PlayersHook
-
Closest other player matching any of the supplied names, or
null. - closest(Predicate<GraphicsObject>) - Method in class privbot.query.GraphicsObjectQuery
-
Narrows by
predicate(in place), then returns the closest match. - closest(Predicate<Player>) - Method in class privbot.hooks.PlayersHook
- closest(Predicate<Player>) - Method in interface privbot.query.PlayerSearch
- closest(Predicate<PrivGroundItem>) - Method in class privbot.hooks.GroundItems
-
Nearest ground item matching
pred(same asquery().closest(pred)). - closest(Predicate<PrivGroundItem>) - Method in class privbot.query.GroundItemQuery
-
Filter then nearest to the player (Scar / DreamBot
GroundItems.closest(pred)style). - closest(Predicate<PrivNPC>) - Method in class privbot.hooks.NPCs
-
Closest NPC matching the predicate.
- closest(Predicate<PrivNPC>) - Method in class privbot.query.NPCQuery
-
Filter then nearest to the local player.
- closest(Predicate<PrivObject>) - Method in class privbot.hooks.GameObjects
-
Closest object matching the predicate.
- closest(Predicate<PrivObject>) - Method in class privbot.query.ObjectQuery
-
Narrows by
pred(in place), then returns the closest match; seeObjectQuery.closest(). - closestPriv(Predicate<Player>) - Method in class privbot.hooks.PlayersHook
-
Nearest matching player as a
PrivPlayerfor menu dispatch. - code - Variable in class privbot.mechanics.ThreatMemory.Hit
- codeZeroDropped() - Method in class privbot.mechanics.ThreatMemory.View
- CollapsibleSection - Class in privbot.ui
-
A collapsible section with a clickable header that toggles content visibility.
- CollapsibleSection(String, boolean) - Constructor for class privbot.ui.CollapsibleSection
-
Creates a collapsible section.
- collect(Client) - Static method in class privbot.query.SceneTileObjects
-
Every wall, decorative, ground and game object with a valid id in the loaded scene, across all planes (some servers populate objects on a plane other than the player's).
- collect(LootSpec) - Method in class privbot.hooks.Loot
-
Starts a job that collects what
specwants. - collectProfileState() - Method in class privbot.ui.PrivBotFrame
-
Collects profile state from all sections that implement
ProfileStateParticipant. - collision() - Method in interface privbot.hooks.CombatCollision.Source
- color(PaletteSettings.Slot) - Method in interface privbot.ui.overlay.PaletteSettings
-
The user's colour for one slot of a
PaletteSettings.Scheme.CUSTOMscheme. - colorHex(Color) - Static method in class privbot.ui.GearTheme
-
#RRGGBBforc; alpha is dropped. - ColorRamp - Class in privbot.ui.overlay
-
A value-to-colour rule, so a threshold ladder is written once and reused.
- ColorRamp.Rule - Interface in privbot.ui.overlay
-
Maps a plain value.
- combat - Variable in class privbot.context.PrivContext
-
Attacking, special attack and combat-state reads.
- combat - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.combat. - Combat - Class in privbot.hooks
-
Thread-safe combat reads and player/spec interactions for scripts.
- COMBAT - Static variable in class privbot.ui.SkillIconManager
-
Key for the combat icon (a sword).
- COMBAT_ATTACK - Static variable in class privbot.task.TaskPriorityBands
-
Attacking the current target.
- COMBAT_BOOST - Enum constant in enum privbot.mechanics.GearSetup.Role
- COMBAT_GEAR - Static variable in class privbot.task.TaskPriorityBands
-
Gear switches within a combat parent.
- COMBAT_HIGH - Enum constant in enum privbot.task.AutomationStage
-
High-priority combat — prayer switch, siphon, Olm heal/special/mage/melee/head (typically 55–150 depending on plugin).
- COMBAT_LOOT - Static variable in class privbot.task.TaskPriorityBands
-
Loot collection that should complete before selecting a new combat target.
- COMBAT_LOW - Enum constant in enum privbot.task.AutomationStage
-
Lower combat — spec, gear, offensive prayer, core, boss attack (typically 60–100).
- COMBAT_SPECIAL - Static variable in class privbot.task.TaskPriorityBands
-
Boss-combat action ordering within a combat parent.
- CombatCollision - Interface in privbot.hooks
-
One detached collision read from the local player's tile, returned by
ctx.combat.collision()and reusable for every candidate target of one decision. - CombatCollision.Source - Interface in privbot.hooks
-
The facade that hands out collision reads:
ctx.combat. - combatLevel() - Method in class privbot.mechanics.PlayerView
- CombatLevels - Class in privbot.mechanics
-
Detached boosted and real combat levels; null means an individual read was unavailable.
- CombatLevels(Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer) - Constructor for class privbot.mechanics.CombatLevels
- CombatStyle - Enum in privbot.mechanics
-
The three combat styles and the overhead prayer that blocks each.
- combine(PvpActionPlanner.Plan, InstantMaulPlan.Plan) - Static method in class privbot.mechanics.PvpMaulCoordinator
-
Consume and other orb actions take precedence.
- combine(PvpActionPlanner.Plan, InstantMaulPlan.Plan, KnockoutWeaponPlan.Plan) - Static method in class privbot.mechanics.PvpFinisherCoordinator
-
An eligible instant maul takes precedence over KO gear, as in the flagship.
- combine(PvpActionPlanner.Plan, KnockoutWeaponPlan.Plan) - Static method in class privbot.mechanics.PvpKoCoordinator
-
A generic special takes precedence; consume actions hold new KO equips.
- COMBO - Enum constant in enum privbot.mechanics.ConsumeTiming.Kind
- COMBO_EAT - Enum constant in enum privbot.mechanics.SustainChoice.Kind
- comboAfterEat(SustainPlan, Integer, Integer, ItemContainerSnapshot) - Static method in class privbot.mechanics.SustainPolicy
-
Call with the readings taken before the first Eat: the combo click goes out straight after it in the same tick, so HP has not changed yet.
- comboFoods(String...) - Method in class privbot.mechanics.SustainPlan.Builder
-
Foods eaten in the same tick after a food, for a combo eat; each must carry "Eat".
- comboLanded() - Method in class privbot.mechanics.SustainOutcome
- combos - Variable in class privbot.mechanics.ConsumePlanner.Settings
- Commitment - Class in privbot.mechanics
-
What the engine is committed to: a STYLE, and on top of it at most one fixed-plan EPISODE (plan fix 6, D44).
- Commitment.Episode - Enum in privbot.mechanics
-
A fixed-plan episode, or none.
- compareTo(ApiVersion) - Method in class privbot.api.ApiVersion
- COMPATIBLE - Enum constant in enum privbot.api.ApiVersion.Status
-
Same major, plugin minor not newer than the runtime's.
- complete() - Method in class privbot.mechanics.NpcAttackerEvidence
-
Whether every loaded NPC in range was placed and inspected.
- compose(Rows, S) - Method in class privbot.ui.overlay.PrivBotOverlayPanel
-
The rows for this render; called only with a non-null state.
- CompositeTaskNode<C> - Class in privbot.task
-
A task node that holds child nodes and delegates execution using a strategy.
- CompositeTaskNode(String, CompositeTaskNode.Strategy) - Constructor for class privbot.task.CompositeTaskNode
-
Creates a composite task node with default priority (0).
- CompositeTaskNode(String, CompositeTaskNode.Strategy, int) - Constructor for class privbot.task.CompositeTaskNode
-
Creates a composite task node.
- CompositeTaskNode.Strategy - Enum in privbot.task
-
Execution strategy for child nodes.
- compositionForGameObject(Client, GameObject, int) - Static method in class privbot.hooks.GameObjects.ToaRewardsRoomChest
- Config(int, int, int, String) - Constructor for class privbot.hooks.GameObjects.ToaRewardsRoomChest.Config
- ConfigMigration - Class in privbot.config
-
One-time, versioned changes to a plugin's saved settings, for a default that changed after users saved the old one.
- ConfigMigration.Change - Class in privbot.config
-
One value a step changed:
keyfromfromtoto;tois null when the key was unset. - ConfigMigration.ConfigAccess - Interface in privbot.config
-
Minimal view of RuneLite's ConfigManager for one config group, so tests need no client.
- ConfigMigration.Step - Interface in privbot.config
-
One change, applied when its version is above the stored one.
- configure() - Method in class privbot.context.PrivBotContextModule
- configuredDrop(Predicate<LootDrop>, int) - Method in class privbot.hooks.GroundItems
-
The nearest ground stack within
rangetiles thatpolicyaccepts. - configureFxToolkitOnce() - Static method in class privbot.ui.fx.FxConfigDialog
-
Deprecated.
- configureImplicitExitOnce() - Static method in class privbot.ui.fx.FxPlatformUtil
-
Same lifecycle hook as
AutoCombatProUI: keep the FX toolkit alive while Swing windows may be hidden. - configureScrollBarColors() - Method in class privbot.ui.ModernTheme.ModernScrollBarUI
-
Uses the theme border colour for the thumb and the sidebar colour for the track.
- CONFIRM_TICKS - Static variable in class privbot.mechanics.OffensivePrayerUpkeep
-
Ticks after a click before an "off" read counts against it.
- CONFIRMED - Enum constant in enum privbot.actions.confirm.ActionStatus
- confirmedSpend(int, String, Integer) - Method in class privbot.mechanics.OpponentEnergy
-
Record an independently confirmed spend once per stable event ID.
- confirms(SpecEnergy.Fired, int, boolean) - Static method in class privbot.mechanics.SpecEnergy
-
Whether the reading after a SUSPECT_ZERO confirms it: readable, and still 0.
- CONSUMABLE - Enum constant in enum privbot.mechanics.GearSetup.Role
- ConsumableSelectionOrder - Class in privbot.query
-
Stable ordering for inventory consumables when multiple slots match (e.g.
- consume(ConsumeTiming.Kind, ItemContainerSnapshot.Item) - Static method in class privbot.mechanics.PvpArbiter.Action
-
Construct a consume action retaining its item ID, slot and distinct food, combo or potion category.
- consumed(long) - Method in class privbot.mechanics.BoostDosePolicy
-
The dose was confirmed gone from the inventory: wait for its boost and clear the failure count.
- consumeKind() - Method in class privbot.mechanics.PvpArbiter.Action
-
Food, combo food or potion category; null when this action did not specify one.
- ConsumePlanner - Class in privbot.mechanics
-
Pure per-tick consume planning over detached inputs.
- ConsumePlanner.Action - Class in privbot.mechanics
- ConsumePlanner.Plan - Class in privbot.mechanics
- ConsumePlanner.Settings - Class in privbot.mechanics
- ConsumePlanner.State - Class in privbot.mechanics
-
Detached current inputs from one decision tick.
- ConsumeTiming - Class in privbot.mechanics
-
Pure consume cooldown rules.
- ConsumeTiming.Kind - Enum in privbot.mechanics
- ConsumeTiming.Mode - Enum in privbot.mechanics
- consumption() - Method in class privbot.mechanics.PvpActionPlanner.Plan
- ContainerSlot - Class in privbot.hooks.container
-
One occupied slot in a widget-backed item container.
- ContainerSlot(int, int, int, String, int) - Constructor for class privbot.hooks.container.ContainerSlot
- containerWidgetId() - Method in class privbot.hooks.bank.BankSlot
-
Owning widget — the
param1of a withdraw. - containerWidgetId() - Method in class privbot.hooks.container.ContainerSlot
-
Owning widget — the
param1of an action against this slot. - containerWidgetId() - Method in class privbot.hooks.shop.ShopSlot
-
Owning widget — the
param1of a buy. - contains(boolean) - Method in class privbot.mechanics.TargetSpec
-
true(default): plain entries match by containment;false: every entry is an exact match. - contains(int) - Method in class privbot.mechanics.AttackTiming.Window
- contains(int...) - Method in class privbot.hooks.Bank
- contains(int...) - Method in class privbot.hooks.Equipment
- contains(int...) - Method in class privbot.hooks.Inventory
- contains(String) - Method in class privbot.hooks.Dialogue
-
Returns true if any visible widget's text, name, or actions contain the given string.
- contains(String...) - Method in class privbot.hooks.Bank
- contains(String...) - Method in class privbot.hooks.Equipment
- contains(String...) - Method in class privbot.hooks.Inventory
- contains(WorldPoint) - Method in class privbot.mechanics.Destination
- contains(WorldPoint) - Method in class privbot.movement.pathing.SceneReachability
- CONTAINS - Enum constant in enum privbot.hooks.Widgets.MatchMode
- containsMessage(String) - Method in class privbot.hooks.Chat
-
Chat.containsMessage(String, int)over the last 20 lines. - containsMessage(String, int) - Method in class privbot.hooks.Chat
-
Check if any recent chat message contains the substring (case-insensitive).
- containsMessage(ChatMessageType, String, int) - Method in class privbot.hooks.Chat
- content - Variable in class privbot.ui.PrivBotFrame.SectionInfo
-
The panel shown when the section is selected.
- CONTENT_SURFACE - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for the content surface behind section cards.
- contentKey(ChatMessageType, String, String, String) - Static method in class privbot.hooks.Events.ChatEvent
- Context(Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, boolean, Boolean, PvpArbiter.Action, int, Boolean, boolean) - Constructor for class privbot.mechanics.PvpArbiter.Context
- corridor() - Method in class privbot.hooks.Combat
-
One immutable collision read from the local player's tile, reusable for every candidate NPC of one decision.
- corridor() - Method in interface privbot.hooks.CombatCollision.Source
-
One collision read from the local player's tile, same as
CombatCollision.Source.collision()and preferred. - count(int) - Method in class privbot.hooks.Bank
- count(int) - Method in class privbot.hooks.container.ItemContainerSnapshot
- count(int) - Method in class privbot.hooks.Equipment
- count(int) - Method in class privbot.hooks.Inventory
- count(String) - Method in class privbot.hooks.Bank
- count(String) - Method in class privbot.hooks.container.ItemContainerSnapshot
-
Total stack quantity for an exact, case-insensitive name.
- count(String) - Method in class privbot.hooks.Inventory
-
Total quantity of items whose display name equals
name(case-insensitive), e.g. - count(Predicate<ItemContainerSnapshot.Item>) - Method in class privbot.hooks.container.ItemContainerSnapshot
- countAll(int) - Static method in class privbot.hooks.Bank
-
Static count through the process-wide adapter; prefer
ctx.bank.count(id). - countAll(int) - Static method in class privbot.hooks.Inventory
-
Static count that needs no
ctx; preferctx.inventory.count(id). - countAll(String) - Static method in class privbot.hooks.Bank
-
Static count through the process-wide adapter; prefer
ctx.bank.count(name). - countAll(String) - Static method in class privbot.hooks.Inventory
-
Static count that needs no
ctx; preferctx.inventory.count(name). - countdown(WorldPoint, int, ColorRamp) - Method in class privbot.ui.overlay.SceneCanvas
-
A tick countdown on a tile: fill from
ramp, the number shadowed on top. - countdown(WorldPoint, String, int, ColorRamp) - Method in class privbot.ui.overlay.SceneCanvas
-
A countdown tile coloured by
ramp(ticksLeft)with customtexton top. - counts() - Method in class privbot.mechanics.ThreatMemory.View
- COX_OLM_COMBAT - Static variable in class privbot.task.TaskPriorityBands
-
CoX Olm combat coordinator and related (merged sub-nodes).
- createBadge(String, Color) - Static method in class privbot.ui.ModernTheme
-
Static pill badge tinted with
color; useModernTheme.createDynamicBadge(java.lang.String, java.awt.Color)when it changes. - createCardPanel() - Static method in class privbot.ui.ModernTheme
-
Creates a rounded "card" surface panel used throughout PrivBot GUIs.
- createCardPanel(int) - Static method in class privbot.ui.ModernTheme
-
ModernTheme.createCardPanel()withpaddingpixels of inner padding on every side. - createChip(String, Color) - Static method in class privbot.ui.ModernTheme
-
A
ModernTheme.ChipTogglefor small filters and sort options. - createDangerButton(String) - Static method in class privbot.ui.ModernTheme
-
Red button for Stop and destructive actions.
- createDecreaseButton(int) - Method in class privbot.ui.ModernTheme.ModernScrollBarUI
-
A zero-size button: the bar has no arrow buttons.
- createDynamicBadge(String, Color) - Static method in class privbot.ui.ModernTheme
-
A
ModernTheme.ModernBadgewhose text and colour can change, e.g. - createFilterChip(String, boolean) - Static method in class privbot.ui.ModernTheme
-
A
ModernTheme.FilterChipfor filter bars and tab strips. - createFormPanel() - Static method in class privbot.ui.ModernTheme
-
Creates an empty GridBagLayout panel for building forms with
ModernTheme.addFormRow(javax.swing.JPanel, int, java.lang.String, javax.swing.JComponent). - createFormPanel() - Static method in class privbot.ui.SwingFormKit
- createGhostButton(String) - Static method in class privbot.ui.ModernTheme
-
Transparent button that shows the card colour on hover.
- createIncreaseButton(int) - Method in class privbot.ui.ModernTheme.ModernScrollBarUI
-
A zero-size button: the bar has no arrow buttons.
- createInlineField(String, JComponent) - Static method in class privbot.ui.SwingFormKit
-
Label + field on one row (used by gear delay grids).
- createItem(int) - Method in class privbot.hooks.Production
-
Select one currently offered product.
- createLabel(String) - Static method in class privbot.ui.ModernTheme
-
Body-text label in
ModernTheme.TEXT_PRIMARY. - createMark(String, Color) - Static method in class privbot.ui.ModernTheme
-
A
ModernTheme.MarkLabel: a small lettered logo tile for headers. - createMutedLabel(String) - Static method in class privbot.ui.ModernTheme
-
Small muted label for hints and captions.
- createPopupMenu() - Static method in class privbot.ui.ModernTheme
-
Popup menu items styled like Rule Studio (hover background + subtle border).
- createPopupMenuItem(String, ActionListener) - Static method in class privbot.ui.ModernTheme
-
Menu item for
ModernTheme.createPopupMenu()with a rounded hover highlight;listenermay be null. - createPrimaryButton(String) - Static method in class privbot.ui.ModernTheme
-
Primary action button (indigo).
- createScrollPane(Component) - Static method in class privbot.ui.ModernTheme
-
Borderless scroll pane with thin themed scroll bars and a 16 px wheel step.
- createScrollPane(Component) - Static method in class privbot.ui.SwingFormKit
- createSecondaryButton(String) - Static method in class privbot.ui.ModernTheme
-
Secondary button on the card colour.
- createSection(String) - Static method in class privbot.ui.ModernTheme
-
Creates a titled section panel with a card background and outlined border.
- createSectionBody() - Static method in class privbot.ui.ModernTheme
-
Creates a body panel for collapsible sections or content areas.
- createSectionBody() - Static method in class privbot.ui.SwingFormKit
- createSeparator() - Static method in class privbot.ui.ModernTheme
-
One-pixel horizontal separator in
ModernTheme.BORDER_SUBTLE. - createStyledToggleButton() - Static method in class privbot.ui.ModernTheme
-
Toggle button with custom paint to avoid repaint glitch.
- createSubtitle(String) - Static method in class privbot.ui.ModernTheme
-
Subtitle label (
ModernTheme.FONT_SUBTITLE, secondary colour). - createSuccessButton(String) - Static method in class privbot.ui.ModernTheme
-
Green button with dark text, for Start/confirm actions.
- createTextField(String) - Static method in class privbot.ui.ModernTheme
-
Themed text field showing
placeholderwhile empty. - createTitle(String) - Static method in class privbot.ui.ModernTheme
-
Title label (
ModernTheme.FONT_TITLE). - createToolbarButton(String, String, Color) - Static method in class privbot.ui.ModernTheme
-
Workflow-toolbar style button (used by Rule Engine and other editors/tools).
- createTracker() - Method in class privbot.hooks.Actions
-
No worker or polling thread is created.
- createTracker() - Method in class privbot.hooks.Effects
- createValueLabel(String) - Static method in class privbot.ui.SwingFormKit
-
A body-text label for read-only values.
- critical() - Method in class privbot.mechanics.EmergencyConsume.Decision
-
Null means the health inputs are unreadable.
- CueTimeline - Class in privbot.mechanics
-
Holds the combat style the most recently LAUNCHED attack demands.
- CueTimeline() - Constructor for class privbot.mechanics.CueTimeline
- current - Variable in class privbot.hooks.Events.AnimationEvent
-
The new animation (-1 = none).
- current - Variable in class privbot.hooks.Events.VarChange
-
The new value.
- current() - Static method in class privbot.api.ApiVersion
-
ApiVersion.CURRENT, parsed. - current() - Method in class privbot.mechanics.CueTimeline
- CURRENT - Static variable in class privbot.api.ApiVersion
-
The API version this runtime provides, for example
"1.0.0". - currentStock() - Method in class privbot.hooks.shop.ShopInterface
-
The stock scan, as a copy: the one
ShopInterface.openState()just made when asked withinShopInterface.CACHE_TTL_MSof it, so a caller that checks the state and then reads the stock scans once. - currentTab() - Method in class privbot.hooks.Game
-
The selected profile-backed tab name, or null when the tab cannot be read.
- currentTarget() - Method in class privbot.mechanics.PvpSnapshot
- currentTargetIndex() - Method in class privbot.mechanics.ThreatSnapshot
- CURSES - Enum constant in enum privbot.hooks.Prayer.Book
-
The curse book (Deflect Magic, Soul Split, ...), on servers that have one.
- CUSTOM - Enum constant in enum privbot.ui.overlay.PaletteSettings.Scheme
- cycle - Variable in class privbot.hooks.Restock.Request
-
Elorin: the plugin's restock cycle.
- cycle() - Method in class privbot.mechanics.ThreatSnapshot
- cycle(RestockCycle) - Method in class privbot.hooks.Restock.Builder
D
- DamageRow - Class in privbot.mechanics
-
Detached historical damage distribution.
- DamageRow(String, int, int[]) - Constructor for class privbot.mechanics.DamageRow
- DANGER - Static variable in class privbot.ui.GearTheme
-
Danger and destructive actions (red).
- dangerLine() - Method in class privbot.mechanics.KnockoutRisk.Assessment
- dangerous(WorldPoint, int) - Method in class privbot.mechanics.HazardMap
-
True when
tileis persistent, or timed and not yet expired atnowTick. - darken(Color, int) - Static method in class privbot.ui.ModernTheme
-
Subtracts
amountfrom each RGB channel (floored at 0), keeping alpha. - deactivate(String) - Method in class privbot.hooks.Prayer
-
Deactivates the prayer with this in-game name if it is currently active.
- deactivateSpecialAttack() - Method in class privbot.hooks.Combat
-
Disarms the special attack orb when it reads armed.
- dead - Variable in class privbot.mechanics.OpponentLockPolicy.Candidate
- dead() - Method in class privbot.mechanics.NpcView
- DEAD - Enum constant in enum privbot.mechanics.DeathWatch.State
-
Hitpoints are 0 or a death animation is showing, or a death is still waiting for its respawn proof.
- deadline(Integer, Integer) - Static method in class privbot.mechanics.AttackTiming
-
The last pending tick; null if the send or ready estimate is unreadable.
- DeathEvent(int, WorldPoint, String) - Constructor for class privbot.hooks.Events.DeathEvent
- DeathWatch - Class in privbot.mechanics
-
Detects the local player's death and respawn by POLLING, one
DeathWatch.observe(java.lang.Integer, java.lang.Integer, net.runelite.api.coords.WorldPoint, int)call per game tick. - DeathWatch() - Constructor for class privbot.mechanics.DeathWatch
-
A watch with the default death animation {836}.
- DeathWatch(Set<Integer>) - Constructor for class privbot.mechanics.DeathWatch
- DeathWatch.State - Enum in privbot.mechanics
-
What one observation says.
- decide(int, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Integer, Integer, Boolean, Integer, Integer, Boolean, Integer) - Static method in class privbot.mechanics.KnockoutWeaponDecision
-
Null facts are unreadable and hold.
- decide(int, Boolean, Boolean, Boolean, Integer, Integer) - Static method in class privbot.mechanics.EatDeferral
-
A due, ready eat may be deferred at most two ticks toward a known later idle tick.
- decide(int, Boolean, List<StylePlanner.Candidate>, CombatStyle, CombatStyle, Integer, Integer) - Static method in class privbot.mechanics.StylePlanner
-
Choose from configured candidates.
- decide(int, WorldPoint, WorldPoint, CombatStyle, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, AttackTiming.Window, int, int, long, Function<WorldPoint, Boolean>) - Static method in class privbot.mechanics.PvpMovement
-
Choose a destination using server planning tiles.
- decide(ConsumeTiming.Mode, int, Integer, Integer, int, int, Integer, Integer, Integer, ItemContainerSnapshot.Item, ItemContainerSnapshot.Item, ItemContainerSnapshot.Item, ItemContainerSnapshot.Item, Boolean) - Static method in class privbot.mechanics.EmergencyConsume
-
Applies the flagship emergency rule to one inventory snapshot.
- decide(SpecialAttackPolicy.State) - Static method in class privbot.mechanics.SpecialAttackPolicy
-
Armed status is handled before set readiness: an armed orb can be spent by the next swing.
- decide(SustainPlan, Integer, Integer, Integer, ItemContainerSnapshot, Map<Skill, Integer>, long) - Static method in class privbot.mechanics.SustainPolicy
- decline() - Method in class privbot.hooks.Trade
- DEFAULT_COOKED_FOOD_NAME_PATTERNS - Static variable in class privbot.hooks.InventoryFoodQueries
-
Default cooked-food name substrings (contains, case-insensitive).
- DEFAULT_DEATH_ANIMATION - Static variable in class privbot.mechanics.DeathWatch
-
The OSRS death animation (836).
- DEFAULT_DEBOUNCE_TICKS - Static variable in class privbot.mechanics.OverheadWatch
-
Readable ticks in a row before an overhead blocks a style.
- DEFAULT_RADIUS - Static variable in class privbot.mechanics.PvpQuery
-
The radius used when
PvpQuery.within(int)is not called. - DEFAULT_RADIUS - Static variable in class privbot.mechanics.ThreatQuery
-
The radius used when
ThreatQuery.within(int)is not called. - DEFAULT_SHOP_STOCK_WIDGET_ID - Static variable in class privbot.hooks.Shop
-
OSRS/RSPS default: shop stock list (group 300, child 16).
- DEFAULT_SHOP_WIDGET_ID - Static variable in class privbot.hooks.Shop
-
OSRS/RSPS default: the shop's player-inventory container (group 301, child 0).
- DEFAULT_TTL_TICKS - Static variable in class privbot.mechanics.HazardMap
-
How long
HazardMap.add(WorldPoint, int)keeps a tile dangerous: two ticks. - DEFAULT_VERIFY_TICKS - Static variable in class privbot.mechanics.SwitchCheck
-
Ticks a switch has to show up when none is given.
- DEFAULT_VIEWPORT_HEIGHT - Static variable in class privbot.ui.overlay.OverlayPlacement
-
Height of the fixed-size game frame used when the viewport is unknown.
- DEFAULT_VIEWPORT_WIDTH - Static variable in class privbot.ui.overlay.OverlayPlacement
-
Fixed-size game frame used when the viewport is unknown.
- defaults() - Static method in class privbot.mechanics.PrayerPlanner.Options
-
No idle style, no idle fallback, idle 1 tick, delay 0, no settle animations, settle 1 tick.
- defaults() - Static method in class privbot.movement.pathing.NavigationSession.Policy
- defence() - Method in class privbot.mechanics.CombatLevels
- defenceReal() - Method in class privbot.mechanics.CombatLevels
- DEFER - Enum constant in enum privbot.mechanics.EatDeferral.Choice
- deferredSince - Variable in class privbot.mechanics.ConsumePlanner.State
- deferredSince() - Method in class privbot.mechanics.ConsumePlanner.Plan
- deferredSince() - Method in class privbot.mechanics.EatDeferral.Decision
- deflectPrayer() - Method in enum privbot.mechanics.CombatStyle
-
The curses-book prayer that blocks this style, e.g.
- delayTicks(int) - Method in class privbot.mechanics.PrayerPlanner.Options
-
Ticks between an attack animation's first tick and the switch (minimum 0, default 0).
- delete(String) - Method in class privbot.hooks.Loadouts
- DEPOSIT_ALL_IDENTIFIER - Static variable in class privbot.hooks.bank.BankSession
-
The Deposit-All identifier on
BankSession.INVENTORY_ITEMS_WIDGETwhile the bank's default quantity is All. - DEPOSIT_EQUIPMENT_WIDGET - Static variable in class privbot.hooks.bank.BankSession
-
Packed widget id of the Deposit worn items button on Orion, Roat Pkz and SpawnPK.
- DEPOSIT_INVENTORY_WIDGET - Static variable in class privbot.hooks.bank.BankSession
-
Packed widget id of the Deposit inventory button on Orion, Roat Pkz and SpawnPK.
- deposit1(int) - Method in class privbot.hooks.Bank
-
Deposit 1 of the given item id from inventory.
- depositAll(int) - Method in class privbot.hooks.Bank
-
Deposit all stacks of the given item id from inventory into the bank.
- depositAll(String) - Method in class privbot.hooks.Bank
-
Deposit all stacks of the first inventory slot matching the given display name.
- depositAllOutcome(int) - Method in class privbot.hooks.Bank
-
Bank.depositAll(int)with an explicit outcome. - depositAllOutcome(String) - Method in class privbot.hooks.Bank
-
Bank.depositAll(String)with an explicit outcome. - depositEquipment() - Method in class privbot.hooks.Bank
-
Deposits all worn equipment using the "Deposit worn items" bank button.
- depositEquipmentOutcome() - Method in class privbot.hooks.Bank
-
Bank.depositEquipment()with an explicit outcome. - depositFirst() - Method in class privbot.mechanics.RestockTarget
- depositFirst(boolean) - Method in class privbot.mechanics.RestockTarget.Builder
- depositInventory() - Method in class privbot.hooks.Bank
-
Deposits all items currently in inventory using the "Deposit inventory" bank button.
- depositInventoryOutcome() - Method in class privbot.hooks.Bank
-
Bank.depositInventory()with an explicit outcome. - depositItem(int, int) - Method in class privbot.hooks.Bank
-
Deposits one inventory stack from
slot(same menu shape as legacy bank deposit-by-slot). - describe(GameThreadPolicy, boolean, boolean, boolean) - Static method in class privbot.context.GameThreadRouting
-
A short name for what
policyamounts to for a copy in this state; for the log. - describePolicy() - Static method in class privbot.context.GameThread
-
What the policy amounts to right now, e.g.
- description - Variable in class privbot.ui.fx.FxConfigPageBuilder.SectionRef
-
The section description (may be empty); the studio shows it as the page subtitle.
- destination() - Method in class privbot.movement.pathing.ExactStepHandle
- Destination - Class in privbot.mechanics
-
A place to travel to: a name, a tile, how close counts as "there", and optionally a teleport to try first.
- detach() - Method in class privbot.ui.PluginUi
-
Remove the navigation button and stop the panel's timers; safe to call twice.
- detail() - Method in class privbot.mechanics.PvpArbiter.Action
- dharokMultiplier(Integer) - Static method in class privbot.mechanics.KnockoutMath
-
Dharok's set multiplier at a readable wielder HP percentage; unknown or out-of-range is null.
- dialogue - Variable in class privbot.context.PrivContext
-
Chat dialogues: continue, options and dialogue text.
- dialogue - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.dialogue. - Dialogue - Class in privbot.hooks
-
Dialogue state inspection and interaction.
- DIALOGUE_CONTINUE - Enum constant in enum privbot.api.Capability
- DIALOGUE_OPTION - Enum constant in enum privbot.api.Capability
- Dialogue.DialogueText - Class in privbot.hooks
-
A dialogue read: the root widget id it came from, plus the stitched, normalised text.
- DialogueText(int, String) - Constructor for class privbot.hooks.Dialogue.DialogueText
- didLastTickBlock() - Method in class privbot.task.StagedTaskRunner
-
The last executed node's return value; false on an idle tick.
- didLastTickBlock() - Method in class privbot.task.TaskNodeRunner
-
Returns whether the last tick resulted in a blocking action.
- diedAt() - Method in class privbot.mechanics.DeathWatch
- diedAtTick() - Method in class privbot.mechanics.DeathWatch
- disable() - Method in class privbot.ui.overlay.OverlayMoveMode
-
Turns move mode off and saves any move not saved yet.
- DISARM - Enum constant in enum privbot.mechanics.PvpArbiter.Kind
- DISARM - Enum constant in enum privbot.mechanics.SpecialAttackPolicy.Phase
- dispatch - Variable in class privbot.actions.confirm.ActionSnapshot
- dispatchCap - Variable in class privbot.mechanics.PvpArbiter.Context
- dispatched() - Method in class privbot.api.Outcome
-
True only for
Outcome.Status.DISPATCHED. - DISPATCHED - Enum constant in enum privbot.api.Outcome.Status
-
The action was sent to the game.
- DISPATCHED - Enum constant in enum privbot.hooks.Magic.CastOutcome
-
The invoker sent the target click (SENT or PENDING).
- dispatchEvent(AWTEvent) - Method in class privbot.ui.overlay.OverlayMoveEventFilter
- dispatchKeyEvent(KeyEvent) - Method in class privbot.hooks.Hotkeys
- dispatchStatus() - Method in class privbot.actions.confirm.ActionHandle
- DispatchStatus - Enum in privbot.actions.confirm
-
Dispatch acknowledgement is independent of the resulting game state.
- displayName() - Method in enum privbot.api.ServerId
-
The canonical name:
Impact,Elorin,Orion,SpawnPK,Roat Pkz. - dispose() - Method in class privbot.ui.fx.FxStudioShell
-
External teardown (e.g.
- dispose() - Method in class privbot.ui.PrivBotFrame
-
Stops the refresh timer, then disposes the frame.
- distance - Variable in class privbot.mechanics.OpponentLockPolicy.Candidate
- distance(WorldPoint) - Method in class privbot.mechanics.Destination
- distanceTo(WorldPoint) - Method in class privbot.wrappers.PrivGroundItem
-
Tile-step distance to
p. - distanceTo(WorldPoint) - Method in class privbot.wrappers.PrivNPC
-
Tile-step distance from this NPC to
p. - distanceTo(WorldPoint) - Method in class privbot.wrappers.PrivObject
-
Tile-step (Chebyshev) distance to
p, ignoring the plane (see the note in the body);Double.MAX_VALUEwhen either location is unknown. - distanceTo(WorldPoint) - Method in class privbot.wrappers.PrivPlayer
-
Tile-step distance to
p. - divider() - Method in class privbot.ui.overlay.Rows
-
A thin spacer between groups of rows.
- DONE - Enum constant in enum privbot.mechanics.JobState
- DONE - Enum constant in enum privbot.mechanics.SwitchCheck.State
- doseFamily() - Method in class privbot.mechanics.GearSetup.Entry
- drain() - Method in class privbot.hooks.Hotkeys
- draw(Graphics2D, String, float, float, Font) - Static method in class privbot.ui.overlay.FallbackText
-
Draws
swith its baseline at (x,y) inprimary, falling back per character run. - draw(Supplier<S>, BiConsumer<SceneCanvas, S>) - Method in class privbot.ui.overlay.PrivBotOverlays.SceneBuilder
-
The terminal step: the scene drawn from
stateon every render. - draw(SceneCanvas, S) - Method in class privbot.ui.overlay.PrivBotSceneOverlay
-
Draw this render's scene; called only with a non-null state.
- drawBrandHeader(Graphics2D, String, String, int, int) - Static method in class privbot.ui.overlay.PrivBotChatboxOverlayComponents
- drawBrandHeader(Graphics2D, String, String, int, int, Image) - Static method in class privbot.ui.overlay.PrivBotChatboxOverlayComponents
-
Draws a branded header with optional plugin icon.
- drawBrandHeader(Graphics2D, String, String, int, int, Image, int) - Static method in class privbot.ui.overlay.PrivBotChatboxOverlayComponents
-
Same as
PrivBotChatboxOverlayComponents.drawBrandHeader(Graphics2D, String, String, int, int, Image)but allows a customiconSizewheniconis non-null. - drawCenteredDualIconHeader(Graphics2D, String, int, int, int, Image, int) - Static method in class privbot.ui.overlay.PrivBotChatboxOverlayComponents
-
Draws a centered header with the same icon on left and right of the title.
- drawIcon(Graphics2D, String, int, int, int, Color) - Static method in class privbot.ui.ModernTheme
-
Draw a simple vector icon using Graphics2D.
- drawKeyValue(Graphics2D, String, String, int, int, int, Color) - Static method in class privbot.ui.overlay.PrivBotChatboxOverlayComponents
-
Draws
key:and its value on one baseline, the value clipped with an ellipsis to fit. - drawKeyValueWrapped(Graphics2D, String, String, int, int, int, Color, int) - Static method in class privbot.ui.overlay.PrivBotChatboxOverlayComponents
-
Like
PrivBotChatboxOverlayComponents.drawKeyValue(java.awt.Graphics2D, java.lang.String, java.lang.String, int, int, int, java.awt.Color)but word-wraps the value over up tomaxLineslines. - drawnRoots() - Method in class privbot.hooks.Widgets
-
The interface roots the client is drawing, or null where this server cannot say.
- drawnStock() - Method in class privbot.hooks.shop.ShopInterface
-
ShopInterface.currentStock()limited to the containers the client confirms are drawn (the client reports them drawn): what the shop learner records, so a live-but-hidden panel is never learned as stock. - drawOneRow(Graphics2D, PrivBotChatboxOverlayLayout.MetricRow, int, int, int) - Static method in class privbot.ui.overlay.PrivBotChatboxOverlayLayout
-
Draws a single metric row and returns the y position after the row.
- drawSingleColumn(Graphics2D, List<PrivBotChatboxOverlayLayout.MetricRow>, int, int, int, int) - Static method in class privbot.ui.overlay.PrivBotChatboxOverlayLayout
-
Draws up to
maxRowsrows in one column starting at baselinestartY. - drawTwoColumns(Graphics2D, List<PrivBotChatboxOverlayLayout.MetricRow>, List<PrivBotChatboxOverlayLayout.MetricRow>, int, int, int, int) - Static method in class privbot.ui.overlay.PrivBotChatboxOverlayLayout
-
Draws two columns side by side, row by row; each row pair advances to the taller of the two.
- drink() - Method in class privbot.wrappers.PrivItem
-
Drinks this inventory item using its
Drinkmenu option. - drink(String...) - Method in class privbot.hooks.Inventory
-
Drinks the first inventory item matching any supplied name.
- DRINK - Enum constant in enum privbot.mechanics.PvpArbiter.Kind
- drinkFirst(String...) - Method in class privbot.hooks.Inventory
-
Drinks the first inventory item matching any supplied name.
- DrinkProof - Class in privbot.mechanics
-
Observes a potion-family dose total before and after an accepted drink.
- DrinkProof.State - Enum in privbot.mechanics
- drop(String...) - Method in class privbot.hooks.Inventory
-
Drops the first inventory item matching any supplied name.
- dropAll(String...) - Method in class privbot.hooks.Inventory
-
Drops every carried item matching
names, one dispatch per slot. - dropAllExcept(int...) - Method in class privbot.hooks.Inventory
-
Drops every carried item whose id is not in
keepIds; does nothing for an empty keep list. - dropAllExcept(String...) - Method in class privbot.hooks.Inventory
-
Drops every carried item whose name is not in
keepNames; does nothing for an empty keep list. - dropEverything() - Method in class privbot.hooks.Inventory
-
Drops every carried item, keeping nothing.
- droppedTerminalCount() - Method in class privbot.actions.confirm.ActionTracker
-
Overflow is observable; old terminal snapshots may be dropped, never changed into success.
- due(int, long) - Method in class privbot.mechanics.BoostDosePolicy
- dueTick() - Method in class privbot.mechanics.EatDeferral.Decision
- dumpDiagnostics() - Method in class privbot.hooks.shop.ShopInterface
-
Prints every item-bearing container the client holds.
E
- earliestTick() - Method in class privbot.mechanics.SpecWatch.Result
- eat() - Method in class privbot.wrappers.PrivItem
-
Eats this inventory item using its
Eatmenu option. - eat(String...) - Method in class privbot.hooks.Inventory
-
Eats the first inventory item matching any supplied name.
- EAT - Enum constant in enum privbot.mechanics.EatDeferral.Choice
- EAT - Enum constant in enum privbot.mechanics.SustainChoice.Kind
- EAT_ACTION - Static variable in class privbot.hooks.InventoryFoodQueries
-
The menu action that marks an item as food.
- EAT_ATTACK_DELAY_TICKS - Static variable in class privbot.mechanics.AttackTiming
- eatAtPercent - Variable in class privbot.mechanics.ConsumePlanner.Settings
- eatBelowPct(int) - Method in class privbot.mechanics.SustainPlan.Builder
-
Eat when HP is below this percent of max HP (0 turns eating off).
- eatCost(int, int, Integer) - Static method in class privbot.mechanics.AttackTiming
-
Attack ticks lost to an eat processed at
processedTick; a separate hold may absorb the delay. - eatDeadline() - Method in class privbot.mechanics.KnockoutRisk.Assessment
- EatDeferral - Class in privbot.mechanics
-
Bounded non-critical food timing.
- EatDeferral.Choice - Enum in privbot.mechanics
- EatDeferral.Decision - Class in privbot.mechanics
- eatDue() - Method in class privbot.mechanics.KnockoutRisk.Assessment
- eatFirst(String...) - Method in class privbot.hooks.Inventory
-
Eats the first inventory item matching any supplied name.
- eatFood() - Method in class privbot.hooks.Inventory
-
Eats the first inventory item with an
Eataction. - eatLanded(int, String) - Method in class privbot.mechanics.AttackHistory
-
Record a food consumption proved by a fresh inventory read; repeated reports for an item and tick count once.
- eatLanded(int, String) - Method in class privbot.mechanics.OwnAttackClock
-
Record an eat only after a fresh inventory read proves it landed.
- eatsSinceFire() - Method in class privbot.mechanics.AttackHistory
- EDGE - Static variable in class privbot.ui.overlay.OverlayPlacement
-
Gap between a corner-anchored panel and the canvas edge.
- EDT_MARSHAL - Enum constant in enum privbot.context.GameThreadPolicy
-
Inline on the client thread, the game thread and the EDT; anything else marshals onto the EDT.
- EDT_MARSHAL - Enum constant in enum privbot.context.GameThreadRouting.Route
-
EventQueue.invokeAndWait. - edtMarshalServer() - Method in interface privbot.context.GameThreadRouting.Facts
-
The server has no independently pumped
ClientThread(Impact, Elorin). - EffectObservation - Class in privbot.effects
-
Immutable effect evidence at the instant observe() was called.
- EffectObservation.Source - Enum in privbot.effects
- EffectObservation.State - Enum in privbot.effects
- effects - Variable in class privbot.context.PrivContext
-
Creates plugin-owned effect trackers; event forwarding stays with the plugin lifecycle.
- effects - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.effects. - effects() - Method in class privbot.hooks.Pvp
-
A new Freeze / Vengeance / Tele Block tracker using the historical Elorin cue set.
- Effects - Class in privbot.hooks
-
Creates independent, memory-only effect trackers for a plugin's lifetime.
- EffectTracker - Class in privbot.effects
-
Per-plugin effect bookkeeping.
- EffectTracker.TimerView - Class in privbot.effects
-
Source-compatible live local timer; restarting preserves the object's identity.
- elorin() - Static method in class privbot.restock.RestockRoute
-
Elorin (live since 2026-09-29): "Home teleport" lands within 12 tiles of (3088,3504); the "Healing font" restores with "Drink-from"; "Last-preset" on a Bank booth / Bank chest (else a Banker) reloads the last preset; "Previous" on the teleport widget 20305 returns to the last teleport destination.
- ELORIN - Enum constant in enum privbot.api.ServerId
- ELORIN_DHAROK - Enum constant in enum privbot.mechanics.ConsumeTiming.Mode
- ElorinPvpCues - Class in privbot.mechanics
-
Historical Elorin PvP capture cues copied from the flagship's September 2026 tables.
- EMBER - Enum constant in enum privbot.ui.overlay.PaletteSettings.Scheme
- EMERGENCY_OVERRIDE - Static variable in class privbot.task.TaskPriorityBands
-
Fleet-wide emergency workflows that must preempt death recovery and all normal gameplay.
- EmergencyConsume - Class in privbot.mechanics
-
Pure emergency consume selection.
- EmergencyConsume.Action - Class in privbot.mechanics
- EmergencyConsume.Decision - Class in privbot.mechanics
- emergencyPercent - Variable in class privbot.mechanics.ConsumePlanner.Settings
- empty() - Static method in class privbot.hooks.VarRegistry
- empty() - Static method in class privbot.mechanics.Commitment
- empty() - Method in class privbot.query.GraphicsObjectQuery
-
True when no entry is left.
- empty() - Method in class privbot.query.GroundItemQuery
-
True when no entry is left.
- empty() - Method in class privbot.query.ItemQuery
-
True when no row is left.
- empty() - Method in class privbot.query.NPCQuery
-
True when no entry is left.
- empty() - Method in class privbot.query.ObjectQuery
-
True when no entry is left.
- empty() - Method in class privbot.query.WidgetQuery
-
True when no widget is left.
- empty() - Static method in class privbot.ui.overlay.Snapshot
-
A snapshot with nothing published yet; overlays reading it draw nothing until the first publish.
- EMPTY_STATE - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for an empty-state message.
- emptySlots() - Method in class privbot.hooks.Inventory
-
Count of unoccupied inventory slots (max 28).
- enable(String) - Method in class privbot.ui.overlay.OverlayMoveMode
-
Turns move mode on for
flowId's panel, or for every panel when it is null. - enabled - Variable in class privbot.mechanics.SpecialAttackPolicy.State
- enabled() - Method in class privbot.mechanics.PrayerToggleGuard.Toggle
- endCycle - Variable in class privbot.hooks.Events.ProjectileEvent
-
Client cycle it lands on.
- endCycle() - Method in class privbot.mechanics.ShotView
- energy - Variable in class privbot.mechanics.SpecialAttackPolicy.State
- ensure(Supplier<T>) - Static method in class privbot.context.GameThread
-
Runs
fnon the client thread and returns the result. - ensure(Supplier<T>, T) - Static method in class privbot.context.GameThread
-
GameThread.ensure(Supplier)with an answer for when the read cannot be served. - ensure(GameThreadPolicy, GameThreadRouting.Facts) - Static method in class privbot.context.GameThreadRouting
- entries() - Method in class privbot.mechanics.GearSetup
- Entry(int, String, int, int, int, GearSetup.Role, String) - Constructor for class privbot.mechanics.GearSetup.Entry
- Entry(String, VarRegistry.Kind, int, String) - Constructor for class privbot.hooks.VarRegistry.Entry
- episode - Variable in class privbot.mechanics.Commitment
-
The fixed-plan episode running on top of it, and the tick it started.
- episodeAge - Variable in class privbot.mechanics.SpecialAttackPolicy.State
- episodeOf(String) - Static method in class privbot.mechanics.Commitment
-
The fixed-plan episode a commit set names, or null for a style set.
- episodeSince - Variable in class privbot.mechanics.Commitment
- equals(Object) - Method in class privbot.api.ApiVersion
- equals(Object) - Method in class privbot.api.Observed
- equals(Object) - Method in class privbot.api.Outcome
- equals(Object) - Method in class privbot.config.ConfigMigration.Change
- equals(Object) - Method in class privbot.mechanics.GearSetup.Entry
- equals(Object) - Method in class privbot.mechanics.GearSetup
- equals(Object) - Method in class privbot.mechanics.GraphicView
- equals(Object) - Method in class privbot.mechanics.NpcView
- equals(Object) - Method in class privbot.mechanics.PrayerToggleGuard.Toggle
- equip(int) - Method in class privbot.hooks.Loadouts
-
Deprecated.an Impact-only preset press with no proof; use
Loadouts.equip(GearSetup), which works on every server and proves each worn slot - equip(CombatStyle, StylePlanner.GearPick) - Static method in class privbot.mechanics.PvpArbiter.Action
-
Construct a gear proposal retaining the carried item and intended equipment slot.
- equip(GearSetup) - Method in class privbot.hooks.Loadouts
-
Starts a job that puts on every missing worn piece of
worn, one proved piece per step (at most one click, then up to 1800 ms waiting for that piece's slot to hold its item). - EQUIP - Enum constant in enum privbot.mechanics.KnockoutWeaponDecision.Kind
- EQUIP - Enum constant in enum privbot.mechanics.PvpArbiter.Kind
- equipment - Variable in class privbot.context.PrivContext
-
Worn items: snapshots, queries and counts.
- equipment - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.equipment. - equipment() - Method in class privbot.mechanics.FightFrame
- Equipment - Class in privbot.hooks
-
Worn equipment:
ctx.equipment. - EQUIPMENT - Enum constant in enum privbot.query.ItemContainerKind
-
Worn items.
- EQUIPMENT_INTERACT - Enum constant in enum privbot.api.Capability
- EQUIPMENT_READ - Enum constant in enum privbot.api.Capability
- equipmentSlot() - Method in class privbot.mechanics.PvpArbiter.Action
-
Intended equipment slot for a planned gear switch, or null on other actions.
- ERROR - Enum constant in enum privbot.ui.PanelStatus
-
Stopped or stuck on a failure.
- escape(Destination, Destination, WildernessModel, int) - Method in class privbot.hooks.Pvp
-
Create a cancellable escape job to a caller-verified safe destination.
- ESTIMATED_EXPIRY - Enum constant in enum privbot.effects.EffectObservation.Source
-
A previously started estimate reached its strict expiry boundary.
- estimatedReady(Integer, CombatStyle, String, Integer, Map<String, Integer>) - Static method in class privbot.mechanics.AttackTiming
-
The estimated next fire tick, or null if the fire, style, or eat count is unreadable.
- estimatedReady(Map<String, Integer>) - Method in class privbot.mechanics.AttackHistory
-
Estimated next attack fire, or null when the required observations are missing.
- estimatedReady(Map<String, Integer>) - Method in class privbot.mechanics.OwnAttackClock
-
Null after an unreadable sample until a fresh fire re-establishes the timer.
- event() - Method in class privbot.mechanics.OpponentLockPolicy.Result
- event(String, Map<String, Object>) - Method in class privbot.hooks.Capture
-
Appends one named event to the
eventsstream. - event(String, Map<String, Object>) - Method in interface privbot.restock.RestockHost
-
A capture row.
- events - Variable in class privbot.context.PrivContext
-
Polling-backed typed events (projectile, hitsplat, animation, local death, graphic, var, chat).
- events - Variable in class privbot.task.PrivTaskContext
-
Mirrors
PrivContext.events. - Events - Class in privbot.hooks
-
Typed game events for plugins, backed by POLLING:
ctx.events. - Events(Events.Source) - Constructor for class privbot.hooks.Events
-
The facade over any
Events.Source: tests, the API test kit, or a recorded session. - Events.AnimationEvent - Class in privbot.hooks
-
An animation change on the local player or an NPC.
- Events.ChatEvent - Class in privbot.hooks
-
A chat line that arrived since the previous tick.
- Events.DeathEvent - Class in privbot.hooks
-
The local player died.
- Events.Frame - Class in privbot.hooks
-
Everything one poll observed.
- Events.Frame.Builder - Class in privbot.hooks
-
Builds a
Events.Frame; every part defaults to "not read". - Events.GraphicEvent - Class in privbot.hooks
-
A graphics object (spot animation in the scene) that appeared since the previous tick.
- Events.GraphicSeen - Class in privbot.hooks
-
One graphics object as read on a tick.
- Events.HitsplatEvent - Class in privbot.hooks
-
A hitsplat that landed since the previous tick.
- Events.Needs - Class in privbot.hooks
-
What one poll should read; anything not needed is skipped so an idle facade costs nothing.
- Events.NpcAnimation - Class in privbot.hooks
-
One NPC's animation as read on a tick.
- Events.ProjectileEvent - Class in privbot.hooks
-
A projectile that appeared since the previous tick.
- Events.ProjectileSeen - Class in privbot.hooks
-
One projectile as read on a tick.
- Events.Source - Interface in privbot.hooks
-
Reads one
Events.Frame. - Events.Subscription - Interface in privbot.hooks
-
A registered listener;
Events.Subscription.cancel()(or close) removes it. - Events.VarChange - Class in privbot.hooks
-
A watched varp or varbit changed between two readable ticks.
- EXACT - Enum constant in enum privbot.hooks.Widgets.MatchMode
- exactStep(WorldPoint, BooleanSupplier, long) - Method in class privbot.hooks.Travel
-
Dispatch once and prove the identical X/Y/plane; call poll on the worker and cancel on stop.
- exactStep(WorldPoint, BooleanSupplier, long, ActionTracker) - Method in class privbot.hooks.Travel
-
Share the caller's confirmation lifecycle; this creates no second proof or polling loop.
- ExactStepHandle - Class in privbot.movement.pathing
-
One exact-tile dispatch followed by caller-driven arrival proof; never plans or retries a route.
- ExactStepHandle.Driver - Interface in privbot.movement.pathing
-
The facade supplies the correct client-thread dispatch/read boundary.
- excludeHintArrow() - Method in class privbot.query.NPCQuery
-
Keeps NPCs that are NOT the hint arrow target (inverse of
NPCQuery.hintArrowOnly()). - excludeLocal() - Method in interface privbot.query.PlayerSearch
- excludeMislabelledZero - Variable in class privbot.mechanics.PvpFightHistory.Inputs
- execute(C) - Method in class privbot.task.CompositeTaskNode
-
CompositeTaskNode.Strategy.PRIORITY: runs the highest-priority enabled child that validates; if it throws, the next candidate is tried. - execute(C) - Method in class privbot.task.Parent
-
Executes the child remembered by
Parent.shouldExecute(C)(or selects one again when called without it) and returns that child's result. - execute(C) - Method in interface privbot.task.TaskNode
-
Executes the task's main logic.
- executeNode(TaskNode<C>) - Method in class privbot.task.TaskNodeRunner
-
Executes a previously selected node.
- execution(String, String, boolean, long, Throwable) - Method in interface privbot.task.TaskTraceListener
-
A node's
executestarted or finished. - exists() - Method in class privbot.wrappers.PrivGroundItem
-
Whether this stack still appears on its tile (same id and quantity).
- exists() - Method in class privbot.wrappers.PrivItem
-
True if this slot still holds the same item id and quantity in the live container snapshot from the client.
- exists() - Method in class privbot.wrappers.PrivNPC
-
True if this NPC instance is still the live entry at
NPC.getIndex(). - exists() - Method in class privbot.wrappers.PrivObject
-
True if a scene object with the same id still exists at this tile (refreshed scan).
- exists() - Method in class privbot.wrappers.PrivPlayer
-
True if this
Playerinstance is still inClient.getPlayers(). - exists(String) - Method in class privbot.hooks.Workflows
-
Returns true if a workflow with the given name exists.
- exists(String) - Static method in class privbot.ui.overlay.OverlayIcons
-
True when
idis in the bundled icon index. - exists(String...) - Method in class privbot.hooks.GameObjects
-
Whether an object matching any of the supplied names is currently loaded.
- exists(String...) - Method in class privbot.hooks.GroundItems
-
Whether a ground item matching any supplied name is currently loaded.
- exists(String...) - Method in class privbot.hooks.NPCs
-
Whether an NPC matching any of the supplied names is currently loaded.
- exists(String...) - Method in class privbot.hooks.PlayersHook
-
Whether another player matching any of the supplied names is currently loaded.
- expandDescendants(int) - Method in class privbot.query.WidgetQuery
-
Repeats
WidgetQuery.expandImmediateChildren()maxRoundstimes, accumulating all widgets up to that many levels below the current set (deduplicated by identity). - expandImmediateChildren() - Method in class privbot.query.WidgetQuery
-
For each current widget, appends all immediate children (same child discovery as the dialogue hook's tree walks: dynamic, static, nested, and
Widget.getChildren()), preserving order and deduplicating by identity. - expectChange - Variable in class privbot.hooks.Restock.Request
-
Impact: the inventory is known not to be the preset yet, so an unchanged press is a failure.
- expectChange(boolean) - Method in class privbot.hooks.Restock.Builder
- expectedEnd(int, int) - Static method in class privbot.mechanics.FreezeClock
-
The first tick the freeze no longer holds them:
start + ceil(seconds * 10 / 6)(a tick is 0.6 s). - expired(int) - Method in class privbot.mechanics.BoostDosePolicy
- EXPIRED - Enum constant in enum privbot.mechanics.FreezeClock.Move
-
At or after
expectedEnd - FREEZE_EXPIRY_EARLY_TICKS: it ran out, and immunity follows. - expiresNow - Variable in class privbot.mechanics.PvpArbiter.Context
- expiresNow(int, Integer, Integer, Integer, Boolean) - Static method in class privbot.mechanics.AttackTiming
-
Whether this sample is the first past the deadline, including when samples skip ticks; null if unknown.
- extras() - Method in class privbot.mechanics.SetupDiff
F
- facing(int) - Method in class privbot.mechanics.Commitment
-
The commitment as a decision on a state against
opponentIdreads it: the same one, or nothing when that is a different opponent from the one it belongs to (a new fight; -1 is no opponent, which is a one-tick blip and keeps it). - fail(String, long) - Method in class privbot.restock.RestockCycle
-
The current stage's confirmation failed.
- failed() - Method in class privbot.mechanics.SwitchResult
- failed(String) - Static method in class privbot.api.Outcome
- failed(String, String) - Static method in class privbot.mechanics.SustainOutcome
-
An item was chosen but not shown to be consumed.
- FAILED - Enum constant in enum privbot.api.Outcome.Status
-
Sending was attempted and threw or failed.
- FAILED - Enum constant in enum privbot.hooks.Magic.CastOutcome
-
The invoker attempted the target click and it errored.
- FAILED - Enum constant in enum privbot.mechanics.JobState
- FAILED - Enum constant in enum privbot.mechanics.SustainOutcome.Kind
- FAILED - Enum constant in enum privbot.mechanics.SwitchCheck.State
- FAILED - Enum constant in enum privbot.movement.pathing.NavigationSession.Result
- FAILED - Enum constant in enum privbot.restock.GroundLoot.Outcome
- failures() - Method in class privbot.mechanics.SwitchCheck
- failures() - Method in class privbot.restock.RestockCycle
- FallbackText - Class in privbot.ui.overlay
-
Text drawn in runs, so characters the chosen font has no glyph for (an emoji, a pickaxe) are drawn in "Segoe UI Emoji", then "Dialog", at the same size and style instead of as a missing-glyph box.
- family() - Method in class privbot.mechanics.AttackFireDetector.Result
- fight(PvpQuery, ThreatQuery) - Method in class privbot.hooks.Pvp
-
Collects the local player, opponents, threats, containers and spec orb within one client-thread callback.
- FightFrame - Class in privbot.mechanics
-
Detached observations for one PvP decision.
- FightFrame(int, PvpSnapshot, ThreatSnapshot, ItemContainerSnapshot, ItemContainerSnapshot, Boolean) - Constructor for class privbot.mechanics.FightFrame
-
The snapshots must correspond to
tick; unavailable or structurally invalid containers are represented as null. - FightFrame(int, PvpSnapshot, ThreatSnapshot, ItemContainerSnapshot, ItemContainerSnapshot, Boolean, CombatLevels) - Constructor for class privbot.mechanics.FightFrame
-
As above, with combat levels collected for this decision; individual levels may be null.
- FightObservation - Class in privbot.mechanics
-
One fight frame plus newly observed local hits and graphics from the same client-thread batch.
- FightObservation(FightFrame, List<ThreatMemory.Hit>, List<FightObservation.Graphic>) - Constructor for class privbot.mechanics.FightObservation
- FightObservation(FightFrame, List<ThreatMemory.Hit>, List<FightObservation.Graphic>, NpcAttackerEvidence) - Constructor for class privbot.mechanics.FightObservation
-
Adds a same-batch bounded NPC scan; null means it was unavailable.
- FightObservation(FightFrame, List<ThreatMemory.Hit>, List<FightObservation.Graphic>, NpcAttackerEvidence, PvpSnapshot) - Constructor for class privbot.mechanics.FightObservation
-
Adds an unfiltered, same-batch player snapshot for bounded attacker analysis.
- FightObservation.Graphic - Class in privbot.mechanics
- fightObserver(PvpQuery, ThreatQuery) - Method in class privbot.hooks.Pvp
-
A single-owner observer for one fight.
- filter(Predicate<? super T>) - Method in class privbot.api.Observed
-
Keeps a VALUE that matches
test; a VALUE that does not becomes ABSENT. - filter(Predicate<GraphicsObject>) - Method in class privbot.query.GraphicsObjectQuery
-
Narrows this query in place and returns it.
- filter(Predicate<Player>) - Method in interface privbot.query.PlayerSearch
- filter(Predicate<Widget>) - Method in class privbot.query.WidgetQuery
-
Narrows this query in place and returns it.
- filter(Predicate<PrivGroundItem>) - Method in class privbot.query.GroundItemQuery
-
Narrows this query in place and returns it.
- filter(Predicate<PrivItem>) - Method in class privbot.query.ItemQuery
-
Narrows this query in place and returns it.
- filter(Predicate<PrivNPC>) - Method in class privbot.query.NPCQuery
-
Narrows this query in place and returns it.
- filter(Predicate<PrivObject>) - Method in class privbot.query.ObjectQuery
-
Narrows this query in place and returns it.
- FilterChip(String, boolean) - Constructor for class privbot.ui.ModernTheme.FilterChip
- find(int) - Method in class privbot.mechanics.ThreatSnapshot
- find(String) - Method in class privbot.hooks.VarRegistry
- find(String) - Method in class privbot.hooks.Widgets
- find(String) - Method in class privbot.mechanics.PvpSnapshot
- find(String, Widgets.MatchMode) - Method in class privbot.hooks.Widgets
- find(Predicate<PrivItem>) - Static method in class privbot.hooks.Bank
-
Static lookup through the process-wide adapter; prefer
ctx.bank.get(pred). - find(Predicate<PrivItem>) - Static method in class privbot.hooks.Equipment
-
Static lookup that needs no
ctx; preferctx.equipment.get(pred). - find(Predicate<PrivItem>) - Static method in class privbot.hooks.Inventory
-
Static lookup that needs no
ctx; preferctx.inventory.get(pred). - findStockSlot(String, boolean) - Method in class privbot.hooks.shop.ShopInterface
-
Finds the stock slot holding
itemName. - fingerprint(ItemContainerSnapshot, ItemContainerSnapshot) - Static method in class privbot.restock.RestockRunner
- fingerprint(PrivTaskContext) - Static method in class privbot.restock.RestockRunner
-
The worn and carried items as one comparable string; null when either is unreadable.
- finished() - Method in enum privbot.mechanics.JobState
-
True for every state except RUNNING.
- finisherTrigger(Integer, int, Integer, int) - Static method in class privbot.mechanics.KnockoutWeaponDecision
-
Finisher fallback: an observed low opponent and insufficient energy for the primary special.
- fire(int, AttackHistory.Family, CombatStyle, String) - Method in class privbot.mechanics.AttackHistory
-
Record a confirmed fire.
- FIRE - Enum constant in enum privbot.mechanics.AttackFireDetector.Status
- fired(int, boolean, boolean, int, boolean, boolean) - Static method in class privbot.mechanics.SpecEnergy
-
What happened between the previous reading (
prev*) and this one. - FIRED - Enum constant in enum privbot.mechanics.SpecEnergy.Fired
- FIRED - Enum constant in enum privbot.mechanics.SpecWatch.Status
- firedStyle() - Method in class privbot.mechanics.AttackHistory
-
Style of the last confirmed fire, or null when it could not be classified.
- firedThisTick - Variable in class privbot.mechanics.SpecialAttackPolicy.State
- firedTick() - Method in class privbot.mechanics.AttackHistory
- first() - Method in class privbot.query.GraphicsObjectQuery
-
The first remaining entry in snapshot order, or null when the query is empty.
- first() - Method in class privbot.query.GroundItemQuery
-
The first remaining entry in snapshot order, or null when the query is empty.
- first() - Method in class privbot.query.ItemQuery
-
The first remaining row (lowest slot first unless sorted), or null when empty.
- first() - Method in class privbot.query.NPCQuery
-
The first remaining entry in snapshot order, or null when the query is empty.
- first() - Method in class privbot.query.ObjectQuery
-
The first remaining entry in snapshot order, or null when the query is empty.
- first() - Method in interface privbot.query.PlayerSearch
- first() - Method in class privbot.query.WidgetQuery
-
The first remaining widget, or null when the query is empty.
- first(String) - Method in class privbot.hooks.container.ItemContainerSnapshot
-
Exact name first, then a case-insensitive substring match.
- first(String...) - Method in class privbot.hooks.Inventory
-
First inventory item matching any supplied name, or
null. - first(Predicate<GraphicsObject>) - Method in class privbot.query.GraphicsObjectQuery
-
Narrows by
predicate(in place) and returns the first match, or null. - first(Predicate<Player>) - Method in interface privbot.query.PlayerSearch
- first(Predicate<Widget>) - Method in class privbot.query.WidgetQuery
-
Narrows by
predicate(in place) and returns the first match, or null. - first(Predicate<ItemContainerSnapshot.Item>) - Method in class privbot.hooks.container.ItemContainerSnapshot
- first(Predicate<PrivItem>) - Method in class privbot.hooks.Bank
-
Same as
Bank.get(Predicate). - first(Predicate<PrivItem>) - Method in class privbot.hooks.Equipment
-
Same as
Equipment.get(Predicate). - first(Predicate<PrivItem>) - Method in class privbot.hooks.Inventory
-
Same as
Inventory.get(Predicate); Scar-style name. - first(Predicate<PrivItem>) - Method in class privbot.query.ItemQuery
-
First slot matching
predwithout mutating the fluent chain’s prior filters incorrectly — uses a stream view. - first(Predicate<PrivNPC>) - Method in class privbot.query.NPCQuery
-
Narrows by
pred(in place) and returns the first match, or null. - first(Predicate<PrivObject>) - Method in class privbot.query.ObjectQuery
-
Narrows by
pred(in place) and returns the first match, or null. - FIRST_PARTY_CHANNEL - Static variable in class privbot.api.ApiVersion
-
The only hub channel on which a legacy plugin (no "Plugin-Api-Version") may load.
- firstByNamePatternsPreferEat(Inventory, String...) - Static method in class privbot.hooks.InventoryFoodQueries
-
The first carried item whose name contains one of
namePatterns, preferring items that listInventoryFoodQueries.EAT_ACTION(for servers whose item definitions report wrong actions); lowest potion dose, then lowest slot, first. - firstGameObjectAtSceneTile(Client, int, int) - Static method in class privbot.hooks.GameObjects.ToaRewardsRoomChest
- firstOf(String...) - Method in class privbot.hooks.container.ItemContainerSnapshot
- firstWithAction(String) - Method in class privbot.hooks.container.ItemContainerSnapshot
- firstWithEatAction(Inventory) - Static method in class privbot.hooks.InventoryFoodQueries
-
The first carried item (no placeholders) whose actions include
InventoryFoodQueries.EAT_ACTION. - fixed(Color) - Static method in class privbot.ui.overlay.ColorRamp
-
Always the same colour.
- flatMap(Function<? super T, Observed<R>>) - Method in class privbot.api.Observed
-
Chains a read that depends on this one.
- flick(String) - Method in class privbot.hooks.Prayer
-
Flicks the prayer with this in-game name: activates it, then deactivates it on the same tick, with no sleep between the two.
- FLOOR - Enum constant in enum privbot.mechanics.WildernessModel.Rounding
- fold(Function<? super T, ? extends R>, Supplier<? extends R>, Function<String, ? extends R>) - Method in class privbot.api.Observed
-
Folds the three answers into one value.
- followUp(int, Boolean, Integer, int, Integer, Boolean, Boolean, Boolean, Integer, Integer, Boolean) - Static method in class privbot.mechanics.GraniteMaulDecision
-
Follow a separately confirmed non-maul special within three ticks.
- FONT_BODY - Static variable in class privbot.ui.GearTheme
-
Body text (13 pt).
- FONT_BODY - Static variable in class privbot.ui.ModernTheme
-
Body text (13 pt).
- FONT_BODY_BOLD - Static variable in class privbot.ui.GearTheme
-
Bold body text (13 pt).
- FONT_BODY_BOLD - Static variable in class privbot.ui.ModernTheme
-
Bold body text and button labels (13 pt).
- FONT_CAPTION - Static variable in class privbot.ui.GearTheme
-
Captions (10 pt).
- FONT_DISPLAY - Static variable in class privbot.ui.GearTheme
-
Large display headings (22 pt bold).
- FONT_DISPLAY - Static variable in class privbot.ui.ModernTheme
-
Large display headings (24 pt bold).
- FONT_ICON - Static variable in class privbot.ui.ModernTheme
-
Emoji/icon glyphs (14 pt).
- FONT_MONO - Static variable in class privbot.ui.GearTheme
-
Monospaced values and logs (12 pt).
- FONT_MONO - Static variable in class privbot.ui.ModernTheme
-
Monospaced values and logs (12 pt).
- FONT_SMALL - Static variable in class privbot.ui.GearTheme
-
Small labels (11 pt).
- FONT_SMALL - Static variable in class privbot.ui.ModernTheme
-
Small labels (11 pt).
- FONT_SUBTITLE - Static variable in class privbot.ui.GearTheme
-
Subtitles (13 pt semibold).
- FONT_SUBTITLE - Static variable in class privbot.ui.ModernTheme
-
Subtitles and sidebar headers (14 pt semibold).
- FONT_TINY - Static variable in class privbot.ui.ModernTheme
-
Badges and section captions (10 pt).
- FONT_TITLE - Static variable in class privbot.ui.GearTheme
-
Section titles (16 pt).
- FONT_TITLE - Static variable in class privbot.ui.ModernTheme
-
Titles (18 pt semibold).
- fontAction - Variable in class privbot.restock.RestockRoute
- fontConfirmMs - Variable in class privbot.restock.RestockRoute
- fontName - Variable in class privbot.restock.RestockRoute
- food() - Method in class privbot.hooks.Inventory
-
First inventory item with an
Eataction, ornull. - food(ItemContainerSnapshot) - Static method in class privbot.restock.RestockSupplies
-
Items carried with an Eat action (stack quantities summed).
- FOOD - Enum constant in enum privbot.mechanics.ConsumeTiming.Kind
- FOOD - Enum constant in enum privbot.mechanics.GearSetup.Role
- FOOD - Enum constant in enum privbot.mechanics.PvpArbiter.Kind
- FoodProof - Class in privbot.mechanics
-
A bounded observation of one accepted food action, using a pre-send count and later detached inventory snapshots.
- FoodProof.State - Enum in privbot.mechanics
- foods - Variable in class privbot.mechanics.ConsumePlanner.Settings
- foods(String...) - Method in class privbot.mechanics.SustainPlan.Builder
-
Foods in preference order; each must carry the "Eat" action.
- footerText(String) - Method in class privbot.ui.fx.FxStudioShell.Builder
-
The note shown in the footer, e.g.
- Footprint - Class in privbot.mechanics
-
Square-footprint maths for big NPCs, on server tiles.
- forAll(int, boolean, boolean) - Static method in class privbot.hooks.bank.WithdrawCapacity
-
Capacity for an explicit "withdraw everything" request, which has no numeric target.
- forConfig(String, String, Config, ConfigManager) - Static method in class privbot.ui.fx.FxStudioShell
-
A complete studio for a plain
@ConfigItemconfig: one tab per@ConfigSection(a single Settings page when the config declares none), every control generated byFxConfigPageBuilderand writing live, standard size, and a single Done action. - forConfig(Config, ConfigManager) - Static method in class privbot.ui.fx.FxConfigPageBuilder
-
Builds one page containing every visible config item, with a sub-header per section.
- FOREST - Enum constant in enum privbot.ui.overlay.PaletteSettings.Scheme
- forgetOpponent(String) - Method in class privbot.mechanics.SpellEffects
-
Drops what is known about one opponent (a new fight).
- FORM_GRID - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for
FxFormKit.formGrid()grids. - format(Duration) - Static method in class privbot.context.Time
-
Formats a duration as
HH:mm:ss(absolute value; hours are not capped at 24). - formGrid() - Static method in class privbot.ui.fx.FxFormKit
-
An empty two-column label/field grid for
FxFormKit.addFormRow(javafx.scene.layout.GridPane, int, java.lang.String, javafx.scene.Node). - forObject(WorldPoint, int, String, String, Object...) - Static method in class privbot.hooks.TransportRequest
-
Direct object interaction at
targetPointplus widget path steps. - forObjectWithTimeouts(WorldPoint, int, String, String, long, long, Object...) - Static method in class privbot.hooks.TransportRequest
-
Like
TransportRequest.forObject(WorldPoint, int, String, String, Object...)with explicit navigation / widget interaction timeouts (e.g. - forSection(Config, ConfigManager, String) - Static method in class privbot.ui.fx.FxConfigPageBuilder
-
Builds a page for a single
@ConfigSection(items whosesection()matchessectionKey). - forward(Object) - Method in class privbot.hooks.Events
-
Feeds a RuneLite event the plugin received through
@Subscribe, for servers where polling cannot see it:HitsplatApplied(used only when this server's hitsplats are not polled) andChatMessage(de-duplicated against polled lines). - fraction(String, int, int, ColorRamp) - Method in class privbot.ui.overlay.Rows
-
value/maxcoloured byramp; an unknown max renders as"-". - fragments(String) - Static method in class privbot.restock.LootNames
-
The setting split on commas, semicolons and newlines, trimmed and lower-cased; blanks dropped.
- frame() - Method in class privbot.mechanics.FightObservation
- freeSlots(int) - Method in class privbot.hooks.container.ItemContainerSnapshot
- FREEZE - Enum constant in enum privbot.mechanics.Commitment.Episode
- FREEZE_BROKEN_GRACE_TICKS - Static variable in class privbot.mechanics.FreezeClock
-
A move this soon after the freeze graphic is the step already under way when it landed: the drawn tile trails the server tile by 0-1 ticks (from ElorinPvP).
- FREEZE_EXPIRY_EARLY_TICKS - Static variable in class privbot.mechanics.FreezeClock
-
A move this many ticks before the expected end, or later, is the freeze running out, not breaking: the drawn tile trails the server's, and the clock runs in plugin ticks (from ElorinPvP).
- FREEZE_IMMUNITY_TICKS - Static variable in class privbot.mechanics.SpellEffects
-
Ticks after a freeze ends during which a new freeze does not land.
- FREEZE_SECONDS_BY_GRAPHIC - Static variable in class privbot.mechanics.SpellEffects
-
Freeze hit graphics (OSRS ids) to the seconds each holds for: Ice Rush 361 5, Ice Burst 363 10, Ice Blitz 367 15, Ice Barrage 369 20; Bind 181 5, Snare 180 10, Entangle 179 15.
- FreezeClock - Class in privbot.mechanics
-
The clock of a freeze on an opponent: when it should end, whether a move of theirs ended it by running out or by breaking, and the immunity after it.
- FreezeClock.Move - Enum in privbot.mechanics
-
How a move of theirs relates to a running freeze.
- freezeImmune(int) - Method in class privbot.mechanics.SpellEffects
-
Whether
tickis in the estimated immunity window after an observed freeze. - fresh(Collection<ShotView>) - Method in class privbot.mechanics.ShotTracker
-
The shots in
activewhose key is new, in input order. - FRESH_LOCK_TICKS - Static variable in class privbot.mechanics.OpponentTiming
- friends - Variable in class privbot.context.PrivContext
-
Friends list reads.
- friends - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.friends. - Friends - Class in privbot.hooks
-
Friends list queries via RuneLite's
Client. - Friends(Client) - Constructor for class privbot.hooks.Friends
- from - Variable in class privbot.config.ConfigMigration.Change
- from() - Method in class privbot.mechanics.AttackTiming.Window
- fromDispatch(boolean, Outcome.Status, String) - Static method in class privbot.api.Outcome
- fromDisplayName(String) - Static method in class privbot.hooks.Skills
- fromFrame(FightFrame, Integer, Integer, Integer, Integer, Integer, Integer, KnockoutRisk.Assessment) - Static method in class privbot.mechanics.ConsumePlanner.State
-
Build from a same-tick fight frame.
- fromFrame(FightFrame, Map<Integer, RiskValuation.ItemRule>, Boolean, Boolean, int, int, boolean) - Static method in class privbot.mechanics.RiskValuation
-
Evaluate both containers from one fight frame.
- fromJson(String) - Static method in class privbot.mechanics.GearSetup
- fromLock(FightObservation, OpponentLockPolicy.Result, CombatStyle, Integer, Integer, Integer, Boolean, Boolean, Boolean, boolean) - Static method in class privbot.mechanics.PvpFightHistory.Inputs
-
Bind a lock result to an opponent from this exact observation.
- fromName(String) - Static method in enum privbot.api.ServerId
-
Lenient lookup by name: case and punctuation do not matter (
"roat_pkz","Roat-Pkz"and"ROAT PKZ"are allServerId.ROAT_PKZ), the enum name works too, and a longer launcher name that contains exactly one canonical name ("Orion RSPS") resolves to it. - fromPacked(Client, int) - Static method in class privbot.query.WidgetQuery
-
Single root via inspector-style lookup.
- frozen(int) - Method in class privbot.mechanics.SpellEffects
-
Whether an observed freeze's estimated upper-bound window includes
tick. - frozenUntil() - Method in class privbot.mechanics.SpellEffects
-
The estimated upper-bound end of the last observed freeze, or
SpellEffects.NEVER. - full() - Static method in class privbot.hooks.Inventory
-
Static read that needs no
ctx; preferctx.inventory.isFull(). - FxConfigDialog - Class in privbot.ui.fx
-
Modal configuration window: PrivBot studio chrome around embedded Swing content (tabbed forms, etc.).
- FxConfigPageBuilder - Class in privbot.ui.fx
-
Annotation-driven settings page renderer — the "free studio" for any RuneLite-style
Config. - FxConfigPageBuilder.SectionRef - Class in privbot.ui.fx
-
Lightweight descriptor of a
@ConfigSectionfor nav wiring. - FxFormKit - Class in privbot.ui.fx
-
Layout and styling helpers for PrivBot JavaFX settings pages.
- FxFormKit.ResizableMultiline - Class in privbot.ui.fx
-
Wraps a
TextAreain a column with a bottom drag grip so the user can resize height (compact default; does not auto-grow with text — content scrolls inside until extended). - FxPageChrome - Class in privbot.ui.fx
-
Same page chrome as
FxSwingSection(title, subtitle, optional outer scroll) for pure JavaFX bodies. - FxPlatformUtil - Class in privbot.ui.fx
-
Cross-thread helpers for JavaFX embedded in Swing (e.g.
- FxStudioShell - Class in privbot.ui.fx
-
The PrivBot settings studio: an ink masthead (brand mark, name, product, optional running pill), underlined section tabs, a large page heading, a scrolling workspace and a footer with the actions — the workspace look Elorin Wilderness Slayer introduced, shared by every plugin.
- FxStudioShell.Builder - Class in privbot.ui.fx
-
Describes a studio;
FxStudioShell.Builder.build()creates the window (hidden) on the EDT. - FxSwingSection - Class in privbot.ui.fx
-
Wraps legacy Swing settings panels in JavaFX page chrome (title, subtitle, scroll).
G
- game - Variable in class privbot.context.PrivContext
-
Game-wide state: login, tick count, instance, side tabs, run toggle, server name.
- game - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.game. - Game - Class in privbot.hooks
-
Session and client state:
ctx.game(server, login, tick, tabs, instance, run mode). - GAME_STATE_READ - Enum constant in enum privbot.api.Capability
- GameObjects - Class in privbot.hooks
-
Scene object query (KSBot-style).
- GameObjects.ToaRewardsRoomChest - Class in privbot.hooks
-
ToA / Tombs rewards-room anchor classifier (legacy
WardenLootTaskreference): firstGameObjecton the anchor scene tile, matching sarcophagus id, gate action on resolved composition (defaultOpen). - GameObjects.ToaRewardsRoomChest.Config - Class in privbot.hooks
-
Where the anchor sarcophagus is and which action marks a purple.
- GameObjects.ToaRewardsRoomChest.Kind - Enum in privbot.hooks
-
What the anchor sarcophagus shows.
- GameThread - Class in privbot.context
-
Static utility for thread-safe game state access — mirrors the dispatch layer of other bot frameworks.
- GameThreadPolicy - Enum in privbot.context
-
How
GameThreadgets a read onto a thread that may touch the client. - GameThreadRouting - Class in privbot.context
-
The decisions
GameThreadmakes, as pure functions of what a copy knows and where it is called from. - GameThreadRouting.Facts - Interface in privbot.context
-
What one
GameThreadcopy knows at the moment of a call. - GameThreadRouting.Route - Enum in privbot.context
-
Where a call runs.
- gap(int, int, int, int, int) - Static method in class privbot.mechanics.Footprint
-
Tiles between (x,y) and the footprint: 0 = under it, 1 = touching it (also diagonally), 2+ = clear.
- GAP - Static variable in class privbot.ui.overlay.OverlayPlacement
-
Gap between stacked panels.
- gate() - Method in class privbot.hooks.Magic.CastResult
- GAUNTLET_ATTACK - Static variable in class privbot.task.TaskPriorityBands
-
Gauntlet attack (illustrative).
- GAUNTLET_FLOOR - Static variable in class privbot.task.TaskPriorityBands
-
Gauntlet floor-tile hazard (illustrative).
- GAUNTLET_LOOT - Static variable in class privbot.task.TaskPriorityBands
-
Gauntlet reward/loot handling (illustrative).
- GAUNTLET_REENTER - Static variable in class privbot.task.TaskPriorityBands
-
Gauntlet re-entry (illustrative).
- GAUNTLET_TORNADO - Static variable in class privbot.task.TaskPriorityBands
-
Gauntlet hazard / combat (illustrative).
- GAUNTLET_WEAPON - Static variable in class privbot.task.TaskPriorityBands
-
Gauntlet weapon switch (illustrative).
- GAVE_UP - Enum constant in enum privbot.mechanics.SpecialAttackPolicy.Phase
- gaveUp - Variable in class privbot.mechanics.SpecialAttackPolicy.State
- gear() - Method in class privbot.mechanics.StylePlanner.Candidate
- gear(PvpArbiter.Kind, ItemContainerSnapshot.Item, int, CombatStyle, String) - Static method in class privbot.mechanics.PvpArbiter.Action
-
A fixed-set or bait gear proposal; the planner validates it against the current inventory.
- gearBackoff - Variable in class privbot.mechanics.SpecialAttackPolicy.State
- gearConfigured - Variable in class privbot.mechanics.SpecialAttackPolicy.State
- GearNames - Class in privbot.mechanics
-
Which item names are the same piece of gear.
- GearSetup - Class in privbot.mechanics
-
An immutable description of the gear a fight needs, the same on every server: what is worn, or what is carried.
- GearSetup(GearSetup.Kind, List<GearSetup.Entry>) - Constructor for class privbot.mechanics.GearSetup
- GearSetup.Entry - Class in privbot.mechanics
-
One wanted item.
- GearSetup.Kind - Enum in privbot.mechanics
-
Whether a setup describes worn equipment or carried supplies.
- GearSetup.Role - Enum in privbot.mechanics
-
What a carried item is for.
- GearTheme - Class in privbot.ui
-
Shared PvP visual design system (consolidated from the formerly-duplicated
autopvp.gui.GearThemeandaipvp.gui.GearTheme, which were byte-identical). - get() - Method in class privbot.api.Observed
-
The value read.
- get() - Method in class privbot.hooks.LocalPlayer
-
The local
Player. - get() - Method in class privbot.ui.overlay.Snapshot
-
The current value, or null when nothing has been published (render thread).
- get(String) - Method in interface privbot.config.ConfigMigration.ConfigAccess
-
The value this client holds (a ConfigManager's in-memory copy), or null when the key is not stored.
- get(String) - Method in class privbot.hooks.Blackboard
-
Returns the raw value for
key, ornullif absent (orkeyis null). - get(Predicate<PrivItem>) - Method in class privbot.hooks.Bank
- get(Predicate<PrivItem>) - Method in class privbot.hooks.Equipment
- get(Predicate<PrivItem>) - Method in class privbot.hooks.Inventory
-
First inventory slot matching
pred, or null. - getActions() - Method in class privbot.wrappers.PrivNPC
-
The NPC's live menu actions, tags stripped.
- getActions() - Method in class privbot.wrappers.PrivObject
-
A copy of the transformed definition's raw action array (tags not stripped, null entries kept).
- getActiveChild() - Method in class privbot.task.Parent
-
The child chosen by the last
Parent.execute(C), or null when none ran or after a reset. - getActiveChildName() - Method in class privbot.task.Parent
-
The name of
Parent.getActiveChild(), or null. - getActiveNode() - Method in class privbot.task.CompositeTaskNode
-
Returns the currently active child (the one that last executed), or null.
- getActiveNode() - Method in class privbot.task.StagedTaskRunner
-
The node that ran on the last tick, or null when that tick was idle.
- getActiveNode() - Method in class privbot.task.TaskNodeRunner
-
Returns the currently active node (the one that last executed), or null.
- getActiveTaskName() - Method in class privbot.task.StagedTaskRunner
-
The name of the node that ran on the last tick, or null when idle.
- getActiveTaskName() - Method in class privbot.task.TaskNodeRunner
-
Returns the name of the currently active node, or null if idle.
- getActiveTaskStatus() - Method in class privbot.task.StagedTaskRunner
-
That node's status after it ran, or
"Idle". - getActiveTaskStatus() - Method in class privbot.task.TaskNodeRunner
-
Returns the status of the currently active node, or "Idle".
- getAmount() - Method in class privbot.wrappers.PrivGroundItem
-
Alias for
PrivGroundItem.getQuantity()(DreamBot / Scar-style naming). - getAmount() - Method in class privbot.wrappers.PrivItem
-
Alias for
PrivItem.getQuantity(). - getAnimation() - Method in class privbot.hooks.User
- getAttackStyle() - Method in class privbot.hooks.Combat
-
Zero-based selected attack style; -1 means unavailable, never a guessed default.
- getAutoRetaliate() - Method in class privbot.hooks.Combat
- getButtonRow() - Method in class privbot.ui.PrivBotPanel
-
Returns the button row for adding custom buttons.
- getByInspectorPath(String) - Method in class privbot.hooks.Widgets
-
Resolves a widget using inspector path syntax (e.g.
- getChildren() - Method in class privbot.task.CompositeTaskNode
-
Returns an unmodifiable view of the children.
- getChildren() - Method in class privbot.task.Parent
-
An unmodifiable view of the registered children, in registration order.
- getClient() - Static method in class privbot.context.GameThread
-
The client given to
GameThread.init(net.runelite.api.Client, net.runelite.client.callback.ClientThread), ornullbefore this copy was initialised. - getClient() - Method in class privbot.context.PrivContext
-
The client this context was built with.
- getClient() - Method in class privbot.hooks.GameObjects
- getClient() - Method in class privbot.hooks.GroundItems
- getClient() - Method in class privbot.task.PrivTaskContext
-
The client from
PrivContext.getClient(). - getCombatLevel() - Method in class privbot.wrappers.PrivPlayer
-
The client's combat-level field, or -1 without a player.
- getContainer() - Method in class privbot.hooks.Inventory
-
Returns the raw inventory
ItemContainer. - getContainerKind() - Method in class privbot.wrappers.PrivItem
-
The container this row came from.
- getContent() - Method in class privbot.ui.CollapsibleSection
-
Returns the content panel for direct manipulation.
- getCurrentTarget() - Method in class privbot.hooks.Combat
- getElapsedTime() - Method in class privbot.effects.EffectTracker.TimerView
- getEquipmentContainer() - Method in class privbot.hooks.Inventory
-
Returns the raw equipment
ItemContainer. - getEstimatedRemainingMs() - Method in class privbot.effects.EffectObservation
-
-1 means no duration estimate is available.
- getExecutionCounts() - Method in class privbot.task.StagedTaskRunner
-
Node name to how many times it executed (unmodifiable view).
- getExecutionCounts() - Method in class privbot.task.TaskNodeRunner
-
Returns an unmodifiable map of node name to total execution count.
- getExecutionTimes() - Method in class privbot.task.StagedTaskRunner
-
Node name to its last execution time in milliseconds (unmodifiable view).
- getExecutionTimes() - Method in class privbot.task.TaskNodeRunner
-
Returns an unmodifiable map of node name to last execution duration (ms).
- getExperience(Skill) - Method in class privbot.hooks.User
- getFrame() - Method in class privbot.ui.fx.FxStudioShell
-
Studio host window.
- getFriends() - Method in class privbot.hooks.Friends
- getGameThread() - Static method in class privbot.context.GameThread
-
The identified game thread, or null when the server gives us none.
- getHitpoints() - Method in class privbot.hooks.Skills
- getHitpoints() - Method in class privbot.hooks.User
- getHitpointsPercent() - Method in class privbot.hooks.User
- getId() - Method in class privbot.wrappers.PrivGroundItem
-
The item id, or -1 when built without a stack.
- getId() - Method in class privbot.wrappers.PrivItem
-
The item id in this slot as captured by the snapshot.
- getId() - Method in class privbot.wrappers.PrivNPC
- getId() - Method in class privbot.wrappers.PrivObject
-
The object's scene id (before any varbit transform), or -1 without an object.
- getId() - Method in class privbot.wrappers.PrivPlayer
-
The client's player id, or -1.
- getIndex() - Method in class privbot.wrappers.PrivNPC
-
The NPC's index in the client's NPC array (the menu identifier), or -1 without an NPC.
- getIndex() - Method in class privbot.wrappers.PrivPlayer
-
Live player-list index used as the identifier in Impact player actions.
- getInt(String, int) - Method in class privbot.hooks.Blackboard
- getInteracting() - Method in class privbot.wrappers.PrivNPC
-
Returns the actor this NPC is currently interacting with (targeting), or null if not interacting with anyone.
- getItem() - Method in class privbot.wrappers.PrivGroundItem
-
Same as
PrivGroundItem.getId()— convenient for price APIs that take an item id. - getItem() - Method in class privbot.wrappers.PrivItem
-
Item id (for bank/equipment/inventory); same as
PrivItem.getId(). - getLastActiveStage() - Method in class privbot.task.StagedTaskRunner
-
The stage of
StagedTaskRunner.getActiveNode(), or null when the last tick was idle. - getLastExecutionTime() - Method in class privbot.task.SimpleNode
-
Returns the timestamp (millis) of the last execution, or 0 if never executed.
- getLocalPlayer() - Method in class privbot.hooks.User
-
Returns the local
Playerthrough the game client. - getLocation() - Method in class privbot.hooks.User
- getMaxHitpoints() - Method in class privbot.hooks.User
- getMyOffer() - Method in class privbot.hooks.Trade
- getName() - Method in class privbot.task.CompositeTaskNode
-
The name given to the constructor.
- getName() - Method in class privbot.task.SimpleNode
-
The name given to the constructor.
- getName() - Method in interface privbot.task.TaskNode
-
Gets a human-readable name for this task.
- getName() - Method in class privbot.wrappers.PrivGroundItem
-
The item name from
ItemManager, or"item:<id>"when it cannot be resolved (always so without an ItemManager, the normal case on Impact, Elorin and SpawnPK). - getName() - Method in class privbot.wrappers.PrivItem
-
Resolves this item's display name via
ItemManager. - getName() - Method in class privbot.wrappers.PrivNPC
-
The NPC's name with tags stripped, falling back to the transformed composition's name.
- getName() - Method in class privbot.wrappers.PrivObject
-
The transformed definition's name with tags stripped, or
"object:<id>"when the definition cannot be read. - getName() - Method in class privbot.wrappers.PrivPlayer
-
The player's name as the client reports it (tags not stripped), or empty when unknown.
- getNativeRemainingMs() - Method in class privbot.effects.EffectObservation
-
-1 means no native remaining-time observation is available, even if a chat estimate exists.
- getNodeCount() - Method in class privbot.task.StagedTaskRunner
-
The number of registered nodes across all stages.
- getNodeCount() - Method in class privbot.task.TaskNodeRunner
-
Returns the number of registered nodes.
- getNodes() - Method in class privbot.task.StagedTaskRunner
-
An unmodifiable snapshot of all nodes, in stage order then registration order.
- getNodes() - Method in class privbot.task.TaskNodeRunner
-
Returns an unmodifiable view of all registered nodes.
- getNodeStats() - Method in class privbot.task.StagedTaskRunner
-
A multi-line report of every node with its stage, priority and execution statistics.
- getNodeStats() - Method in class privbot.task.TaskNodeRunner
-
Builds a human-readable statistics report for all registered nodes.
- getNpc() - Method in class privbot.wrappers.PrivNPC
-
The wrapped client NPC (may be null).
- getNpcId() - Method in class privbot.wrappers.PrivNPC
-
Composition id (e.g.
- getObservedAtMs() - Method in class privbot.effects.EffectObservation
-
Time of the evidence that produced this snapshot; -1 when there is no observation.
- getOpponentCurrentHp() - Method in class privbot.hooks.Combat
- getOpponentMaxHp() - Method in class privbot.hooks.Combat
- getOpponentName() - Method in class privbot.hooks.Combat
- getOpponentName() - Method in class privbot.hooks.User
- getOptions() - Method in class privbot.hooks.Dialogue
-
Returns all visible option strings by finding widgets whose children contain multiple selectable text entries (the option/multi-choice pattern).
- getPlayer() - Method in class privbot.wrappers.PrivPlayer
-
The wrapped client player (may be null).
- getPlayers() - Method in class privbot.hooks.PlayersHook
-
Returns the raw player list.
- getPreferredSize() - Method in class privbot.ui.ModernTheme.ModernToggle
-
The label's size plus room for the 36 x 20 px track.
- getPriority() - Method in class privbot.task.CompositeTaskNode
-
The priority given to the constructor (0 by default).
- getPriority() - Method in class privbot.task.SimpleNode
-
The priority given to the constructor.
- getPriority() - Method in interface privbot.task.TaskNode
-
Gets the numeric priority of this task.
- getQuantity() - Method in class privbot.wrappers.PrivGroundItem
-
The stack size captured when this wrapper was built.
- getQuantity() - Method in class privbot.wrappers.PrivItem
-
The stack size in this slot as captured by the snapshot.
- getRecentMessages(int) - Method in class privbot.hooks.Chat
-
Recent chat lines, newest first: the event-fed buffer (
Chat.recordMessage(java.lang.String)) when it has lines, else the client's message list. - getRemaining() - Method in class privbot.effects.EffectTracker.TimerView
- getRemainingTime() - Method in class privbot.effects.EffectTracker.TimerView
- getRunEnergy() - Method in class privbot.hooks.Game
- getRunEnergy() - Method in class privbot.hooks.User
- getSections() - Method in class privbot.ui.PrivBotFrame
-
Returns all registered sections.
- getServerName() - Method in class privbot.hooks.Game
- getSkillIcon(String, int) - Static method in class privbot.ui.SkillIconManager
-
A freshly drawn icon, at least 12 px square.
- getSlot() - Method in class privbot.wrappers.PrivItem
-
The 0-based slot index in its container.
- getSource() - Method in class privbot.effects.EffectObservation
- getSpecialAttack() - Method in class privbot.hooks.User
- getSpecialAttackPercent() - Method in class privbot.hooks.Combat
-
Special attack energy 0–100 (SpawnPK widget path when applicable, else adapter).
- getSpecialAttackPercentage() - Method in class privbot.hooks.Combat
-
Deprecated.use
Combat.getSpecialAttackPercent()(orCombat.specialAttackPercentOrNull()to tell 0 from "cannot read") - getState() - Method in class privbot.effects.EffectObservation
- getStatsPanel() - Method in class privbot.ui.PrivBotPanel
-
Returns the stats panel for adding custom content.
- getStatus() - Method in class privbot.ui.PrivBotPanel
-
The status last set with
PrivBotPanel.setStatus(privbot.ui.PanelStatus, java.lang.String)orPrivBotPanel.setRunning(boolean). - getStatus(C) - Method in class privbot.task.CompositeTaskNode
-
"name > activeChildStatus"while a child is active, otherwise the name. - getStatus(C) - Method in class privbot.task.Parent
-
The active child's status, or this node's own status when no child is active.
- getStatus(C) - Method in class privbot.task.SimpleNode
-
Returns the last status set via
SimpleNode.status(String, Object...), or falls back toSimpleNode.getName(). - getStatus(C) - Method in interface privbot.task.TaskNode
-
Gets the current status description for overlay/GUI display.
- getString(String, String) - Method in class privbot.hooks.Blackboard
-
Returns the value at
keyas a string: aStringis returned as-is, any other non-null value is stringified viaString.valueOf(Object); absent/null returnsdef. - getText() - Method in class privbot.hooks.Dialogue
-
Returns the text content from the first visible widget found by searching all widget roots for non-empty text that isn't a common UI label.
- getText() - Method in class privbot.ui.SearchField
-
The current text.
- getTheirOffer() - Method in class privbot.hooks.Trade
- getTickCount() - Method in class privbot.hooks.Game
-
The game's tick counter, or
-1when the read cannot be served. - getTile() - Method in class privbot.wrappers.PrivGroundItem
-
Tile this stack sits on; may be null if constructed without a tile.
- getTileObject() - Method in class privbot.wrappers.PrivObject
-
The wrapped client object (may be null).
- getTimer(String) - Method in class privbot.effects.EffectTracker
-
Live local timer view; use observe() when an immutable effect snapshot is required.
- getTimerRemaining(String) - Method in class privbot.effects.EffectTracker
-
Source-compatible local timer helper: absent timer means zero, not proven inactive effect.
- getTimeSinceLastExecution() - Method in class privbot.task.SimpleNode
-
Returns milliseconds since last execution, or -1 if never executed.
- getTotalTicks() - Method in class privbot.task.StagedTaskRunner
-
Ticks processed since
StagedTaskRunner.initialize(), idle ticks included. - getTotalTicks() - Method in class privbot.task.TaskNodeRunner
-
Returns the total number of ticks processed.
- getUsername() - Method in class privbot.hooks.User
- getVarbit(int) - Method in class privbot.hooks.Vars
- getVarp(int) - Method in class privbot.hooks.Vars
- getWorld(String) - Method in class privbot.hooks.Friends
- getWorldLocation() - Method in class privbot.wrappers.PrivGroundItem
-
The stack's world tile, or null when built without a tile.
- getWorldLocation() - Method in class privbot.wrappers.PrivNPC
-
The NPC's current world tile, or null when unknown.
- getWorldLocation() - Method in class privbot.wrappers.PrivObject
-
The object's world tile, or null when unknown.
- getWorldLocation() - Method in class privbot.wrappers.PrivPlayer
-
The player's current world tile, or null when unknown.
- glyph() - Method in enum privbot.ui.PanelStatus
-
The shape shown before the label, so the state reads without colour.
- go(Destination) - Method in class privbot.hooks.Travel
-
Starts a job that gets the player into
destination: an optional teleport first (once, only when the player is more than 30 tiles away), then a pathed walk started asynchronously and polled every step. - good - Variable in class privbot.ui.overlay.OverlayPalette
-
The resolved colours, all opaque: card
backgroundandborder,title, rowlabelandvalue,accent(LEVEL bars), and the status coloursinfo,good,warn,muted. - GOOD - Enum constant in enum privbot.ui.overlay.PaletteSettings.Slot
- GOOD - Static variable in class privbot.ui.overlay.OverlayTheme
-
Healthy, safe, done (green).
- GraniteMaulDecision - Class in privbot.mechanics
-
Pure decisions for the Elorin-observed instant granite maul behavior.
- GraniteMaulDecision.Decision - Class in privbot.mechanics
- GraniteMaulDecision.Kind - Enum in privbot.mechanics
- graphic - Variable in class privbot.mechanics.ThreatMemory.Tell
- graphic() - Method in class privbot.mechanics.NpcView
- graphic() - Method in class privbot.mechanics.PlayerView
- graphic(int) - Method in interface privbot.api.Ids
-
This server's spot graphic / graphics object / projectile id for OSRS graphic
osrsId. - Graphic(int, int) - Constructor for class privbot.mechanics.FightObservation.Graphic
- GraphicEvent(int, LocalPoint, int, int, int) - Constructor for class privbot.hooks.Events.GraphicEvent
- graphics - Variable in class privbot.context.PrivContext
-
Scene graphics objects (spot animations drawn in the world).
- graphics - Variable in class privbot.hooks.Events.Needs
-
Read the graphics list.
- graphics - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.graphics. - graphics() - Method in class privbot.mechanics.FightObservation
- graphics() - Method in class privbot.mechanics.ThreatSnapshot
- graphics() - Method in class privbot.ui.overlay.SceneCanvas
-
The overlay's graphics, for drawing the primitives here do not cover.
- graphics(List<Events.GraphicSeen>) - Method in class privbot.hooks.Events.Frame.Builder
- GRAPHICS_EVENTS - Enum constant in enum privbot.api.Capability
- GraphicSeen(String, int, LocalPoint, int, int) - Constructor for class privbot.hooks.Events.GraphicSeen
- GraphicsObjectQuery - Class in privbot.query
-
Fluent query for scene graphics objects (e.g.
- GraphicsObjectQuery(List<GraphicsObject>, Client) - Constructor for class privbot.query.GraphicsObjectQuery
-
Wraps a copy of
raw; plugins normally get a query fromctx.graphics.query(). - GraphicsObjects - Class in privbot.hooks
-
Scene graphics query hook (graphics objects deque).
- GraphicsObjects(Client) - Constructor for class privbot.hooks.GraphicsObjects
- GraphicView - Class in privbot.mechanics
-
A detached copy of one graphics object (a ground effect such as a falling rock or a pool) taken at the tick of a
ThreatSnapshot. - GraphicView(int, int, WorldPoint) - Constructor for class privbot.mechanics.GraphicView
- Ground(int, String, int, WorldPoint) - Constructor for class privbot.restock.GroundLoot.Ground
- GROUND_ITEM_READ - Enum constant in enum privbot.api.Capability
- GROUND_ITEM_TAKE - Enum constant in enum privbot.api.Capability
- GroundItemQuery - Class in privbot.query
-
Fluent filter chain over ground item stacks, built by
ctx.groundItems.query(). - GroundItemQuery(List<PrivGroundItem>, Client) - Constructor for class privbot.query.GroundItemQuery
-
Wraps a copy of
raw; plugins normally get a query fromctx.groundItems.query(). - groundItems - Variable in class privbot.context.PrivContext
-
Ground item queries and pickup (
ctx.groundItems.query()). - groundItems - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.groundItems. - GroundItems - Class in privbot.hooks
-
Ground loot query (KSBot-style).
- GroundLoot - Class in privbot.restock
-
Picks up ground items by name fragment and proves each pickup: Take, then wait for the inventory count of that id to rise.
- GroundLoot(int, int) - Constructor for class privbot.restock.GroundLoot
- GroundLoot.Ground - Class in privbot.restock
-
Detached ground item facts (read on the client thread, used on the worker).
- GroundLoot.Outcome - Enum in privbot.restock
- group - Variable in class privbot.ui.PrivBotFrame.SectionInfo
-
Filter group, e.g.
- guardCurrentGeneration(BooleanSupplier) - Method in class privbot.actions.confirm.ActionTracker
-
Capture before dispatch so a later registration cannot adopt an obsolete session's action.
- guarded(String) - Static method in class privbot.mechanics.PrayerToggleGuard
-
Whether toggles of this prayer are subject to the hold.
H
- handleError(Exception) - Method in class privbot.task.SimpleNode
-
Called when an exception occurs during execution.
- hardBlocked - Variable in class privbot.mechanics.SpecialAttackPolicy.State
- has(String) - Method in class privbot.hooks.Bank
-
True when the bank holds at least one item whose display name matches
name(case-insensitive). - has(String) - Method in class privbot.hooks.Blackboard
-
True if
keyis present (and non-null). - has(String) - Method in class privbot.hooks.container.ItemContainerSnapshot
- has(String) - Method in class privbot.hooks.Inventory
-
True when inventory holds at least one item whose display name matches
name(case-insensitive contains, same semantics asInventory.contains(String...)). - has(String) - Method in class privbot.hooks.Teleports
- has(String) - Method in class privbot.hooks.Widgets
-
Quiet read for
shouldExecute: a visible widget matchesquery(text, then name, then action, then target verb; exact then contains). - hasAction(String) - Method in class privbot.hooks.container.ItemContainerSnapshot.Item
- hasAction(String) - Method in class privbot.wrappers.PrivGroundItem
-
Ground loot typically exposes
Take; matches Scar-style"pickup"too. - hasAction(String) - Method in class privbot.wrappers.PrivItem
-
Whether the item definition lists
action(exact, case-insensitive) among its inventory options. - hasAction(String) - Method in class privbot.wrappers.PrivNPC
-
Whether the NPC composition exposes this menu action (e.g.
- hasAction(String) - Method in class privbot.wrappers.PrivObject
-
Whether the object definition exposes this action (e.g.
- hasAction(String) - Method in class privbot.wrappers.PrivPlayer
- hasActionLenientDefinitionScan(String) - Method in class privbot.wrappers.PrivObject
-
Like
PrivObject.hasAction(String)but, when the varbit-resolved composition has no matching action, also checks every distinct template id on the base definition (base id +ObjectComposition.getImpostorIds()). - hasAny(String...) - Method in class privbot.hooks.container.ItemContainerSnapshot
- hasAttackCorridor(WorldPoint, int, int) - Method in interface privbot.hooks.CombatCollision
- hasBuyX() - Method in class privbot.hooks.shop.ShopInterface
-
True when PrivBot can open the shop's Buy X amount prompt on this server.
- hasClientThread() - Method in interface privbot.context.GameThreadRouting.Facts
-
GameThread.init(net.runelite.api.Client, net.runelite.client.callback.ClientThread)gave this copy aClientThread. - hasEnoughSpecialEnergy(int) - Method in class privbot.hooks.Combat
- hasExactText(String) - Method in class privbot.hooks.Widgets
- hasFailed() - Method in class privbot.mechanics.BoostDosePolicy
-
Read-only: true when the recorded failures have reached
maxFailures. - hasFood() - Method in class privbot.hooks.Inventory
-
Whether inventory holds at least one item with an
Eataction. - hasGameThread() - Method in interface privbot.context.GameThreadRouting.Facts
-
A frame pulse identified the game thread for this copy.
- hashCode() - Method in class privbot.api.ApiVersion
- hashCode() - Method in class privbot.api.Observed
- hashCode() - Method in class privbot.api.Outcome
- hashCode() - Method in class privbot.config.ConfigMigration.Change
- hashCode() - Method in class privbot.mechanics.GearSetup.Entry
- hashCode() - Method in class privbot.mechanics.GearSetup
- hashCode() - Method in class privbot.mechanics.GraphicView
- hashCode() - Method in class privbot.mechanics.NpcView
- hashCode() - Method in class privbot.mechanics.PrayerToggleGuard.Toggle
- hasMovementEntry(String) - Method in class privbot.hooks.Teleporter
-
True when the current server's movement catalog contains a transport/NPC entry with this name.
- hasReachableApproach(WorldPoint, int, SceneReachability) - Method in interface privbot.hooks.CombatCollision
- hasText(String) - Method in class privbot.hooks.Widgets
- HAZARD_PRIMARY - Enum constant in enum privbot.task.AutomationStage
-
First hazard tier — e.g.
- HAZARD_PRIMARY - Static variable in class privbot.task.TaskPriorityBands
-
First hazard tier: mechanics that kill if ignored this tick (poison spike, tornado).
- HAZARD_SECONDARY - Enum constant in enum privbot.task.AutomationStage
-
Secondary hazards — fire, acid, crystal, floor, water (typically 80–95).
- HAZARD_SECONDARY_HIGH - Static variable in class privbot.task.TaskPriorityBands
-
Top of the secondary hazard band (fire, acid, crystals, floor).
- HAZARD_SECONDARY_LOW - Static variable in class privbot.task.TaskPriorityBands
-
Bottom of the secondary hazard band.
- HAZARD_SECONDARY_MEDIUM - Static variable in class privbot.task.TaskPriorityBands
-
Intermediate secondary-hazard band for mechanics ordered between 95 and 80.
- HAZARD_TILES - Enum constant in enum privbot.api.Capability
-
Hazard tiles and the safe tiles around them.
- HazardMap - Class in privbot.mechanics
-
The tiles that hurt right now: timed ones (a graphic or a telegraphed attack that lasts a few ticks) and persistent ones (ground the fight never lets you stand on).
- HazardMap() - Constructor for class privbot.mechanics.HazardMap
- hazards - Variable in class privbot.context.PrivContext
-
Dodging: a hazard map plus the nearest reachable tile out of it.
- hazards - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.hazards. - Hazards - Class in privbot.hooks
-
Dodging:
ctx.hazards. - health() - Method in class privbot.mechanics.PvpFightHistory
-
Health history from the same folded frames.
- HealthHistory - Class in privbot.mechanics
-
Detached recent health observations for the eat decision.
- HealthHistory() - Constructor for class privbot.mechanics.HealthHistory
- healthRatio() - Method in class privbot.hooks.LocalPlayer
-
The health bar's filled amount (out of
LocalPlayer.healthScale());-1means no health bar is drawn, which is a real answer, not "dead". - healthRatio() - Method in class privbot.mechanics.NpcView
- healthRatio() - Method in class privbot.mechanics.PlayerView
- healthScale() - Method in class privbot.hooks.LocalPlayer
- healthScale() - Method in class privbot.mechanics.NpcView
- healthScale() - Method in class privbot.mechanics.PlayerView
- held() - Method in class privbot.hooks.Recovery
-
Whether bot actions are held because the client saw a forced move (a jail pull, a burst of teleports).
- held() - Method in class privbot.mechanics.PvpArbiter.Action
- held(boolean, long) - Method in class privbot.mechanics.ProgressWatchdog
-
Starts or ends a hold.
- hideCount() - Method in class privbot.ui.SearchField
-
Hides the result-count badge.
- HIGHLIGHT - Static variable in class privbot.ui.overlay.OverlayTheme
-
Draws the eye without meaning good or bad (cyan), e.g.
- hintArrowOnly() - Method in class privbot.hooks.NPCs
-
Start a query filtered to only the hint arrow NPC.
- hintArrowOnly() - Method in class privbot.query.NPCQuery
-
Keeps only the NPC that is the current hint arrow target.
- Hit(CombatStyle, int, int) - Constructor for class privbot.mechanics.ThreatMemory.Hit
- hitLag(CombatStyle) - Method in class privbot.mechanics.OpponentAttackClock
-
Median of the last nine valid attributed swing-to-hit gaps after five samples, else zero.
- hitpoints() - Method in class privbot.hooks.LocalPlayer
-
Current (boosted) hitpoints (
Skills.observedLevel(net.runelite.api.Skill, boolean)). - hits() - Method in class privbot.mechanics.FightObservation
- hits(List<Events.HitsplatEvent>) - Method in class privbot.hooks.Events.Frame.Builder
- HITSPLAT_EVENTS - Enum constant in enum privbot.api.Capability
- HitsplatEvent(Actor, boolean, String, int, int, int, int, boolean) - Constructor for class privbot.hooks.Events.HitsplatEvent
- hitsplats - Variable in class privbot.hooks.Events.Needs
-
Poll hitsplats.
- hitsReadable() - Method in class privbot.mechanics.ThreatMemory.View
- hold(String) - Method in class privbot.mechanics.PvpArbiter.Action
-
Return an explainable held version of this action; held actions are never dispatched.
- HOLD - Enum constant in enum privbot.mechanics.EatDeferral.Choice
- HOLD - Enum constant in enum privbot.mechanics.GraniteMaulDecision.Kind
- HOLD - Enum constant in enum privbot.mechanics.KnockoutWeaponDecision.Kind
- HOLD - Enum constant in enum privbot.mechanics.PvpMovement.Kind
- HOLD_MS - Static variable in class privbot.mechanics.PrayerToggleGuard
- holdReason() - Method in class privbot.hooks.Recovery
- HOME - Enum constant in enum privbot.restock.RestockCycle.Stage
- homeConfirmMs - Variable in class privbot.restock.RestockRoute
- homeRadiusTiles - Variable in class privbot.restock.RestockRoute
- homeRecording - Variable in class privbot.hooks.Restock.Request
-
Impact: the saved Action Recording that teleports home; null or blank skips the replay.
- homeRecording(String) - Method in class privbot.hooks.Restock.Builder
- homeSpell - Variable in class privbot.restock.RestockRoute
- homeX - Variable in class privbot.restock.RestockRoute
- homeY - Variable in class privbot.restock.RestockRoute
- Hooks and interactions - Search tag in class privbot.sdk.PrivBotAPI
- Section
- host - Variable in class privbot.hooks.Restock.Request
-
Elorin: the plugin's host (abort, position, restored, destination, capture rows).
- host(RestockHost) - Method in class privbot.hooks.Restock.Builder
- hotkeys - Variable in class privbot.context.PrivContext
-
Queued user key presses; start and stop with the plugin.
- hotkeys - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.hotkeys. - Hotkeys - Class in privbot.hooks
-
Queues configured key presses for the plugin's worker to drain.
- Hotkeys() - Constructor for class privbot.hooks.Hotkeys
- HOTKEYS - Enum constant in enum privbot.api.Capability
-
User-configured key presses queued for a plugin.
- hp - Variable in class privbot.mechanics.ConsumePlanner.State
- hp() - Method in class privbot.mechanics.ThreatSnapshot
- hpBlocked(boolean, int, Integer, int, int) - Static method in class privbot.mechanics.SpecialAttackPolicy
-
Whether the opponent HP gate blocks a start or a committed episode.
- hull(Actor) - Method in class privbot.ui.overlay.SceneProjection
-
An actor's outline: its convex hull where the client provides one, else its tile.
- human - Variable in class privbot.task.PrivTaskContext
-
Thread-safe RNG and pacing for player-visible actions (script thread only).
- Human - Class in privbot.behavior
-
Thread-safe pacing for player-visible automation (script thread /
execute()only). - Human() - Constructor for class privbot.behavior.Human
I
- icon() - Method in class privbot.hooks.User.Overhead
-
The icon drawn, or
nullwhen nothing is drawn or what is drawn blocks none of melee/ranged/magic (Elorin's Deflect Summoning, a blank sprite). - id - Variable in class privbot.actions.confirm.ActionSnapshot
- id - Variable in class privbot.hooks.container.ItemContainerSnapshot.Item
-
Item id, slot index and stack quantity.
- id - Variable in class privbot.hooks.Events.GraphicEvent
-
The graphic id in this server's numbering.
- id - Variable in class privbot.hooks.Events.ProjectileEvent
-
The projectile's id in this server's numbering.
- id - Variable in class privbot.hooks.Events.VarChange
-
The id watched.
- id - Variable in class privbot.hooks.VarRegistry.Entry
-
The id in this server's own numbering.
- id - Variable in class privbot.mechanics.OpponentLock
- id - Variable in class privbot.mechanics.OpponentLockPolicy.Candidate
- id - Variable in class privbot.restock.GroundLoot.Ground
- id() - Method in class privbot.mechanics.FightObservation.Graphic
- id() - Method in class privbot.mechanics.GearSetup.Entry
- id() - Method in class privbot.mechanics.GraphicView
- id() - Method in class privbot.mechanics.NpcView
- id() - Method in class privbot.mechanics.ShotView
- id(int) - Method in class privbot.hooks.container.ItemContainerSnapshot
- identifier(String[], String) - Static method in class privbot.hooks.bank.BankWidgetOps
-
Pure: index + 1 of the first action equal to
option(tags, case and padding ignored), elseBankWidgetOps.ABSENT. - identifier(Client, int, int, String) - Static method in class privbot.hooks.bank.BankWidgetOps
-
The 1-based menu identifier of
optionon childslotofpackedContainer. - IDLE - Enum constant in enum privbot.restock.RestockCycle.Stage
- IDLE - Enum constant in enum privbot.ui.PanelStatus
-
Not running (the state after Stop).
- idleFallback(boolean) - Method in class privbot.mechanics.PrayerPlanner.Options
-
Whether to revert to the idle style when nobody has attacked for the idle ticks (default false).
- idleMs(long) - Method in class privbot.mechanics.ProgressWatchdog
- idleStyle(CombatStyle) - Method in class privbot.mechanics.PrayerPlanner.Options
-
The style to fall back to after
PrayerPlanner.Options.idleFallback(boolean)triggers (default none). - idleTick - Variable in class privbot.mechanics.ConsumePlanner.State
- idleTicks(int) - Method in class privbot.mechanics.PrayerPlanner.Options
-
Ticks without an attack before the idle fallback applies (minimum 1, default 1).
- ids - Variable in class privbot.context.PrivContext
-
OSRS id to this server's id (and back) for animations, graphics and varbits; empty when unknown.
- ids - Variable in class privbot.task.PrivTaskContext
-
Mirrors
PrivContext.ids. - ids() - Static method in class privbot.ui.overlay.OverlayIcons
-
Every
skill:id alphabetically, then everytile:id alphabetically. - ids(int...) - Method in class privbot.mechanics.LootSpec.Builder
-
Item ids to take.
- ids(int...) - Static method in class privbot.mechanics.TargetSpec
-
A spec matching these NPC ids, whatever their name.
- Ids - Interface in privbot.api
-
Translates OSRS ids to the ids this server uses, and back.
- ifPresent(Consumer<? super T>) - Method in class privbot.api.Observed
- ignore(String...) - Method in class privbot.mechanics.TargetSpec
-
Never matches an NPC whose name matches one of these (same rules as names).
- image(String, int) - Static method in class privbot.ui.overlay.OverlayIcons
-
ARGB image scaled to
pxxpx, cached per (id, px); null for an unknown id (logged once). - immuneUntil(int, FreezeClock.Move, int) - Static method in class privbot.mechanics.FreezeClock
-
The first tick they can be frozen again after a freeze that ended at
endedAt, orFreezeClock.NEVER. - IMPACT - Enum constant in enum privbot.api.ServerId
- IMPACT_CLOSE_ID - Static variable in class privbot.hooks.bank.BankSession
- IMPACT_CLOSE_OP - Static variable in class privbot.hooks.bank.BankSession
-
Impact's Close button: its menu action, with the identifier and params below.
- IMPACT_CLOSE_P0 - Static variable in class privbot.hooks.bank.BankSession
- IMPACT_CLOSE_P1 - Static variable in class privbot.hooks.bank.BankSession
- IMPACT_DEPOSIT_INVENTORY_ID - Static variable in class privbot.hooks.bank.BankSession
- IMPACT_DEPOSIT_INVENTORY_OP - Static variable in class privbot.hooks.bank.BankSession
-
Impact's Deposit inventory button: its menu action, with the identifier and params below.
- IMPACT_DEPOSIT_INVENTORY_P0 - Static variable in class privbot.hooks.bank.BankSession
- IMPACT_DEPOSIT_INVENTORY_P1 - Static variable in class privbot.hooks.bank.BankSession
- INACTIVE - Enum constant in enum privbot.effects.EffectObservation.State
- includeLocal(boolean) - Method in class privbot.mechanics.PvpQuery
- includesLocal() - Method in class privbot.mechanics.PvpQuery
- incoming() - Method in class privbot.mechanics.PvpFightHistory.View
- IncomingStyleDecision - Class in privbot.mechanics
-
Chooses an incoming combat style from detached, independently classified threat evidence.
- IncomingStyleDecision.Decision - Class in privbot.mechanics
-
A null style means the inputs do not establish a style; keep the current protection.
- IncomingStyleDecision.Source - Enum in privbot.mechanics
- increment(String, int) - Method in class privbot.hooks.Blackboard
-
Adds
byto the int value atkey, creating it at 0 if absent (or if the existing value is non-numeric), stores the result, and returns the new value. - INDEPENDENT - Enum constant in enum privbot.mechanics.ConsumeTiming.Mode
- index() - Method in class privbot.mechanics.NpcView
- index() - Method in class privbot.mechanics.PlayerView
- info - Variable in class privbot.ui.overlay.OverlayPalette
-
The resolved colours, all opaque: card
backgroundandborder,title, rowlabelandvalue,accent(LEVEL bars), and the status coloursinfo,good,warn,muted. - INFO - Enum constant in enum privbot.ui.overlay.PaletteSettings.Slot
- INFO - Static variable in class privbot.ui.overlay.OverlayTheme
-
Lighter than
ModernTheme.ACCENT_INFO: 6.4:1 over the card instead of 4:1. - init(Client, ClientThread) - Static method in class privbot.context.GameThread
-
Connects this class to the client and its client thread.
- initialize() - Method in class privbot.task.StagedTaskRunner
-
Clears active state and execution statistics.
- initialize() - Method in class privbot.task.TaskNodeRunner
-
Initializes (or reinitializes) the runner, clearing all tracking state.
- INLINE - Enum constant in enum privbot.context.GameThreadRouting.Route
-
On the calling thread.
- INLINE_UNINITIALISED - Enum constant in enum privbot.context.GameThreadRouting.Route
-
On the calling thread because this copy was never initialised; warned once per thread.
- inMelee(int, int, int, int, int) - Static method in class privbot.mechanics.Footprint
-
True when (x,y) is under or touching the footprint, so a melee hit can land.
- Inputs(long, PlayerView, CombatStyle, Integer, Integer, Integer, Boolean, Boolean, Boolean, boolean) - Constructor for class privbot.mechanics.PvpFightHistory.Inputs
- INSIDE_GRACE - Enum constant in enum privbot.mechanics.FreezeClock.Move
-
Within
FREEZE_BROKEN_GRACE_TICKSof the graphic: the step already under way when it landed (the drawn tile trails the server's). - install(OverlayManager, boolean, Overlay...) - Static method in class privbot.ui.overlay.PrivBotOverlays
-
PrivBotOverlays.install(OverlayManager, Overlay...), registering the overlays only whenvisible. - install(OverlayManager, Overlay...) - Static method in class privbot.ui.overlay.PrivBotOverlays
-
Register
overlaysnow and return the handle to hide or remove them later. - installSettingsButton(Runnable) - Method in class privbot.ui.PrivBotPanel
-
The standard settings button (
PrivBotPanel.SETTINGS_LABEL), always the same label and colour. - installStartStop(Runnable, Runnable) - Method in class privbot.ui.PrivBotPanel
-
Installs the standardized prominent Start/Stop control at the top of the panel.
- instant(int, Boolean, Boolean, Integer, Integer, int, Integer, Boolean, Boolean, Boolean, Boolean, Integer) - Static method in class privbot.mechanics.GraniteMaulDecision
-
Instant finisher.
- InstantMaulPlan - Class in privbot.mechanics
-
A detached instant-maul proposal over the selected opponent and one fight frame.
- InstantMaulPlan.Plan - Class in privbot.mechanics
- interact(int, int, String) - Method in class privbot.hooks.Widgets
- interact(int, String) - Method in class privbot.hooks.Equipment
-
Interact with a worn item without moving it into inventory.
- interact(int, String) - Method in class privbot.hooks.Widgets
- interact(String) - Method in class privbot.hooks.Widgets
-
Find a visible widget by text / name / action and click it.
- interact(String) - Method in class privbot.wrappers.PrivGroundItem
-
Dispatches a ground-item option on this stack.
- interact(String) - Method in class privbot.wrappers.PrivItem
-
Dispatches
actionon this slot, marshalled throughGameThread.ensure(java.util.function.Supplier<T>, T). - interact(String) - Method in class privbot.wrappers.PrivNPC
-
Dispatches the NPC menu option named
action(exact match first, then the first option containing it, case-insensitive). - interact(String) - Method in class privbot.wrappers.PrivObject
-
Resolves the menu entry by name (e.g.
- interact(String) - Method in class privbot.wrappers.PrivPlayer
-
Dispatches a player option, marshalled through
GameThread.ensure(java.util.function.Supplier<T>, T). - interact(String, boolean) - Method in class privbot.wrappers.PrivObject
- interact(String, String) - Method in class privbot.hooks.GameObjects
-
Interacts with the closest object matching
nameusingaction. - interact(String, String) - Method in class privbot.hooks.Inventory
-
Interacts with the first item matching
nameusingaction. - interact(String, String) - Method in class privbot.hooks.NPCs
-
Interacts with the closest NPC matching
nameusingaction. - interact(String, String) - Method in class privbot.hooks.PlayersHook
-
Interacts with the closest other player matching
nameusingaction. - interact(String, String) - Method in class privbot.hooks.Widgets
-
Find by
query, then clickaction(name then action). - interact(Widget, String) - Method in class privbot.hooks.Widgets
-
Clicks
optiononwidget, using a saved menu action for it when one exists. - interact(ItemContainerSnapshot.Item, String) - Method in class privbot.hooks.Inventory
-
Interact with a detached selection after confirming the slot still holds that item and action.
- interactClosest(String, String...) - Method in class privbot.hooks.GameObjects
-
Interacts with the closest object matching any supplied name.
- interactConfirmed(String, long) - Method in class privbot.hooks.Widgets
-
Same as
Widgets.interactConfirmed(String, String, long)with the default option. - interactConfirmed(String, String, long) - Method in class privbot.hooks.Widgets
-
Clicks like
Widgets.interact(String, String)and then WAITS for the client to show a response: an interface root opening or closing (the server's reply to almost every button — teleport menus, banks, shops, dialogues), the clicked widget disappearing, or a varp changing. - interacting() - Method in class privbot.hooks.LocalPlayer
-
Who the player is interacting with.
- interactingIndex() - Method in class privbot.mechanics.PlayerView
- interactingWith(Actor) - Method in interface privbot.query.PlayerSearch
- interactInspectorPath(String, String) - Method in class privbot.hooks.Widgets
-
Invokes
Widgets.interact(Widget, String)on the leaf reached byWidgets.getByInspectorPath(String). - interactSimpleByText(String, Widgets.MatchMode, String) - Method in class privbot.hooks.Widgets
-
Minimal-parameter widget click for workflows: resolve by visible text, then dispatch using server-appropriate menu shape.
- interactSimpleByWidgetId(int, String) - Method in class privbot.hooks.Widgets
-
Minimal-parameter widget click by flat or packed widget id (same
client.getWidgetlookup asWidgets.interact(int, String)). - interactSlot(int) - Method in class privbot.wrappers.PrivPlayer
- interactText(String) - Method in class privbot.hooks.Widgets
-
Clicks the visible widget whose text is exactly
text, with that text as the option. - interactText(String, String) - Method in class privbot.hooks.Widgets
- interactText(String, String, Widgets.MatchMode) - Method in class privbot.hooks.Widgets
- interactWithoutSavedLibrary(Widget, String) - Method in class privbot.hooks.Widgets
-
Like
Widgets.interact(Widget, String)but never consults the saved menu-action library (no saved NamedMenuAction fallback). - INTERFACE_CHANGED - Enum constant in enum privbot.hooks.Widgets.WidgetEffect
-
Dispatched, and an interface root opened or closed afterwards.
- Internal - Annotation Type in privbot.api
-
Marks a type or member that is
publicfor technical reasons but is NOT part of the supported plugin API, even though it lives in aPublicApipackage. - INTERRUPTED - Enum constant in enum privbot.hooks.Magic.CastOutcome
-
The caller was interrupted (Stop) before the target click.
- INTERRUPTED - Enum constant in enum privbot.movement.pathing.NavigationSession.Result
- invalidate() - Method in class privbot.actions.confirm.ActionTracker
-
Cancel all prior-generation handles on stop, disconnect, death, or session replacement.
- invalidate() - Method in class privbot.hooks.shop.ShopInterface
-
Drops the cached scan so the next query reads the shop again.
- inventory - Variable in class privbot.context.PrivContext
-
Carried items: snapshots, counts and item actions (
ctx.inventory). - inventory - Variable in class privbot.mechanics.ConsumePlanner.State
- inventory - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.inventory. - inventory() - Method in class privbot.mechanics.FightFrame
- Inventory - Class in privbot.hooks
-
Inventory hook backed by the client's inventory snapshots.
- INVENTORY - Enum constant in enum privbot.query.ItemContainerKind
-
The backpack (28 slots).
- INVENTORY_FULL - Enum constant in enum privbot.hooks.bank.WithdrawCapacity.Outcome
-
Room is needed but there is none free.
- INVENTORY_FULL - Enum constant in enum privbot.hooks.bank.WithdrawPlan.Skip
-
No inventory room for it — and it needs room, so it cannot be topped up now.
- INVENTORY_INTERACT - Enum constant in enum privbot.api.Capability
- INVENTORY_ITEMS_WIDGET - Static variable in class privbot.hooks.bank.BankSession
-
The bank-side inventory's packed widget id on Orion, Roat Pkz and SpawnPK (15:3).
- INVENTORY_READ - Enum constant in enum privbot.api.Capability
- INVENTORY_SLOTS - Static variable in class privbot.hooks.bank.WithdrawCapacity
-
Slots in a player inventory.
- InventoryFoodQueries - Class in privbot.hooks
-
Modular inventory food resolution: Inventory query plus Eat (Warden-style), optional name-pattern tier when composition actions are wrong, then item-id fallback.
- invokeLater(Runnable) - Static method in class privbot.context.GameThread
-
Runs
ron the client thread (fire-and-forget). - invokeLater(GameThreadPolicy, GameThreadRouting.Facts) - Static method in class privbot.context.GameThreadRouting
-
Route for
GameThread.invokeLater(java.lang.Runnable). - is(T) - Method in class privbot.api.Observed
-
True only for a VALUE equal to
expected. - isAbsent() - Method in class privbot.api.Observed
- isActive() - Method in class privbot.effects.EffectTracker.TimerView
- isActive() - Method in class privbot.hooks.Recovery
- isActive() - Method in class privbot.ui.ModernTheme.FilterChip
-
Whether the chip is highlighted.
- isActive(String) - Method in class privbot.hooks.Prayer
-
Whether the prayer with this in-game name is active; false also for an unknown name and when unreadable (use
Prayer.observedActive(String)for decisions). - isActualDialog() - Method in class privbot.hooks.Dialogue
- isAlive() - Method in class privbot.wrappers.PrivNPC
-
True if the NPC is alive (not dead).
- isAll() - Method in class privbot.hooks.bank.WithdrawOption
-
True for
Withdraw-All, which has no fixed quantity. - isAnimating() - Method in class privbot.hooks.LocalPlayer
- isAnimating() - Method in class privbot.hooks.User
- isAnyWorkflowRunning() - Static method in class privbot.hooks.Workflows
-
Returns true if any Workflows instance currently has an async workflow running.
- isAt(String) - Method in class privbot.hooks.Places
-
True when the player is within the resolved place's radius.
- isAt(String) - Method in class privbot.hooks.Teleports
-
Whether the player stands at
destination's landing point (Impact: within a few tiles of the catalog's point, same plane). - isAt(String) - Method in class privbot.hooks.Travel
-
Delegates to
Places.isAt(String). - isAutocasting(String) - Method in class privbot.hooks.Magic
-
Whether the exact named spell is selected for autocast.
- isAvailable() - Method in interface privbot.hooks.CombatCollision
- isBankOpen() - Method in class privbot.hooks.Bank
-
Deprecated.use
Bank.isOpen()(orBank.observedOpen()to tell "closed" from "cannot tell") - isClientThread() - Static method in class privbot.context.GameThread
-
Returns true if the current thread is the client (game-tick) thread.
- isClientThread(GameThreadPolicy, GameThreadRouting.Facts) - Static method in class privbot.context.GameThreadRouting
-
Answer for
GameThread.isClientThread(). - isCompatible(String) - Static method in class privbot.api.ApiVersion
-
True when a plugin built against
pluginApiVersionmay run on this runtime (ApiVersion.CURRENT): same major and plugin minor <= runtime minor. - isCompatible(String, String) - Static method in class privbot.api.ApiVersion
-
ApiVersion.isCompatible(String)against an explicit runtime version. - isComplete(C) - Method in class privbot.task.CompositeTaskNode
-
CompositeTaskNode.Strategy.PRIORITY: complete when no enabled child validates. - isComplete(C) - Method in class privbot.task.SimpleNode
-
Always true: a leaf is complete as soon as it has run.
- isComplete(C) - Method in interface privbot.task.TaskNode
-
Checks if the task has completed its current cycle.
- isComplete(ToIntFunction<String>) - Method in class privbot.hooks.bank.WithdrawPlan
-
True only when every line reached its target — numerically, or marked done for an all-line.
- isComplete(ToIntFunction<String>) - Method in class privbot.hooks.shop.BuyPlan
-
True only when every line's inventory target is met, skipped or not.
- isCreationMenuOpen() - Method in class privbot.hooks.Production
-
True when a known creation interface is currently visible.
- isDead() - Method in class privbot.wrappers.PrivNPC
-
True if the NPC is dead (health depleted, death animation playing).
- isDefinitelyOpen() - Method in class privbot.hooks.shop.ShopInterface
-
Strict gate for "should I (re)open the shop?": stale contents are not enough.
- isDone() - Method in interface privbot.movement.pathing.NavigationHandle
- isDose(String) - Method in class privbot.mechanics.BoostDosePolicy
-
Whether
itemNameis a dose of this boost. - isEdtMarshalServer() - Static method in class privbot.context.GameThread
-
True when this server's client reads run on the AWT EDT (Impact, Elorin):
GameThread.ensure(java.util.function.Supplier<T>, T)marshals a read there from any other thread. - isEmpty() - Method in class privbot.hooks.Bank
- isEmpty() - Method in class privbot.hooks.Equipment
- isEmpty() - Method in class privbot.hooks.Inventory
- isEmpty() - Method in class privbot.mechanics.GearSetup
- isEmpty() - Method in class privbot.mechanics.RestockTarget
- isEmpty() - Method in class privbot.ui.overlay.Snapshot
-
True when nothing is published (never published, or cleared).
- isEnabled() - Method in class privbot.task.SimpleNode
-
True unless disabled with
SimpleNode.setEnabled(boolean). - isEnabled() - Method in interface privbot.task.TaskNode
-
Returns whether this task node is enabled.
- isEnabled() - Method in class privbot.ui.overlay.OverlayMoveMode
-
Whether move mode is on.
- isEnterInputOpen() - Method in class privbot.hooks.Dialogue
-
Guard Continue while a native entry prompt owns the chatbox.
- isExpanded() - Method in class privbot.ui.CollapsibleSection
-
Returns whether the section is currently expanded.
- isFalse(Observed<Boolean>) - Static method in class privbot.api.Observed
- isFirstScreenOpen() - Method in class privbot.hooks.Trade
- isFriend(String) - Method in class privbot.hooks.Friends
- isFull() - Method in class privbot.hooks.Inventory
- isHidden(int) - Method in class privbot.hooks.Widgets
-
Whether the widget at
packedIdis missing or hidden. - isHidden(int, int) - Method in class privbot.hooks.Widgets
- isIdle() - Method in class privbot.hooks.User
- isImpact() - Static method in class privbot.context.GameThread
-
True when the active server is Impact, where the game thread is the AWT EDT.
- isInCombat() - Method in class privbot.hooks.Combat
- isInCombat() - Method in class privbot.hooks.User
- isInInstance() - Method in class privbot.hooks.Game
- isKnown() - Method in enum privbot.api.ServerId
-
True for every published server, false for
ServerId.UNKNOWN. - isLegacy(String) - Static method in class privbot.api.ApiVersion
-
True when a plugin declares no API version (null or blank "Plugin-Api-Version").
- isLoggedIn() - Method in class privbot.hooks.Game
- isMovable(String) - Method in class privbot.ui.overlay.OverlayMoveMode
-
Whether
flowId's panel shows the move border. - isMoving() - Method in class privbot.hooks.LocalPlayer
-
Whether the player is moving: the pose animation differs from the idle pose (the same test as
ctx.user.isMoving(), which answers false when it cannot tell). - isMoving() - Method in class privbot.hooks.User
- isMultilineField(Node) - Static method in class privbot.ui.fx.FxFormKit
-
True for a
TextAreaor aFxFormKit.resizableListEditor(double, double, double)wrapper. - isNone() - Method in class privbot.hooks.User.Overhead
-
Readable, and no
HeadIconis drawn. - isNoted() - Method in class privbot.wrappers.PrivItem
-
True when the item definition marks this id as a bank note.
- isOnline(String) - Method in class privbot.hooks.Friends
- isOpen() - Method in class privbot.hooks.Bank
-
Whether the bank reads open.
- isOpen() - Method in class privbot.hooks.Dialogue
-
Returns true if a dialogue is open.
- isOpen() - Method in class privbot.hooks.Shop
-
True if the default shop widget is present and visible.
- isOpen() - Method in class privbot.hooks.shop.ShopInterface
-
True when a stock container with at least one item is live — i.e.
- isOpen() - Method in class privbot.hooks.Trade
- isOpen(int) - Method in class privbot.hooks.Shop
- isOperatorTile(WorldPoint, WorldPoint) - Method in class privbot.movement.pathing.SceneReachability
-
Whether standing on
tilecan operateobject(seeSceneReachability.operatorTile(net.runelite.api.coords.WorldPoint)). - isPackedWidget() - Method in class privbot.hooks.TransportRequest.WidgetPathStep
- isPlayerValid(Player) - Method in class privbot.hooks.Combat
- isPresent() - Method in class privbot.api.Observed
- isQuickPrayersActive() - Method in class privbot.hooks.Prayer
-
Whether quick prayers are on: the client's quick-prayer flag where it can be read (Impact, Elorin, SpawnPK), varbit
Prayer.QUICK_PRAYER_VARBITon Orion. - isReadable() - Method in class privbot.api.Observed
- isReadable() - Method in class privbot.hooks.User.Overhead
- isRunEnabled() - Method in class privbot.hooks.Game
- isRunEnabled() - Method in class privbot.hooks.User
- isRunning() - Method in class privbot.hooks.Workflows
-
Returns true if an async workflow is currently running.
- isRunning() - Method in class privbot.task.ScriptExecutor
-
Returns true if the script thread is alive.
- isRunning() - Method in class privbot.ui.PrivBotPanel
- isSecondScreenOpen() - Method in class privbot.hooks.Trade
- isSelected() - Method in class privbot.ui.ToggleSwitch
-
Whether the switch is on.
- isSpecialAttackActive() - Method in class privbot.hooks.Combat
-
Same as
Combat.isSpecialAttackEnabled()— name aligned with the olderisSpecialAttackActive(). - isSpecialAttackEnabled() - Method in class privbot.hooks.Combat
-
Whether the spec orb is armed (varp on the client thread).
- isStarted() - Method in class privbot.hooks.Capture
- isSuccess() - Method in interface privbot.movement.pathing.NavigationHandle
- isSupported() - Method in class privbot.hooks.Recovery
-
Deprecated.only for the legacy
tick()route;afterDeathworks on every server - isTagged(int) - Method in class privbot.mechanics.TagAllTracker
- isTimerActive(String) - Method in class privbot.effects.EffectTracker
-
Source-compatible local timer helper; UNKNOWN effects require observe(), not this boolean.
- isTrue(Observed<Boolean>) - Static method in class privbot.api.Observed
- isUnreadable() - Method in class privbot.api.Observed
- isUsable() - Method in enum privbot.api.Support
-
True for
Support.SUPPORTEDandSupport.PARTIAL: worth calling. - isViewingOptions() - Method in class privbot.hooks.Dialogue
-
A choice surface, distinct from NPC speech with a Continue prompt.
- isVisible() - Method in class privbot.ui.overlay.OverlaySet
-
Whether the overlays are currently registered with the manager.
- isVisible(int) - Method in class privbot.hooks.Widgets
-
Inverse of
Widgets.isHidden(int)— false when missing, hidden, or thread dispatch fails. - isWidgetInspectorPath() - Method in class privbot.hooks.TransportRequest.WidgetPathStep
- item() - Method in class privbot.mechanics.ConsumePlanner.Action
- item() - Method in class privbot.mechanics.EmergencyConsume.Action
- item() - Method in class privbot.mechanics.PvpArbiter.Action
-
Exact detached inventory item for a planned consume or equip, or null for other actions.
- item() - Method in class privbot.mechanics.StylePlanner.GearPick
- item() - Method in class privbot.mechanics.SustainChoice
- item() - Method in class privbot.mechanics.SustainOutcome
- Item(int, Long, RiskValuation.Disposition, boolean) - Constructor for class privbot.mechanics.RiskValuation.Item
- Item(int, String, int, int, String...) - Constructor for class privbot.hooks.container.ItemContainerSnapshot.Item
- ITEM_CONTAINER_WIDGET - Static variable in class privbot.hooks.bank.BankSession
-
The bank item grid's packed widget id on Orion, Roat Pkz and SpawnPK (12:13).
- ItemContainerKind - Enum in privbot.query
-
Which item container a
PrivItemrow came from; picks the widget an item action is sent to. - ItemContainerSnapshot - Class in privbot.hooks.container
-
Detached item facts, safe to rank on a worker or display on the UI without client access.
- ItemContainerSnapshot(List<ItemContainerSnapshot.Item>, boolean) - Constructor for class privbot.hooks.container.ItemContainerSnapshot
- ItemContainerSnapshot.Item - Class in privbot.hooks.container
-
One occupied slot, by value.
- itemId() - Method in class privbot.hooks.bank.BankSlot
-
Item held here — the
identifierof a withdraw. - itemId() - Method in class privbot.hooks.container.ContainerSlot
-
Item held here — the
identifier. - itemId() - Method in class privbot.hooks.LootDrop
- itemId() - Method in class privbot.hooks.shop.ShopSlot
-
Item held here — the
identifierof a buy. - ItemLines - Class in privbot.hooks.container
-
A list of
(item, quantity)pairs, and the parser that reads one from user text. - ItemLines.Line - Class in privbot.hooks.container
-
One
(item, quantity)pair. - itemName - Variable in class privbot.hooks.bank.WithdrawPlan.Line
- itemName - Variable in class privbot.hooks.container.ItemLines.Line
- itemName - Variable in class privbot.hooks.shop.BuyPlan.Line
- itemName() - Method in class privbot.hooks.bank.BankSlot
-
Display name, or null when the definition could not be resolved.
- itemName() - Method in class privbot.hooks.container.ContainerSlot
-
Display name, or null when the definition could not be resolved.
- itemName() - Method in class privbot.hooks.shop.ShopSlot
-
Display name, or null when the definition could not be resolved.
- ItemQuery - Class in privbot.query
-
Fluent filter chain over inventory-style slot rows wrapped as
PrivItem. - ItemRule(Long, RiskValuation.Disposition, boolean) - Constructor for class privbot.mechanics.RiskValuation.ItemRule
- items - Variable in class privbot.hooks.container.ItemContainerSnapshot
-
The occupied slots, in slot order (unmodifiable).
- items(String) - Method in class privbot.mechanics.LootTally
- ITEMS - Static variable in class privbot.ui.SkillIconManager
-
Key for the items icon (a list).
J
- Job - Interface in privbot.mechanics
-
A multi-tick piece of work a task node drives by calling
Job.step(privbot.task.PrivTaskContext)once per pass until it is finished. - JobState - Enum in privbot.mechanics
-
Where a
Jobstands.
K
- keep() - Method in class privbot.mechanics.GraniteMaulDecision.Decision
- KEEP - Enum constant in enum privbot.mechanics.KnockoutWeaponDecision.Kind
- keeps(String) - Method in class privbot.mechanics.PvpQuery
- keeps(NpcView) - Method in class privbot.mechanics.ThreatQuery
- KEPT - Enum constant in enum privbot.mechanics.OpponentLockPolicy.Event
- key - Variable in class privbot.config.ConfigMigration.Change
- key - Variable in class privbot.ui.fx.FxConfigPageBuilder.SectionRef
-
The section's config key, passed to
FxConfigPageBuilder.forSection(net.runelite.client.config.Config, net.runelite.client.config.ConfigManager, java.lang.String). - key - Variable in class privbot.ui.overlay.PrivBotChatboxOverlayLayout.MetricRow
-
The label, never null.
- key - Variable in class privbot.ui.PrivBotFrame.SectionInfo
-
Unique section id, used by
PrivBotFrame.showSection(String). - key() - Method in interface privbot.config.ConfigMigration.Step
-
The one key this step reads and writes, or null.
- key() - Method in class privbot.mechanics.DamageRow
- key() - Method in class privbot.mechanics.ShotView
-
Identifies this launch:
id:startCycle:endCycle:origin. - key() - Method in class privbot.restock.GroundLoot.Ground
- keyPressed(KeyEvent) - Method in class privbot.hooks.Hotkeys
- keyReleased(KeyEvent) - Method in class privbot.hooks.Hotkeys
- keyTyped(KeyEvent) - Method in class privbot.hooks.Hotkeys
- kills() - Method in class privbot.mechanics.TargetLock
-
Locked NPCs seen dead after they had targeted us or been our current target.
- kills(String) - Method in class privbot.mechanics.LootTally
- kind - Variable in class privbot.hooks.Events.VarChange
-
Varp or varbit.
- kind - Variable in class privbot.hooks.VarRegistry.Entry
-
Varp or varbit.
- kind() - Method in class privbot.mechanics.ConsumePlanner.Action
- kind() - Method in class privbot.mechanics.EmergencyConsume.Action
- kind() - Method in class privbot.mechanics.GearSetup
- kind() - Method in class privbot.mechanics.GraniteMaulDecision.Decision
- kind() - Method in class privbot.mechanics.KnockoutWeaponDecision.Decision
- kind() - Method in class privbot.mechanics.PvpArbiter.Action
- kind() - Method in class privbot.mechanics.PvpMovement.Decision
- kind() - Method in class privbot.mechanics.SustainChoice
- kind() - Method in class privbot.mechanics.SustainOutcome
- KnockoutMath - Class in privbot.mechanics
-
Pure probability calculations adapted from ElorinPvP's KO-risk model; inputs are estimates, not guarantees.
- KnockoutRisk - Class in privbot.mechanics
-
Combines caller-supplied risk estimates with a hit-time estimate.
- KnockoutRisk.Assessment - Class in privbot.mechanics
- KnockoutRisk.Candidate - Class in privbot.mechanics
-
One independently justified possible attack.
- KnockoutWeaponDecision - Class in privbot.mechanics
-
Pure KO-weapon switch timing adapted from the Dharok-mode policy.
- KnockoutWeaponDecision.Decision - Class in privbot.mechanics
- KnockoutWeaponDecision.Kind - Enum in privbot.mechanics
-
KEEP also covers an accepted equip that has not yet appeared in the worn read; it is not a new dispatch.
- KnockoutWeaponPlan - Class in privbot.mechanics
-
Frame-bound gear proposals for the KO-weapon decision.
- KnockoutWeaponPlan.Plan - Class in privbot.mechanics
- known() - Static method in class privbot.mechanics.WeaponSpeeds
-
The keywords the built-in table knows, for a studio hint.
- KV_GRID - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for a key/value grid.
L
- label - Variable in class privbot.actions.confirm.ActionSnapshot
- label - Variable in enum privbot.restock.RestockCycle.Stage
- label - Variable in class privbot.ui.overlay.OverlayPalette
-
The resolved colours, all opaque: card
backgroundandborder,title, rowlabelandvalue,accent(LEVEL bars), and the status coloursinfo,good,warn,muted. - label() - Method in class privbot.hooks.bank.WithdrawOption
-
The label the client renders for this option — carried into the dispatched menu entry.
- label() - Method in class privbot.hooks.shop.ShopOption
-
The exact action string as it appears on the widget — pass this to
Widgets.interact. - label() - Method in class privbot.hooks.User.Overhead
-
The capture-row form: the
HeadIconname,"NONE", ornullwhen unreadable. - label() - Method in class privbot.restock.RestockCycle
-
The HUD's line: the stage, and the stop reason once stopped.
- label() - Method in enum privbot.ui.PanelStatus
-
The default word shown in the badge.
- label(Actor, String, Color, int) - Method in class privbot.ui.overlay.SceneCanvas
-
Shadowed text above an actor (
heightOffsetin scene units; the actor's height works). - label(WorldPoint, String, Color) - Method in class privbot.ui.overlay.SceneCanvas
-
Shadowed text centred over a tile at ground level.
- label(WorldPoint, String, Color, int) - Method in class privbot.ui.overlay.SceneCanvas
-
Shadowed text centred over a tile, raised
heightOffsetscene units; off-screen draws nothing. - LABEL - Enum constant in enum privbot.ui.overlay.PaletteSettings.Slot
- LABEL - Static variable in class privbot.ui.overlay.OverlayTheme
-
Row labels (left column).
- labelBox(int, int, List<String>, Color) - Method in class privbot.ui.overlay.SceneCanvas
-
A translucent box sized to its lines, drawn at a canvas point (debug boxes over NPC heads).
- LANDED - Enum constant in enum privbot.mechanics.DrinkProof.State
- LANDED - Enum constant in enum privbot.mechanics.FoodProof.State
- last() - Static method in class privbot.hooks.BankSeen
-
nullbefore any capture, else{at, items:[{name, qty, slot}]}. - lastCombo - Variable in class privbot.mechanics.ConsumePlanner.State
- lastCycle() - Method in class privbot.mechanics.CueTimeline
-
The held cue's launch cycle, or -1 when empty.
- lastFood - Variable in class privbot.mechanics.ConsumePlanner.State
- lastInteractionTick - Variable in class privbot.mechanics.OpponentLock
- lastPotion - Variable in class privbot.mechanics.ConsumePlanner.State
- lastResult() - Method in class privbot.hooks.Workflows
-
Returns the result of the last completed workflow (true = success).
- lastTargetsUsTick - Variable in class privbot.mechanics.OpponentLock
-
The last tick they targeted us (the lock's own tick when they never have): who is actually hitting us.
- lastTargetsUsTick() - Method in class privbot.mechanics.ThreatMemory.View
- latched - Variable in class privbot.mechanics.SpecialAttackPolicy.State
- latestTick() - Method in class privbot.mechanics.SpecWatch.Result
- launchOffsetCycles() - Method in class privbot.mechanics.AttackCues
- launchOffsetCycles(int) - Method in class privbot.mechanics.AttackCues.Builder
- layer(OverlayLayer) - Method in class privbot.ui.overlay.PrivBotOverlays.PanelBuilder
-
Overlay layer; default
ABOVE_WIDGETS. - layer(OverlayLayer) - Method in class privbot.ui.overlay.PrivBotOverlays.SceneBuilder
-
Overlay layer; default
ABOVE_SCENE. - leadCycles - Variable in class privbot.mechanics.ThreatMemory.Tell
- leadCycles() - Method in class privbot.mechanics.FightObservation.Graphic
- ledger() - Method in class privbot.mechanics.ThreatMemory.View
-
Null when the current hit read is unavailable or no counted hit remains.
- LEDGER - Enum constant in enum privbot.mechanics.IncomingStyleDecision.Source
- LEGACY_FIRST_PARTY - Enum constant in enum privbot.api.ApiVersion.Status
-
No declared version, first-party channel: allowed.
- LEGACY_REFUSED - Enum constant in enum privbot.api.ApiVersion.Status
-
No declared version on any other channel: refused.
- level - Variable in class privbot.hooks.Events.GraphicEvent
-
The plane.
- level(WorldPoint) - Method in class privbot.mechanics.WildernessModel
-
Level at the supplied tile, or null when uncovered, inconsistent, or invalid.
- levels() - Method in class privbot.mechanics.FightFrame
- line(WorldPoint, WorldPoint, Color) - Method in class privbot.ui.overlay.SceneCanvas
-
A 2 px line between two tile centres at ground level; nothing if either end is off-screen.
- Line(String, int) - Constructor for class privbot.hooks.bank.WithdrawPlan.Line
- Line(String, int) - Constructor for class privbot.hooks.container.ItemLines.Line
- Line(String, int) - Constructor for class privbot.hooks.shop.BuyPlan.Line
- lines() - Method in class privbot.hooks.bank.WithdrawPlan
- lines() - Method in class privbot.hooks.shop.BuyPlan
- lines(String...) - Static method in class privbot.ui.overlay.SceneCanvas
-
Convenience for
SceneCanvas.labelBox(int, int, List, Color)callers building lines. - list() - Method in class privbot.query.GraphicsObjectQuery
-
An unmodifiable view of the remaining entries.
- list() - Method in class privbot.query.GroundItemQuery
-
An unmodifiable view of the remaining entries.
- list() - Method in class privbot.query.ItemQuery
-
An unmodifiable view of the remaining rows.
- list() - Method in class privbot.query.NPCQuery
-
An unmodifiable view of the remaining entries.
- list() - Method in class privbot.query.ObjectQuery
-
An unmodifiable view of the remaining entries.
- list() - Method in interface privbot.query.PlayerSearch
- list() - Method in class privbot.query.WidgetQuery
-
An unmodifiable view of the remaining widgets.
- listenerCounts() - Method in class privbot.hooks.Events
-
For diagnostics: the listener counts by kind.
- load(String) - Method in class privbot.hooks.Loadouts
-
Loads a saved setup.
- loadout(int) - Method in class privbot.hooks.Restock.Builder
- LOADOUT - Enum constant in enum privbot.api.Capability
- loadoutNumber - Variable in class privbot.hooks.Restock.Request
-
Impact: the loadout preset to equip (1..6); 0 when unset.
- loadouts - Variable in class privbot.context.PrivContext
-
Equip an in-game loadout preset (Impact; unsupported elsewhere).
- loadouts - Variable in class privbot.task.PrivTaskContext
-
Mirrors
PrivContext.loadouts. - Loadouts - Class in privbot.hooks
-
Gear setups and loadouts:
ctx.loadouts. - loadPreset(int) - Method in class privbot.hooks.Bank
-
Opens the preset panel then selects the preset after a short delay (replaces legacy async preset load).
- loadProfileState(Map<String, Object>) - Method in class privbot.ui.PrivBotFrame
-
Loads profile state into all sections that implement
ProfileStateParticipant. - loadStateFrom(Map<String, Object>) - Method in interface privbot.ui.ProfileStateParticipant
-
Restores the panel's state from a previously saved profile map.
- LOBBY - Enum constant in enum privbot.task.AutomationStage
-
Lobby / rewards / party (lowest band, e.g.
- LOBBY_HIGH - Static variable in class privbot.task.TaskPriorityBands
-
Top of the lobby, rewards and party band (lowest).
- LOBBY_LOW - Static variable in class privbot.task.TaskPriorityBands
-
Bottom of the lobby band.
- local - Variable in class privbot.hooks.Events.AnimationEvent
-
Whether this is the local player.
- local() - Method in class privbot.mechanics.PvpSnapshot
- LOCAL_CLEAR - Enum constant in enum privbot.effects.EffectObservation.Source
-
A caller cleared bookkeeping; this does not establish an in-game effect ending.
- LOCAL_DEATH_EVENT - Enum constant in enum privbot.api.Capability
-
The local player's own death reaching plugins as an event (not by polling the animation).
- LOCAL_PLAYER_READ - Enum constant in enum privbot.api.Capability
- LOCAL_TIMER_ESTIMATE - Enum constant in enum privbot.effects.EffectObservation.Source
-
A caller explicitly started a local timer, for example after a drink attempt.
- localAnimation(Observed<Integer>) - Method in class privbot.hooks.Events.Frame.Builder
- localHitpoints(Observed<Integer>) - Method in class privbot.hooks.Events.Frame.Builder
- localPlayer - Variable in class privbot.hooks.Events.Needs
-
Read the local player (animation, hitpoints, tile).
- LocalPlayer - Class in privbot.hooks
-
The local player, read through the plugin's own adapter:
ctx.player. - localPlayerEastOf() - Method in class privbot.wrappers.PrivNPC
-
True if the local player is strictly east of this NPC (higher X).
- localPlayerEastOf() - Method in class privbot.wrappers.PrivObject
-
True if the local player is strictly east of this object (higher X).
- localPlayerNorthOf() - Method in class privbot.wrappers.PrivNPC
-
True if the logged-in player's tile is strictly north of this NPC (higher map Y, same plane).
- localPlayerNorthOf() - Method in class privbot.wrappers.PrivObject
-
True if the logged-in player's tile is strictly north of this object's tile (higher map Y, same plane).
- localPlayerSouthOf() - Method in class privbot.wrappers.PrivNPC
-
True if the local player is strictly south of this NPC (lower Y).
- localPlayerSouthOf() - Method in class privbot.wrappers.PrivObject
-
True if the local player is strictly south of this object (lower Y).
- localPlayerWestOf() - Method in class privbot.wrappers.PrivNPC
-
True if the local player is strictly west of this NPC (lower X).
- localPlayerWestOf() - Method in class privbot.wrappers.PrivObject
-
True if the local player is strictly west of this object (lower X).
- localSpecPercent() - Method in class privbot.mechanics.PvpSnapshot
- localTile(Observed<WorldPoint>) - Method in class privbot.hooks.Events.Frame.Builder
- location - Variable in class privbot.hooks.Events.GraphicEvent
-
Where it is drawn (scene-local), or null when unreadable.
- location() - Method in class privbot.hooks.LootDrop
- lock - Variable in class privbot.mechanics.PvpFightHistory.Inputs
- lock() - Method in class privbot.mechanics.OpponentLockPolicy.Result
- LOCKED - Enum constant in enum privbot.mechanics.OpponentLockPolicy.Event
- lockedIndex() - Method in class privbot.mechanics.TargetLock
-
The locked NPC's index, or -1 for none.
- lockedTick - Variable in class privbot.mechanics.OpponentLock
- lookup(String) - Method in class privbot.hooks.Vars
-
What a name resolves to on this server, without reading it.
- loot - Variable in class privbot.context.PrivContext
-
Collects wanted ground items as a multi-tick
Job, each pick proved by the inventory count. - loot - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.loot. - Loot - Class in privbot.hooks
-
Picks up the drops a
LootSpecwants, one proved item per step:ctx.loot. - LOOT - Enum constant in enum privbot.api.Capability
-
Looting wanted drops, chosen by name, item id or value, each pick proved by the carried count rising.
- LootDrop - Class in privbot.hooks
-
A ground stack found by the configured-loot scan (
GroundItems.configuredDrop(java.util.function.Predicate<privbot.hooks.LootDrop>, int)) or picked for a Take (GroundItems.takeConfiguredDrop(java.util.function.Predicate<privbot.hooks.LootDrop>, int)). - LootNames - Class in privbot.restock
-
A loot setting as name fragments: "drygore, soul, contract" wants any ground item whose name contains one of them, case-insensitively.
- LootSpec - Class in privbot.mechanics
-
Which ground items are worth picking up: by exact name, by id, or by stack value.
- LootSpec.Builder - Class in privbot.mechanics
-
Builds a
LootSpec. - LootTally - Class in privbot.mechanics
-
Counts kills and loot per NPC name, so a plugin can report what a trip earned.
- LootTally() - Constructor for class privbot.mechanics.LootTally
- lost(List<RiskValuation.Item>, Boolean, Boolean, int, int, boolean) - Static method in class privbot.mechanics.RiskValuation
-
Estimate the value lost using caller-verified death rules and a consistent value source.
- lowestPotionDoseThenLowestSlot() - Static method in class privbot.query.ConsumableSelectionOrder
-
Prefer lowest dose tier (1 sip left) first, then earlier inventory slots for the same tier so one vial is drained via repeated ticks instead of one sip per matching item id.
M
- magic - Variable in class privbot.context.PrivContext
-
Spell casting.
- magic - Variable in class privbot.mechanics.ConsumePlanner.State
- magic - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.magic. - magic() - Method in class privbot.mechanics.CombatLevels
- Magic - Class in privbot.hooks
-
Magic spell casting through the game client.
- MAGIC - Enum constant in enum privbot.mechanics.CombatStyle
- MAGIC - Static variable in class privbot.ui.GearTheme
-
Magic combat-style accent (cyan).
- MAGIC_ATTACK_TICKS - Static variable in class privbot.mechanics.AttackTiming
- MAGIC_CAST - Enum constant in enum privbot.api.Capability
- MAGIC_CHAIN - Static variable in class privbot.mechanics.OffensivePrayerUpkeep
-
Magic offensive prayers, best first.
- MAGIC_DEFAULT - Static variable in class privbot.mechanics.WeaponSpeeds
- Magic.AutocastClick - Enum in privbot.hooks
- Magic.CastOutcome - Enum in privbot.hooks
-
What happened to a cast's target click.
- Magic.CastResult - Class in privbot.hooks
-
A cast's outcome plus, for REFUSED, the gate that held it (the outcome's gate) and, for UNREACHABLE, the name of the reason the action could not be reached.
- Magic.SpellbookTab - Enum in privbot.hooks
-
The magic tab as the client holds it.
- magicReal - Variable in class privbot.mechanics.ConsumePlanner.State
- magicReal() - Method in class privbot.mechanics.CombatLevels
- magicTells(Set<Integer>) - Method in class privbot.mechanics.FightObservation
-
Convert only verified server-specific magic graphic IDs to threat tells.
- MAIN_BODY - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for the studio main body.
- maintain(PrivTaskContext, SustainPlan) - Method in class privbot.hooks.Sustain
-
Does what
plansays is needed right now, if anything. - major() - Method in class privbot.api.ApiVersion
- MAJOR_MISMATCH - Enum constant in enum privbot.api.ApiVersion.Status
-
Different major version: refused.
- make(String) - Method in class privbot.hooks.Production
-
Begin a make request for
product(e.g. - MAKE-interface assumptions: - Search tag in class privbot.hooks.Production
- Section
- MALFORMED - Enum constant in enum privbot.api.ApiVersion.Status
-
A version string that does not parse: refused, never guessed.
- MANIFEST_ATTRIBUTE - Static variable in class privbot.api.ApiVersion
-
shared-lib (runtime) jar manifest attribute that carries
ApiVersion.CURRENT. - map(Function<? super T, ? extends R>) - Method in class privbot.api.Observed
-
Transforms a VALUE.
- markExecuted() - Method in class privbot.task.SimpleNode
-
Records the current time as the last execution timestamp.
- markIdle() - Method in class privbot.task.TaskNodeRunner
-
Clears the active task/status when no node validates during split-thread execution.
- MarkLabel(String, Color) - Constructor for class privbot.ui.ModernTheme.MarkLabel
-
A fixed 28 px tile showing
text(one or two letters) on a tinted square. - markSatisfied(int) - Method in class privbot.hooks.bank.WithdrawPlan
-
Retires an
allline as done. - markTagged(int) - Method in class privbot.mechanics.TagAllTracker
- matches(Predicate<? super T>) - Method in class privbot.api.Observed
-
True only for a VALUE that matches
test. - matches(NpcView) - Method in class privbot.mechanics.TargetSpec
- MAX_FAILURES - Static variable in class privbot.restock.RestockCycle
-
A confirmation that failed this many times on one stage stops the trip with its reason.
- MAX_TAKE_FAILURES - Static variable in class privbot.restock.GroundLoot
-
A Take that never lands is tried this many times, then that item is left (it may belong to someone else).
- MAX_UNCONFIRMED - Static variable in class privbot.mechanics.OffensivePrayerUpkeep
-
Clicks that never showed the prayer on before it is dropped.
- maxBoost(int[], int[]) - Static method in class privbot.mechanics.BoostDosePolicy
-
The largest boost over the paired skills, so one drained skill cannot request another dose while others stay boosted.
- maxHitpoints() - Method in class privbot.hooks.LocalPlayer
- maxHp - Variable in class privbot.mechanics.ConsumePlanner.State
- maxHp() - Method in class privbot.mechanics.ThreatSnapshot
- maximumRetries - Variable in class privbot.movement.pathing.NavigationSession.Policy
- maxLines - Variable in class privbot.ui.overlay.PrivBotChatboxOverlayLayout.MetricRow
-
How many lines the value may wrap over (at least 1).
- maxPicks() - Method in class privbot.mechanics.LootSpec
- maxPicks(int) - Method in class privbot.mechanics.LootSpec.Builder
-
Most items to pick up per visit (default unlimited).
- maxTeleportWildernessLevel - Variable in class privbot.movement.pathing.NavigationOptions
-
Cap every teleport the world planner may use at this wilderness level.
- maxUnplannedWalkDistance - Variable in class privbot.movement.pathing.NavigationOptions
-
Maximum distance for fallback walking when no mapped route exists.
- mayAfford(Integer) - Method in class privbot.mechanics.OpponentEnergy
-
False only when the verified cost exceeds the bound; null for an invalid cost or uninitialised clock.
- maybeTicks(double, int) - Method in class privbot.behavior.Human
-
With probability
chance, sleeps one or more whole game ticks (up tomaxTicks). - mayToggle(PrayerToggleGuard.Toggle, boolean, long) - Static method in class privbot.mechanics.PrayerToggleGuard
- measured(int[]) - Static method in class privbot.mechanics.KnockoutRisk.Candidate
- measuredDamage(String, boolean) - Method in class privbot.hooks.Pvp
-
Historical Elorin PvP capture distribution for a weapon and attack kind.
- measuredDangerLine(int[], Integer, Integer) - Static method in class privbot.mechanics.KnockoutMath
-
Highest HP at which a measured damage distribution exceeds the requested KO probability.
- measuredLag(List<Integer>) - Static method in class privbot.mechanics.OpponentTiming
-
Median lag from at least five valid samples; otherwise zero, the conservative same-tick estimate.
- melee - Variable in class privbot.mechanics.PvpArbiter.Context
- MELEE - Enum constant in enum privbot.mechanics.CombatStyle
- MELEE - Static variable in class privbot.ui.GearTheme
-
Melee combat-style accent (red).
- MELEE_CHAIN - Static variable in class privbot.mechanics.OffensivePrayerUpkeep
-
Melee offensive prayers, best first.
- MELEE_DEFAULT - Static variable in class privbot.mechanics.WeaponSpeeds
-
Used when nothing recognises the weapon (and for a null style).
- meleePlayerTargetsUs - Variable in class privbot.mechanics.PvpFightHistory.Inputs
- meleeProtected - Variable in class privbot.mechanics.PvpFightHistory.Inputs
- memory - Variable in class privbot.context.PrivContext
-
Run-scoped key-value scratchpad; not game state (see
PrivContext.varsfor that). - memory - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.memory. - menuAction(int) - Static method in class privbot.hooks.bank.BankWidgetOps
-
RuneLite's convention for widget ops: 1-5 are
CC_OP, 6-10CC_OP_LOW_PRIORITY. - message - Variable in class privbot.hooks.Events.ChatEvent
-
The message text.
- message() - Method in class privbot.api.ApiVersion.Verdict
-
One sentence or two: what was decided and, for a refusal, what fixes it.
- MIDNIGHT - Enum constant in enum privbot.ui.overlay.PaletteSettings.Scheme
- MIN_LAG_SAMPLES - Static variable in class privbot.mechanics.OpponentTiming
- MIN_SPEC_DROP - Static variable in class privbot.mechanics.SpecEnergy
-
The smallest energy drop that is a spec; any smaller wobble is not (from ElorinPvP).
- MINIMAL - Enum constant in enum privbot.ui.overlay.PaletteSettings.Scheme
- minimum() - Method in class privbot.mechanics.GearSetup.Entry
- minor() - Method in class privbot.api.ApiVersion
- missing() - Method in class privbot.mechanics.OpponentLock
- missing() - Method in class privbot.mechanics.SetupDiff
- missing() - Method in class privbot.mechanics.StylePlanner.Candidate
- mix(long, int) - Static method in class privbot.mechanics.WorldFreeze
-
Folds one value into a fingerprint; order sensitive.
- modal(boolean) - Method in class privbot.ui.fx.FxStudioShell.Builder
-
Ignored — the studio is always non-modal.
- mode - Variable in class privbot.mechanics.ConsumePlanner.Settings
- ModernBadge(String, Color) - Constructor for class privbot.ui.ModernTheme.ModernBadge
- ModernButton(String, Color, Color) - Constructor for class privbot.ui.ModernTheme.ModernButton
- ModernScrollBarUI() - Constructor for class privbot.ui.ModernTheme.ModernScrollBarUI
- ModernTextField() - Constructor for class privbot.ui.ModernTheme.ModernTextField
-
Themed field whose border switches to
ModernTheme.BORDER_FOCUSwhile focused. - ModernTheme - Class in privbot.ui
-
PrivBot UI design system (EasyFlow).
- ModernTheme() - Constructor for class privbot.ui.ModernTheme
-
Static helpers only; protected so legacy themes can extend it.
- ModernTheme.ChipToggle - Class in privbot.ui
-
Chip-style toggle for small filters/sort options.
- ModernTheme.FilterChip - Class in privbot.ui
-
Rule Studio–style filter chip: JButton with active state and rounded rect paint.
- ModernTheme.MarkLabel - Class in privbot.ui
-
Logo/mark label (used in headers, similar to Rule Studio's icon + title).
- ModernTheme.ModernBadge - Class in privbot.ui
-
Badge label with a mutable accent color (useful for live status badges).
- ModernTheme.ModernButton - Class in privbot.ui
-
Modern styled button with hover effects.
- ModernTheme.ModernScrollBarUI - Class in privbot.ui
-
Modern scroll bar UI.
- ModernTheme.ModernTextField - Class in privbot.ui
-
Modern text field with placeholder support.
- ModernTheme.ModernToggle - Class in privbot.ui
-
Modern Toggle Switch (replaces JCheckBox).
- ModernTheme.StyledToggleButton - Class in privbot.ui
-
Toggle button that paints background + text in one pass (no super.paintComponent) to avoid glitch.
- ModernToggle(String) - Constructor for class privbot.ui.ModernTheme.ModernToggle
-
An unselected switch labelled
text. - ModernToggle(String, boolean) - Constructor for class privbot.ui.ModernTheme.ModernToggle
-
A switch labelled
textin the given state. - mountedBook() - Method in class privbot.hooks.Prayer
-
The prayer book the client has mounted:
Prayer.Book.CURSESorPrayer.Book.NORMALwhere the client says which book its prayer tab shows (Elorin),Prayer.Book.UNKNOWNwhen it cannot be read and on every other server. - move(PvpArbiter.Kind, WorldPoint, String) - Static method in class privbot.mechanics.PvpArbiter.Action
-
Construct a close or step-out proposal with its detached destination.
- MOVEMENT - Enum constant in enum privbot.task.AutomationStage
-
Positioning / barrier / off-anchor (e.g.
- MOVEMENT - Static variable in class privbot.task.TaskPriorityBands
-
Positioning: barriers, off-anchor correction.
- movementEntryName() - Method in class privbot.hooks.TransportRequest
- MULTILINE_INPUT - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for the text area inside a resizable list editor.
- MULTILINE_RESIZE_GRIP - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for the drag grip under a resizable list editor.
- MULTILINE_WRAP - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for the resizable list editor wrapper; marks a field as multi-line.
- muted - Variable in class privbot.ui.overlay.OverlayPalette
-
The resolved colours, all opaque: card
backgroundandborder,title, rowlabelandvalue,accent(LEVEL bars), and the status coloursinfo,good,warn,muted. - MUTED - Enum constant in enum privbot.ui.overlay.PaletteSettings.Slot
- MUTED - Static variable in class privbot.ui.overlay.OverlayTheme
-
Values that are merely informational, or "idle".
N
- name - Variable in class privbot.hooks.container.ItemContainerSnapshot.Item
-
The item's name as the player sees it ("" when unknown).
- name - Variable in class privbot.hooks.Events.ChatEvent
-
The sender's name (may carry server markup), or "" for game messages.
- name - Variable in class privbot.hooks.Places.Place
-
The place's name.
- name - Variable in class privbot.hooks.VarRegistry.Entry
-
The canonical name (upper case, underscores).
- name - Variable in class privbot.mechanics.OpponentLock
- name - Variable in class privbot.mechanics.OpponentLockPolicy.Candidate
- name - Variable in class privbot.restock.GroundLoot.Ground
- name - Variable in class privbot.ui.fx.FxConfigPageBuilder.SectionRef
-
Display name, used for the tab and page title.
- name() - Method in class privbot.hooks.LocalPlayer
- name() - Method in class privbot.hooks.LootDrop
- name() - Method in class privbot.mechanics.Destination
- name() - Method in class privbot.mechanics.GearSetup.Entry
- name() - Method in class privbot.mechanics.NpcView
- name() - Method in class privbot.mechanics.PlayerView
- nameContains(String) - Method in class privbot.hooks.container.ItemContainerSnapshot.Item
- named(String...) - Method in class privbot.mechanics.PvpQuery
- named(String...) - Static method in class privbot.mechanics.TargetSpec
-
A spec matching these names.
- named(ItemContainerSnapshot, List<String>) - Static method in class privbot.restock.RestockSupplies
-
Items carried whose name contains any of the names (case-insensitive).
- nameMatches(String) - Method in class privbot.hooks.container.ItemContainerSnapshot.Item
-
A name saved before colour codes were stripped (
"@gre@Coins") still matches "Coins". - names() - Method in class privbot.hooks.container.ItemContainerSnapshot
- names() - Method in class privbot.hooks.Loadouts
- names() - Method in class privbot.hooks.Places
-
All resolvable place names (banks + anchored NPCs) for the current server, plus the "Bank" keyword.
- names() - Method in class privbot.hooks.VarRegistry
- names() - Method in class privbot.hooks.Vars
- names() - Method in class privbot.mechanics.PvpQuery
- names(String...) - Method in class privbot.mechanics.LootSpec.Builder
-
Item names to take (exact, case-insensitive).
- navigate(WorldPoint, NavigationOptions) - Method in interface privbot.movement.pathing.NavigationSession.Driver
- navigateAsync(String, NavigationOptions) - Method in class privbot.hooks.Travel
-
Non-blocking: start navigation to a named place and return the handle.
- NavigationHandle - Interface in privbot.movement.pathing
- NavigationOptions - Class in privbot.movement.pathing
- NavigationOptions() - Constructor for class privbot.movement.pathing.NavigationOptions
- NavigationOptions(NavigationOptions) - Constructor for class privbot.movement.pathing.NavigationOptions
-
Detached options for a session/attempt; caller edits cannot alter an active route.
- NavigationSession - Class in privbot.movement.pathing
-
Bounded, non-blocking navigation lifecycle.
- NavigationSession(NavigationSession.Driver, WorldPoint, NavigationOptions, NavigationSession.Policy) - Constructor for class privbot.movement.pathing.NavigationSession
- NavigationSession.Driver - Interface in privbot.movement.pathing
-
The shared travel facade supplies the driver; tests can supply deterministic observations.
- NavigationSession.Policy - Class in privbot.movement.pathing
- NavigationSession.Result - Enum in privbot.movement.pathing
- navigationTimeoutMs() - Method in class privbot.hooks.TransportRequest
- nearbyPlayers() - Method in class privbot.mechanics.FightObservation
-
Unfiltered players in the NPC scan radius, or null if the scan was unreadable.
- nearest() - Method in class privbot.query.GraphicsObjectQuery
-
Alias of
GraphicsObjectQuery.closest(). - nearest() - Method in class privbot.query.GroundItemQuery
-
Alias of
GroundItemQuery.closest(). - nearest() - Method in class privbot.query.NPCQuery
-
Alias of
NPCQuery.closest(). - nearest() - Method in class privbot.query.ObjectQuery
-
Alias of
ObjectQuery.closest(). - nearest() - Method in interface privbot.query.PlayerSearch
- nearest(String...) - Method in class privbot.hooks.GameObjects
-
Alias of
GameObjects.closest(String...). - nearest(String...) - Method in class privbot.hooks.GroundItems
-
Alias of
GroundItems.closest(String...). - nearest(String...) - Method in class privbot.hooks.NPCs
-
Alias of
NPCs.closest(String...). - nearest(String...) - Method in class privbot.hooks.PlayersHook
-
Alias of
PlayersHook.closest(String...). - nearest(Predicate<GraphicsObject>) - Method in class privbot.query.GraphicsObjectQuery
-
Alias of
GraphicsObjectQuery.closest(Predicate). - nearest(Predicate<Player>) - Static method in class privbot.hooks.PlayersHook
-
Nearest player matching the predicate.
- nearest(Predicate<Player>) - Method in interface privbot.query.PlayerSearch
- nearest(Predicate<PrivGroundItem>) - Static method in class privbot.hooks.GroundItems
-
Static nearest-loot helper that needs no
ctx. - nearest(Predicate<PrivGroundItem>) - Method in class privbot.query.GroundItemQuery
-
Alias of
GroundItemQuery.closest(Predicate). - nearest(Predicate<PrivNPC>) - Static method in class privbot.hooks.NPCs
-
Static lookup that needs no
ctx. - nearest(Predicate<PrivNPC>) - Method in class privbot.query.NPCQuery
-
Alias of
NPCQuery.closest(Predicate). - nearest(Predicate<PrivObject>) - Static method in class privbot.hooks.GameObjects
-
Static lookup that needs no
ctx; preferctx.objects.closest(pred). - nearest(Predicate<PrivObject>) - Method in class privbot.query.ObjectQuery
-
Alias of
ObjectQuery.closest(Predicate). - nearest(WorldPoint, int, Predicate<WorldPoint>, Predicate<WorldPoint>, HazardMap, int, List<NpcView>, int) - Static method in class privbot.mechanics.SafeTiles
-
Searches rings by Chebyshev radius 1..
radiusaroundfrom, skippingfromitself. - nearestTo(WorldPoint, int) - Method in class privbot.movement.pathing.SceneReachability
-
Closest reachable tile inside the candidate's square radius, breaking ties by origin distance.
- nearTile(WorldPoint, int) - Method in class privbot.query.ObjectQuery
-
Chebyshev radius around
tileon the same plane. - Needs(boolean, boolean, boolean, boolean, boolean, boolean, Set<Integer>, Set<Integer>) - Constructor for class privbot.hooks.Events.Needs
- NEEDS_NEWER_RUNTIME - Enum constant in enum privbot.api.ApiVersion.Status
-
Plugin built against a newer minor than this runtime provides: refused.
- NEEDS_SET - Enum constant in enum privbot.mechanics.SpecialAttackPolicy.Phase
- Nesting: - Search tag in class privbot.task.CompositeTaskNode
- Section
- NEVER - Static variable in class privbot.mechanics.Commitment
-
"Never happened".
- NEVER - Static variable in class privbot.mechanics.FreezeClock
-
"Never happened".
- NEVER - Static variable in class privbot.mechanics.KnockoutWeaponDecision
-
Known absence of a prior accepted equip or confirmed fire; null instead denotes unreadable history.
- NEVER - Static variable in class privbot.mechanics.OverheadWatch
-
"Never happened".
- NEVER - Static variable in class privbot.mechanics.SpellEffects
-
"Never happened".
- newDrop() - Method in class privbot.restock.GroundLoot
-
Forgets what was seen and skipped (a new kill, a new Start); the picked total stays until
GroundLoot.reset(). - newFight() - Method in class privbot.mechanics.AttackHistory
-
A new opponent invalidates the old send; our last confirmed fire and eats still describe our timer.
- newFight() - Method in class privbot.mechanics.OwnAttackClock
- newLock() - Method in class privbot.hooks.Targets
- newMap() - Method in class privbot.hooks.Hazards
- nextPossibleHit(int, Integer, Integer, Integer, Integer, Boolean) - Static method in class privbot.mechanics.OpponentTiming
-
Estimated earliest next hit.
- nextPossibleHit(int, Map<String, Integer>) - Method in class privbot.mechanics.OpponentAttackClock
-
A prediction, never a proof: missing or stale data and a possible granite-maul special are due now.
- nextTarget(List<NpcView>, WorldPoint) - Method in class privbot.mechanics.TagAllTracker
-
The NPC to attack next: nearest untagged, else nearest overall, else
null. - NO_FIRE - Enum constant in enum privbot.mechanics.AttackFireDetector.Status
- NO_OBSERVATION - Enum constant in enum privbot.effects.EffectObservation.Source
- NO_OVERHEAD - Static variable in class privbot.mechanics.NpcView
-
NpcView.overhead()when the overhead was read and the NPC shows none. - NO_RESPONSE - Enum constant in enum privbot.hooks.Widgets.WidgetEffect
-
Dispatched, but nothing observable changed within the timeout.
- NO_TARGET_ID - Enum constant in enum privbot.hooks.Magic.CastOutcome
-
The target cannot be addressed (no player, no menu identifier).
- NO_USABLE_OPTION - Enum constant in enum privbot.hooks.bank.WithdrawPlan.Skip
-
The bank offers no withdraw option for the requested amount, so nothing was clicked.
- NODE_ACTION - Static variable in class privbot.ui.ModernTheme
-
Action node accent in flow editors.
- NODE_ACTION_BG - Static variable in class privbot.ui.ModernTheme
-
Action node fill in flow editors.
- NODE_CONDITION - Static variable in class privbot.ui.ModernTheme
-
Condition node accent in flow editors.
- NODE_CONDITION_BG - Static variable in class privbot.ui.ModernTheme
-
Condition node fill in flow editors.
- nodeKey(int) - Static method in class privbot.hooks.Events.ChatEvent
- NOMINAL_HEIGHT - Static variable in class privbot.ui.overlay.OverlayPlacement
-
Height assumed for a panel whose content is unmeasured.
- nonAttackAnimations() - Static method in class privbot.mechanics.ElorinPvpCues
-
Known non-attack animations; the set is not exhaustive.
- none() - Static method in class privbot.mechanics.AttackCues
-
Cues that know nothing: every lookup answers unknown.
- NONE - Enum constant in enum privbot.mechanics.Commitment.Episode
- NONE - Enum constant in enum privbot.mechanics.OpponentLockPolicy.Event
- NONE - Enum constant in enum privbot.mechanics.SpecEnergy.Fired
- NONE - Enum constant in enum privbot.mechanics.SpecWatch.Status
- NONE - Enum constant in enum privbot.mechanics.SustainChoice.Kind
- NONE - Static variable in class privbot.mechanics.PlayerView
-
PlayerView.overhead()orPlayerView.skull()when the read worked and no icon shows. - nonPlaceholder() - Method in class privbot.query.ItemQuery
-
Drops empty or placeholder rows (id 0 or less).
- NORMAL - Enum constant in enum privbot.hooks.Prayer.Book
-
The normal prayer book (Protect from Magic, Piety, ...).
- normalize(String) - Static method in class privbot.hooks.shop.TradeVerb
-
Lowercases and turns hyphens/underscores into spaces, collapsing runs of whitespace, so
"Shop-with","Shop with"and"SHOP_WITH"all compare equal. - normalize(String) - Static method in class privbot.hooks.VarRegistry
-
Canonical spelling: upper case, runs of anything other than letters and digits become one underscore.
- normalizeInlineList(String) - Static method in class privbot.ui.fx.FxFormKit
-
Collapse newlines/extra spaces so config stays one-line comma lists (multi-line editor friendly).
- normalizeRsName(String) - Static method in class privbot.hooks.PlayersHook
-
Strips colour/icon tags and normalises spaces (including the non-breaking space RS names use).
- NOT_DISPATCHED - Enum constant in enum privbot.hooks.Widgets.WidgetEffect
-
The dispatch was not accepted (no visible widget, no dispatch path).
- NOT_FOUND - Enum constant in enum privbot.api.Outcome.Status
-
The target (item, NPC, object, slot) was not there.
- NOT_IN_BANK - Enum constant in enum privbot.hooks.bank.WithdrawPlan.Skip
-
The bank holds none of this item.
- NOT_IN_OPEN_BOOK - Enum constant in enum privbot.hooks.Magic.AutocastClick
-
The magic tab is open and does not draw the spell (another spellbook): nothing was sent.
- NOT_READY - Enum constant in enum privbot.api.Outcome.Status
-
The game is not in a state where this can be sent yet (interface closed, not logged in).
- NOT_SENT - Enum constant in enum privbot.hooks.Magic.AutocastClick
-
Nothing was sent for any other reason: the flag on (1) or unreadable, the click or the flag not supported on this server, the book not shown, or the spell's visibility unanswerable.
- NOT_SOLD_HERE - Enum constant in enum privbot.hooks.shop.BuyPlan.Skip
-
The shop does not stock this item at all.
- notCarried() - Method in class privbot.mechanics.SwitchResult
- note(String) - Static method in class privbot.hooks.SessionAccount
-
The logged-in player's name as the feeder reads it.
- note(Capability) - Method in interface privbot.api.Capabilities
-
What a plugin author needs to know about this capability here: which cases work for a partial one, why an unsupported one fails, or that nothing is known.
- notFighting() - Method in class privbot.mechanics.ThreatMemory.View
-
Null when targeting or hit evidence is insufficient to decide.
- notFound(String) - Static method in class privbot.api.Outcome
- nothing() - Method in class privbot.hooks.Events.Needs
- nothing(String) - Static method in class privbot.mechanics.SustainOutcome
-
Nothing was due.
- NOTHING - Enum constant in enum privbot.mechanics.SustainOutcome.Kind
- NOTHING_WANTED - Enum constant in enum privbot.restock.GroundLoot.Outcome
- nothingToSend() - Static method in class privbot.mechanics.SwitchResult
- notifyDeath() - Method in class privbot.hooks.Recovery
-
Deprecated.use
Recovery.afterDeath(RecoveryPlan), which re-arms the Impact reclaim itself - notifyOnDeath(Events) - Method in class privbot.hooks.Recovery
-
Registers
Recovery.notifyDeath()on the polled death event. - notReady(String) - Static method in class privbot.api.Outcome
- NPC_ATTACK - Enum constant in enum privbot.api.Capability
- NPC_INTERACT - Enum constant in enum privbot.api.Capability
- NPC_READ - Enum constant in enum privbot.api.Capability
- npcAction() - Method in class privbot.hooks.TransportRequest
- NpcAnimation(int, int, int, Actor) - Constructor for class privbot.hooks.Events.NpcAnimation
- npcAnimations - Variable in class privbot.hooks.Events.Needs
-
Read NPC animations.
- npcAnimations(List<Events.NpcAnimation>) - Method in class privbot.hooks.Events.Frame.Builder
- NpcAttackerEvidence - Class in privbot.mechanics
-
Detached result of a bounded NPC attacker scan.
- NpcAttackerEvidence(int, boolean, Boolean) - Constructor for class privbot.mechanics.NpcAttackerEvidence
-
The scanner must report completeness only if no potentially relevant NPC was skipped.
- npcAttackers() - Method in class privbot.mechanics.FightObservation
-
A bounded NPC scan from the frame's batch, or null when no scan was available.
- npcId - Variable in class privbot.hooks.Events.AnimationEvent
-
The NPC's id, or -1 for the local player or when unreadable.
- npcIndex - Variable in class privbot.hooks.Events.AnimationEvent
-
The NPC's index (slot), or -1 for the local player.
- npcName() - Method in class privbot.hooks.TransportRequest
- NPCQuery - Class in privbot.query
-
Fluent filter chain over the NPCs in the scene, built by
ctx.npcs.query(). - NPCQuery(List<PrivNPC>, Client) - Constructor for class privbot.query.NPCQuery
-
Wraps a copy of
raw; plugins normally get a query fromctx.npcs.query(). - npcs - Variable in class privbot.context.PrivContext
-
NPC queries and NPC interactions (
ctx.npcs.query()). - npcs - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.npcs. - npcs() - Method in class privbot.mechanics.ThreatSnapshot
- npcs(TargetSpec) - Method in class privbot.mechanics.ThreatQuery
- NPCs - Class in privbot.hooks
-
Snapshot NPC hook: call
NPCs.query()for a fluentNPCQuery(filters, closest, player north/south/east/west). - npcSize(NPC) - Method in class privbot.hooks.Combat
-
Current transformed footprint size; unavailable definitions conservatively use one tile.
- npcSpec() - Method in class privbot.mechanics.ThreatQuery
- NpcView - Class in privbot.mechanics
-
One NPC reduced to what targeting and hazard maths need.
- NpcView(int, int, String, int, int, int, int, int, WorldPoint, boolean, boolean, boolean, String) - Constructor for class privbot.mechanics.NpcView
- NpcView(int, int, String, int, int, int, int, int, WorldPoint, Boolean, Boolean, boolean, String) - Constructor for class privbot.mechanics.NpcView
-
Nullable targeting observations: null means the client's interaction data was unreadable.
O
- OBJECT_INTERACT - Enum constant in enum privbot.api.Capability
- OBJECT_READ - Enum constant in enum privbot.api.Capability
- objectAction() - Method in class privbot.hooks.TransportRequest
- objectName() - Method in class privbot.hooks.TransportRequest
- ObjectQuery - Class in privbot.query
-
Fluent filter chain over scene objects (walls, decorations, ground objects and game objects), built by
ctx.objects.query(). - ObjectQuery(List<PrivObject>, Client) - Constructor for class privbot.query.ObjectQuery
-
Wraps a copy of
raw; plugins normally get a query fromctx.objects.query(). - objects - Variable in class privbot.context.PrivContext
-
Scene object queries and interactions (
ctx.objects.query()). - objects - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.objects. - observation() - Method in class privbot.mechanics.PvpFightHistory.View
- observe() - Method in class privbot.hooks.Pvp.FightObserver
-
Batch one frame and new local events.
- observe(int) - Method in class privbot.mechanics.OpponentEnergy
-
Advance time without claiming any unseen special did or did not occur.
- observe(int, long) - Method in class privbot.mechanics.BoostDosePolicy
-
False means a confirmed dose never produced an observable boost; do not drink repeatedly.
- observe(int, long) - Method in class privbot.mechanics.WorldFreeze
- observe(int, long, PlayerView, Integer) - Method in class privbot.mechanics.OpponentAttackClock
-
Fold one opponent observation.
- observe(int, long, PlayerView, Integer, Integer) - Method in class privbot.mechanics.OpponentAttackClock
-
As above, with damage independently attributed to this opponent (including 0); null means no attributed hit was supplied.
- observe(int, Boolean, Boolean) - Method in class privbot.mechanics.AttackExpiryTracker
-
Fold one tick.
- observe(int, Integer, Boolean) - Method in class privbot.mechanics.SpecWatch
-
Observe a percent and orb state; null means unreadable.
- observe(int, Integer, Integer, Boolean, Integer) - Method in class privbot.mechanics.AttackFireDetector
-
One sample.
- observe(int, Integer, ItemContainerSnapshot) - Method in class privbot.mechanics.HealthHistory
-
Record one detached sample; a missing inventory does not mean an empty one.
- observe(int, Long, Integer, Boolean, CombatStyle, List<ThreatMemory.Hit>, List<ThreatMemory.Tell>, Boolean, Integer, Boolean, boolean) - Method in class privbot.mechanics.ThreatMemory
-
Fold one tick.
- observe(int, String) - Method in class privbot.mechanics.OverheadWatch
-
One tick's reading of their overhead name.
- observe(int, List<OpponentLockPolicy.Candidate>, Boolean, Boolean) - Method in class privbot.mechanics.OpponentLockTracker
-
All facts must come from this tick.
- observe(int, ItemContainerSnapshot) - Method in class privbot.mechanics.DrinkProof
-
A later lower dose total is proof of a change; timeout never means the click was refused.
- observe(int, ItemContainerSnapshot) - Method in class privbot.mechanics.FoodProof
-
A later observed drop proves the count changed.
- observe(int, SetupDiff) - Method in class privbot.mechanics.SwitchCheck
-
One tick's verdict on the outstanding switch.
- observe(Integer, Integer, WorldPoint, int) - Method in class privbot.mechanics.DeathWatch
-
Feeds one tick.
- observe(String) - Method in class privbot.effects.EffectTracker
- observe(String, boolean, int) - Method in class privbot.mechanics.OffensivePrayerUpkeep
-
This tick's read of the prayer being kept.
- observe(List<ShotView>, Map<Integer, CombatStyle>, ThreatMemory.View, Boolean, CombatStyle) - Static method in class privbot.mechanics.IncomingStyleDecision
-
Classify the earliest avoidable projectile aimed at the player (more than 21 and at most 60 cycles left), then apply
IncomingStyleDecision.choose(java.lang.Boolean, privbot.mechanics.CombatStyle, java.lang.Boolean, java.lang.Boolean, privbot.mechanics.CombatStyle, privbot.mechanics.CombatStyle). - observe(FightFrame) - Method in class privbot.mechanics.HealthHistory
-
Record the HP and inventory in one detached fight frame.
- observe(FightFrame, Boolean, Integer) - Method in class privbot.mechanics.OwnAttackClock
-
Fold one detached frame.
- observe(FightObservation, Long, PlayerView, CombatStyle, Set<Integer>, Boolean, Integer, Boolean, boolean) - Method in class privbot.mechanics.ThreatMemory
-
Fold an observer's same-tick frame and events.
- observe(FightObservation, PvpFightHistory.Inputs, Map<Integer, CombatStyle>) - Method in class privbot.mechanics.PvpFightHistory
-
Fold a sample before recording sends from its plan.
- observe(FightObservation, ThreatMemory.View, Map<Integer, CombatStyle>, int, CombatStyle) - Static method in class privbot.mechanics.IncomingStyleDecision
-
Apply incoming-style selection to one observation and its same-tick threat memory.
- Observed<T> - Class in privbot.api
-
The result of one read of game state, with "could not read it" kept apart from every real answer.
- Observed.State - Enum in privbot.api
-
Which of the three answers a read gave.
- observedActive(String) - Method in class privbot.hooks.Prayer
-
Whether the prayer with this in-game name ("Protect from Melee") is on, with "cannot tell" kept apart:
Prayer.isActive(String)answers false for that, and a guard that re-toggles a prayer it cannot read turns it OFF. - observedBoosted(String) - Method in class privbot.hooks.Skills
-
Skills.observedBoosted(Skill)by in-game name. - observedBoosted(Skill) - Method in class privbot.hooks.Skills
-
The current (boosted or drained) level as an
Observed; UNREADABLE as forSkills.observedReal(Skill). - observedCanContinue() - Method in class privbot.hooks.Dialogue
-
Whether a "Continue" surface is shown, or UNREADABLE when the read could not be made (
Dialogue.canContinue()answers false for that). - observedEnterInputOpen() - Method in class privbot.hooks.Dialogue
-
Whether an enter-amount / enter-text prompt owns the chatbox, or UNREADABLE when that cannot be read.
- observedInInstance() - Method in class privbot.hooks.Game
-
Observed instance state, or null when its mapped field/read is unavailable.
- observedLevel(Skill, boolean) - Method in class privbot.hooks.Skills
-
Nullable observation for decisions that must distinguish missing skill data from zero: null when the level cannot be read or has not arrived from the server yet.
- observedOpen() - Method in class privbot.hooks.Bank
-
Whether the bank interface is drawn, or UNREADABLE when that cannot be told.
- observedOpen() - Method in class privbot.hooks.Dialogue
-
Whether a dialogue is open, or UNREADABLE when the read could not be made.
- observedQuickPrayersActive() - Method in class privbot.hooks.Prayer
-
Whether quick prayers are on, or UNREADABLE where
Prayer.isQuickPrayersActive()would log UNSUPPORTED and answer false (this client's quick-prayer flag cannot be read, or Orion's varbit could not be read). - observedReal(String) - Method in class privbot.hooks.Skills
-
Skills.observedReal(Skill)by in-game name ("Attack", "Hitpoints"). - observedReal(Skill) - Method in class privbot.hooks.Skills
-
The base (real) level as an
Observed: UNREADABLE when this client's skill levels cannot be read or have not arrived from the server yet, never a placeholder 99 or a 0. - observedRunEnabled() - Method in class privbot.hooks.Game
-
Observed run mode, or null when its mapped field/read is unavailable.
- observedRunEnergy() - Method in class privbot.hooks.Game
-
Observed run energy in percent (0..100), or null when unavailable or invalid.
- observedSpecialAttackArmed() - Method in class privbot.hooks.Combat
-
Whether the special attack orb is armed as an
Observed:Combat.specialAttackArmedOrNull()with its null turned into UNREADABLE. - observedSpecialAttackPercent() - Method in class privbot.hooks.Combat
-
Special attack energy 0–100 as an
Observed:Combat.specialAttackPercentOrNull()with its null turned into UNREADABLE (never the 0Combat.getSpecialAttackPercent()answers for that). - observedTargetsOther() - Method in class privbot.mechanics.NpcView
- observedTargetsUs() - Method in class privbot.mechanics.NpcView
- observedTicksSince(int) - Method in class privbot.hooks.Game
-
Ticks elapsed since
earlierTick(a value an earlierGame.tick()returned). - observedVarbit(int) - Method in class privbot.hooks.Vars
-
A varbit's value, or UNREADABLE when it cannot be read: this client's varbits cannot be read, the id has no definition on this client, or its varp is out of range.
- observedVarp(int) - Method in class privbot.hooks.Vars
-
A varp's value, or UNREADABLE when it cannot be read.
- observeLocal(int, Integer, Integer) - Method in class privbot.mechanics.SpellEffects
-
One tick's reading of our own graphic and animation; null is unreadable.
- observeLocalDamage(int, Integer) - Method in class privbot.mechanics.SpellEffects
-
A hit on us this tick.
- observeOpponent(String, int, Integer, Integer) - Method in class privbot.mechanics.SpellEffects
-
One tick's reading of an opponent's graphic and animation; a null name, graphic or animation changes nothing.
- observeOpponentDamage(String, int, Integer) - Method in class privbot.mechanics.SpellEffects
-
Our hit on an opponent this tick.
- of(int) - Method in class privbot.ui.overlay.ColorRamp
-
The colour for a plain
value(a tick count, a percentage). - of(int) - Method in interface privbot.ui.overlay.ColorRamp.Rule
-
The colour for
value; must not return null. - of(int, int) - Method in class privbot.ui.overlay.ColorRamp
-
The colour for
valueout ofmax, evaluated as a percentage;max <= 0= -1. - of(int, int, int, boolean, boolean) - Static method in class privbot.hooks.bank.WithdrawCapacity
- of(String, int) - Static method in class privbot.hooks.bank.WithdrawOption
-
A fixed-quantity option.
- of(String, int) - Static method in class privbot.hooks.shop.ShopOption
-
An option built from a known quantity rather than parsed from a widget.
- of(String, Object...) - Static method in class privbot.hooks.TransportRequest
-
Movement catalog entry name plus widget path steps.
- of(Collection<VarRegistry.Entry>) - Static method in class privbot.hooks.VarRegistry
-
Builds a registry from explicit entries (tests, or a plugin's own captured names).
- of(Client) - Static method in class privbot.ui.overlay.SceneProjection
-
The projection for
client, using whichever projection that client needs. - of(ConfigManager, String) - Static method in class privbot.config.ConfigMigration
-
groupof a live ConfigManager: reads and writes go through the manager, andConfigMigration.ConfigAccess.saved(java.lang.String)reads the properties file it saves to (ConfigMigration.savedIn(privbot.config.ConfigMigration.ConfigAccess, java.nio.file.Path, java.lang.String)). - of(Outcome.Status, String) - Static method in class privbot.api.Outcome
-
Any status with a reason.
- of(ColorRamp.Rule) - Static method in class privbot.ui.overlay.ColorRamp
-
A ramp from any rule, e.g.
- of(PaletteSettings) - Static method in class privbot.ui.overlay.OverlayPalette
-
The palette a plugin's user chose: the built-in scheme's colours, or for
PaletteSettings.Scheme.CUSTOMClassic's with each colour the settings give put in its place. - of(S) - Static method in class privbot.ui.overlay.Snapshot
-
A snapshot that starts with
initial(may be null). - of(T) - Static method in class privbot.api.Observed
-
A successful read holding
value. - OFF - Enum constant in enum privbot.mechanics.SpecialAttackPolicy.Phase
- OFFENSIVE_PRAYER - Enum constant in enum privbot.mechanics.PvpArbiter.Kind
- OffensivePrayerUpkeep - Class in privbot.mechanics
-
Which offensive prayer to keep on, and when to give one up.
- OffensivePrayerUpkeep() - Constructor for class privbot.mechanics.OffensivePrayerUpkeep
- offer(CombatStyle, int) - Method in class privbot.mechanics.CueTimeline
-
Accepts the cue when nothing is held or
launchCycleis later than the held one. - offerAll(int, int) - Method in class privbot.hooks.Trade
-
Offers the entire stack in one inventory slot on the first trade screen.
- offerAll(int, int, String) - Method in class privbot.hooks.Trade
-
Offers a whole stack from the trade screen's inventory, the way the client's own Offer-All click is sent.
- offerAll(String) - Method in class privbot.hooks.Trade
-
Offers the first inventory stack matching
name. - offeredItemIds() - Method in class privbot.hooks.Production
-
Exact product IDs currently offered by Elorin's native creation menu; empty when closed.
- ofNullable(T, String) - Static method in class privbot.api.Observed
-
Converts an existing nullable read whose
nullmeans "could not read" (the convention ofSkills.observedLevel,Game.observedRunEnabledand the otherobserved*reads that predate this class). - ofPresentOrAbsent(T) - Static method in class privbot.api.Observed
-
Converts a read whose
nullgenuinely means "observed: nothing there" (a resolved interacting target on a client where the read itself cannot fail). - ok() - Static method in class privbot.api.Outcome
-
The action was sent.
- ok(String) - Static method in class privbot.api.Outcome
-
The action was sent;
detailsays what was sent (for logs). - onAnimation(Consumer<Events.AnimationEvent>) - Method in class privbot.hooks.Events
- onCancel(Runnable) - Method in class privbot.ui.fx.FxStudioShell.Builder
-
Runs on the Swing EDT before the window is closed.
- once(Object, Supplier<T>) - Static method in class privbot.context.ReadScope
-
Returns the value cached under
keyin the current scope, reading it once on first use. - onChat(Consumer<Events.ChatEvent>) - Method in class privbot.hooks.Events
- onClientThread() - Method in interface privbot.context.GameThreadRouting.Facts
-
client != null && client.isClientThread(). - onClientThread(Supplier<T>) - Method in class privbot.context.PrivContext
-
Runs
fnon the client thread and returns the result. - onClientThread(Supplier<T>) - Method in class privbot.task.PrivTaskContext
-
GameThread.ensure(Supplier): runsfnon the client thread and returns its result, ornullwhen the read could not be served. - onDisconnect() - Method in class privbot.task.TaskNodeRunner
-
Pauses the owned worker and requests a node reset on the next cycle.
- onDrag(Point) - Method in class privbot.ui.overlay.OverlayMoveMode
-
A drag: moves or resizes the pressed panel.
- onEdt() - Method in interface privbot.context.GameThreadRouting.Facts
-
The caller is the AWT event dispatch thread.
- onEdt(Supplier<T>) - Static method in class privbot.ui.PluginUi
-
Run
workon the EDT and return its result (inline when already on the EDT). - One plugin model - Search tag in class privbot.sdk.PrivBotAPI
- Section
- onGameMessage(ChatMessageType, String) - Method in class privbot.effects.EffectTracker
-
Bounded chat capture, including Elorin's flask and death messages.
- onGameThread() - Method in interface privbot.context.GameThreadRouting.Facts
-
The caller is that identified game thread.
- onGameTick() - Method in class privbot.hooks.Events
-
Reads one frame and dispatches the listeners.
- onGameTick() - Method in class privbot.task.TaskNodeRunner
-
Game-tick pulse.
- onGraphic(Consumer<Events.GraphicEvent>) - Method in class privbot.hooks.Events
- onHitsplat(Consumer<Events.HitsplatEvent>) - Method in class privbot.hooks.Events
- onLocalDeath(Consumer<Events.DeathEvent>) - Method in class privbot.hooks.Events
-
The local player died, detected by polling (never by
@Subscribe). - onLocalPlayer - Variable in class privbot.hooks.Events.HitsplatEvent
-
Whether the actor is the local player.
- onPress(Point) - Method in class privbot.ui.overlay.OverlayMoveMode
-
A press: starts a move (or a resize on the corner handle).
- onProjectile(Consumer<Events.ProjectileEvent>) - Method in class privbot.hooks.Events
- onReconnect() - Method in class privbot.task.TaskNodeRunner
-
Resumes after disconnect with a 5-tick grace window.
- onReconnect(int) - Method in class privbot.task.TaskNodeRunner
-
Resumes after disconnect with
graceTicksof idle ticks. - onRefresh() - Method in class privbot.ui.PrivBotFrame
-
Called periodically by the refresh timer.
- onRelease(Point) - Method in class privbot.ui.overlay.OverlayMoveMode
-
A release: ends the drag.
- onSave(Runnable) - Method in class privbot.ui.fx.FxStudioShell.Builder
-
Runs on the Swing EDT before the window is closed.
- onVarbit(int, Consumer<Events.VarChange>) - Method in class privbot.hooks.Events
-
Watches one varbit (the client's own id: see
Vars.observedVarbit(int)). - onVarp(int, Consumer<Events.VarChange>) - Method in class privbot.hooks.Events
-
Watches one varp.
- opacity(int) - Method in class privbot.ui.overlay.PrivBotOverlayPanel
-
Background opacity in percent (clamped 0..100); colour stays
OverlayTheme.CARD_BG's. - open() - Method in class privbot.hooks.Bank
- open(String) - Method in class privbot.hooks.Shop
-
Opens an NPC's shop using
"Trade"as the default action. - open(String, String) - Method in class privbot.hooks.Shop
- open(String, String, int, long) - Method in class privbot.hooks.Shop
-
Interacts with the nearest NPC matching
npcNameusingaction, then waits up totimeoutMsfor the shop widget to appear. - OPEN - Enum constant in enum privbot.hooks.Magic.SpellbookTab
-
selectedTab == TAB_MAGIC: never click the tab again (the client would toggle the panel). - openAndSell(String, String, int, List<String>, boolean, boolean, String, int) - Method in class privbot.hooks.Shop
-
Opens the NPC's shop, waits
postOpenDelayTicksgame ticks, then sells items. - openNearestBank() - Method in class privbot.hooks.Bank
-
Opens the nearest bank booth, chest, or banker.
- openOutcome() - Method in class privbot.hooks.Bank
-
Bank.open()with an explicit outcome. - openPresetInterface() - Method in class privbot.hooks.Bank
-
Opens the bank preset tab.
- openSpellbook() - Method in class privbot.hooks.Magic
-
Opens the book without waiting: one TAB_SELECT on a readable closed book, nothing otherwise, and never a sleep.
- openState() - Method in class privbot.hooks.shop.ShopInterface
-
Three-valued "is the shop on screen?" — TRUE drawn, FALSE definitely not, null unanswerable.
- openTab(String) - Method in class privbot.hooks.Game
-
Open a named side tab.
- openWith(int, String) - Method in class privbot.hooks.Production.Make
-
Open the creation interface by using inventory item
itemIdon objectobject. - operatorTile(WorldPoint) - Method in class privbot.movement.pathing.SceneReachability
-
The reachable tile to operate a 1x1 object such as a lever from, or null.
- opponent - Variable in class privbot.mechanics.PvpFightHistory.Inputs
- opponent() - Method in class privbot.mechanics.InstantMaulPlan.Plan
-
Detached target identity for the attack resend; resolve it again before dispatch.
- opponent() - Method in class privbot.mechanics.OpponentLockPolicy.Result
- opponent() - Method in class privbot.mechanics.PvpFightHistory
-
Prediction based on observed opponent swings; it never proves the next hit cannot arrive earlier.
- opponent() - Method in class privbot.mechanics.PvpFightHistory.View
-
The opponent bound to this observation, or null while a retained lock is missing.
- opponent() - Method in class privbot.mechanics.PvpFinisherCoordinator.Plan
- opponent() - Method in class privbot.mechanics.PvpMaulCoordinator.Plan
- OPPONENT - Enum constant in enum privbot.mechanics.IncomingStyleDecision.Source
- opponentAnimations() - Static method in class privbot.mechanics.ElorinPvpCues
-
Known opponent attack animations.
- OpponentAttackClock - Class in privbot.mechanics
-
Conservative observed-swing timing for one locked opponent.
- OpponentAttackClock(Map<Integer, CombatStyle>, Set<Integer>, Set<Integer>) - Constructor for class privbot.mechanics.OpponentAttackClock
- opponentCycle - Variable in class privbot.mechanics.PvpFightHistory.Inputs
- opponentEligible(int, ThreatMemory.View, Boolean, Boolean) - Static method in class privbot.mechanics.IncomingStyleDecision
-
Determine whether the opponent's predicted style can explain recent hits.
- opponentEligible(FightObservation, ThreatMemory.View, int) - Static method in class privbot.mechanics.IncomingStyleDecision
-
Combine same-batch bounded NPC and unfiltered player observations for the named locked player.
- OpponentEnergy - Class in privbot.mechanics
-
Conservative upper bound for an opponent's special energy, based only on independently confirmed spends and caller-supplied regeneration rules.
- OpponentEnergy(int, int) - Constructor for class privbot.mechanics.OpponentEnergy
-
The caller supplies the verified server's regeneration amount and period; neither is assumed cross-server.
- opponentFreezeImmune(String, int) - Method in class privbot.mechanics.SpellEffects
- opponentFrozen(String, int) - Method in class privbot.mechanics.SpellEffects
- OpponentLock - Class in privbot.mechanics
-
The locked opponent.
- OpponentLock(int, String, int, int, int) - Constructor for class privbot.mechanics.OpponentLock
- OpponentLock(int, String, int, int, int, int) - Constructor for class privbot.mechanics.OpponentLock
- OpponentLockPolicy - Class in privbot.mechanics
-
Detached opponent-lock selection.
- OpponentLockPolicy.Candidate - Class in privbot.mechanics
-
Facts about one observed player.
- OpponentLockPolicy.Event - Enum in privbot.mechanics
- OpponentLockPolicy.Result - Class in privbot.mechanics
- OpponentLockTracker - Class in privbot.mechanics
-
Single-owner opponent lock history.
- OpponentLockTracker(int, int, boolean, int) - Constructor for class privbot.mechanics.OpponentLockTracker
- opponentPresent - Variable in class privbot.mechanics.SpecialAttackPolicy.State
- opponents() - Method in class privbot.mechanics.PvpSnapshot
- opponentTeleblocked(String, int) - Method in class privbot.mechanics.SpellEffects
- OpponentTiming - Class in privbot.mechanics
-
Pure timing rules adapted from ElorinPvP's opponent clock; no client reads or claimed hit observations.
- opponentVengeance(String, int) - Method in class privbot.mechanics.SpellEffects
-
Whether the opponent's Vengeance is up: seen cast, and not yet used by our damaging hit on them.
- opponentWeapon - Variable in class privbot.mechanics.PvpFightHistory.Inputs
- options() - Method in class privbot.hooks.Production
-
Product names visible in the currently-open creation interface (best-effort).
- or(Supplier<Observed<T>>) - Method in class privbot.api.Observed
-
Falls back to another read only when this one is UNREADABLE (a second source for the same fact).
- orElse(T) - Method in class privbot.api.Observed
- orElseGet(Supplier<? extends T>) - Method in class privbot.api.Observed
- origin - Variable in class privbot.movement.pathing.SceneReachability
- origin() - Method in interface privbot.hooks.CombatCollision
- origin() - Method in class privbot.mechanics.ShotView
- ORION - Enum constant in enum privbot.api.ServerId
- orNull() - Method in class privbot.api.Observed
-
The value or null.
- OSRS_DEATH_ANIMATION - Static variable in class privbot.hooks.Events
-
OSRS player death animation.
- osrsAnimation(int) - Method in interface privbot.api.Ids
-
The OSRS animation id for this server's animation
serverId. - osrsGraphic(int) - Method in interface privbot.api.Ids
-
The OSRS graphic id for this server's graphic
serverId. - osrsVarbit(int) - Method in interface privbot.api.Ids
-
The OSRS varbit id for this server's varbit
serverId. - OTHER - Enum constant in enum privbot.mechanics.GearSetup.Role
- OTHER_TAB - Enum constant in enum privbot.hooks.Magic.SpellbookTab
-
Another tab is selected; one TAB_SELECT opens the book.
- otherAttacker() - Method in class privbot.mechanics.NpcAttackerEvidence
-
True when an NPC is known to attack us, false only when the complete scan rules that out, null otherwise.
- otherEpisode - Variable in class privbot.mechanics.SpecialAttackPolicy.State
- OUT_OF - Enum constant in enum privbot.mechanics.SustainChoice.Kind
- OUT_OF - Enum constant in enum privbot.mechanics.SustainOutcome.Kind
- OUT_OF_STOCK - Enum constant in enum privbot.hooks.shop.BuyPlan.Skip
-
The shop stocks it but currently has none.
- outcome() - Method in class privbot.hooks.bank.WithdrawCapacity
- outcome() - Method in class privbot.hooks.Magic.CastResult
- Outcome - Class in privbot.api
-
What happened when a verb was asked to act: an explicit answer instead of
falseplus a log line. - Outcome.Status - Enum in privbot.api
-
Why an action was or was not sent.
- outline(Actor, Color) - Method in class privbot.ui.overlay.SceneCanvas
-
Outline an actor (convex hull where available, its tile otherwise).
- outOf(String) - Method in class privbot.hooks.Inventory
-
True when inventory holds no item matching
name. - outOf(String) - Static method in class privbot.mechanics.SustainOutcome
-
A need was read and nothing carried meets it;
whatis "food" or "boost". - overhead() - Method in class privbot.mechanics.NpcView
-
A HeadIcon name (for example
"MAGIC"),NpcView.NO_OVERHEADwhen the read worked and the NPC shows no overhead, ornullwhen it could not be read (unknown, not "not praying"). - overhead() - Method in class privbot.mechanics.PlayerView
- overheadProtection() - Method in class privbot.hooks.User
-
The overhead prayer icon the server draws on the local player, with "could not read it" kept apart from "nothing drawn" —
getLocalPlayer().getOverheadIcon()answersnullfor both. - OverheadWatch - Class in privbot.mechanics
-
An opponent's overhead prayer, debounced: "has their prayer blocked this style long enough to act on it".
- OverheadWatch() - Constructor for class privbot.mechanics.OverheadWatch
- OverheadWatch(int) - Constructor for class privbot.mechanics.OverheadWatch
- OVERLAY - Enum constant in enum privbot.hooks.Magic.SpellbookTab
-
An overlay replaces the tab area, so the book is not drawn whatever tab is selected.
- OVERLAY_SCENE - Enum constant in enum privbot.api.Capability
-
Scene overlays: tiles and actors projected onto the game view.
- OverlayIcons - Class in privbot.ui.overlay
-
The full-colour icon set offered for Builder flow overlays (ids such as
skill:miningortile:combat). - OverlayMoveEventFilter - Class in privbot.ui.overlay
-
"Move overlay" on clients without RuneLite's MouseManager (Impact, Elorin, SpawnPK): an
EventQueuepushed only while move mode is on, so a drag on a panel never also clicks the game. - OverlayMoveInput - Class in privbot.ui.overlay
-
Feeds the game canvas's mouse into an
OverlayMoveModewhile "Move overlay" is on. - OverlayMoveMode - Class in privbot.ui.overlay
-
"Move overlay": drag a flow's Builder panel to a new place, or drag its bottom-right corner to resize its width, in game.
- OverlayMoveMode(Supplier<Map<String, Rectangle>>, Supplier<Dimension>, OverlayMoveMode.MoveListener) - Constructor for class privbot.ui.overlay.OverlayMoveMode
- OverlayMoveMode.MoveListener - Interface in privbot.ui.overlay
-
Receives a saved move: the corner anchor nearest the panel's centre and the offsets from it (
OverlayPlacementrules), or FREE with the panel's top-left when the viewport is unknown. - OverlayPalette - Class in privbot.ui.overlay
-
The resolved colours of one overlay: the scheme's, with a custom scheme's per-colour overrides.
- OverlayPlacement - Class in privbot.ui.overlay
-
Where a flow's overlay panel goes on the game canvas: its anchor plus offsets, clamped inside the viewport, and moved off any panel placed before it.
- overlays() - Method in class privbot.ui.overlay.OverlaySet
-
The overlays in this set, in install order (unmodifiable).
- OverlaySet - Class in privbot.ui.overlay
-
The overlays a plugin registered, as one handle:
OverlaySet.setVisible(boolean)adds or removes them all,OverlaySet.close()removes them forshutDown(). - OverlayTheme - Class in privbot.ui.overlay
-
The one palette for in-game overlays.
- overload() - Static method in class privbot.mechanics.BoostDosePolicy
-
Overload flasks and potions, doses 1 to 6: expired at +4 or less, 9 s settle, three failures.
- OVERLOAD - Static variable in class privbot.effects.EffectTracker
- OVERLOAD_MS - Static variable in class privbot.effects.EffectTracker
- own() - Method in class privbot.mechanics.PvpFightHistory
-
Record accepted sends and separately confirmed effects through this single-owner clock.
- ownAnimations() - Static method in class privbot.mechanics.ElorinPvpCues
-
Known local attack animations.
- OwnAttackClock - Class in privbot.mechanics
-
Combines a cue detector and confirmed-action history for our attack cycle.
- OwnAttackClock(Map<Integer, CombatStyle>, Set<Integer>, Set<Integer>) - Constructor for class privbot.mechanics.OwnAttackClock
- ownCycle - Variable in class privbot.mechanics.PvpFightHistory.Inputs
- owner(Frame) - Method in class privbot.ui.fx.FxStudioShell.Builder
-
Ignored — the studio is always a non-modal
JFrame. - ownFire() - Method in class privbot.mechanics.PvpFightHistory.View
- ownsGear() - Method in class privbot.mechanics.InstantMaulPlan.Plan
-
True while the maul sequence must keep ownership of gear, including a pending special.
- ownsGear() - Method in class privbot.mechanics.KnockoutWeaponPlan.Plan
-
True while the KO episode must keep ordinary gear proposals from replacing its weapon.
P
- packed(int) - Static method in class privbot.hooks.TransportRequest.WidgetPathStep
-
Packed widget id (
group << 16 | child), as shown in the Widget Inspector. - packedWidgetId() - Method in class privbot.hooks.TransportRequest.WidgetPathStep
- PAGE - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for a page built by the page-chrome helpers.
- PAGE_HEAD - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Heading block drawn by the page helpers;
FxStudioShellhides it because the shell draws the heading. - paintCardBackground(Graphics2D, int, int, int, int) - Static method in class privbot.ui.overlay.PrivBotChatboxOverlayComponents
-
Paints the branded dark card (gradient, cyan/orange glow, border, corner accents) at the given bounds.
- paintComponent(Graphics) - Method in class privbot.ui.ModernTheme.ChipToggle
-
Paints the chip in its selected, hover or pressed shade, then the text.
- paintComponent(Graphics) - Method in class privbot.ui.ModernTheme.FilterChip
-
Paints the active outline or hover fill, then the text.
- paintComponent(Graphics) - Method in class privbot.ui.ModernTheme.MarkLabel
-
Paints the tinted tile and centred text.
- paintComponent(Graphics) - Method in class privbot.ui.ModernTheme.ModernBadge
-
Paints the tinted pill and outline, then the text.
- paintComponent(Graphics) - Method in class privbot.ui.ModernTheme.ModernButton
-
Paints the rounded fill (normal, hover, pressed or disabled), focus ring and label.
- paintComponent(Graphics) - Method in class privbot.ui.ModernTheme.ModernTextField
-
Paints the field, then the placeholder while it is empty.
- paintComponent(Graphics) - Method in class privbot.ui.ModernTheme.ModernToggle
-
Paints the track, thumb and label.
- paintComponent(Graphics) - Method in class privbot.ui.ModernTheme.StyledToggleButton
-
Paints background and text in one pass to avoid the double-paint glitch.
- paintComponent(Graphics) - Method in class privbot.ui.ToggleSwitch
-
Paints the track and knob; green when on.
- paintThumb(Graphics, JComponent, Rectangle) - Method in class privbot.ui.ModernTheme.ModernScrollBarUI
-
Paints a rounded thumb; nothing when disabled or empty.
- paintTrack(Graphics, JComponent, Rectangle) - Method in class privbot.ui.ModernTheme.ModernScrollBarUI
-
Fills the track with the track colour.
- PaletteSettings - Interface in privbot.ui.overlay
-
The colours a user chose for one overlay, as
OverlayPalette.of(PaletteSettings)reads them: a built-inPaletteSettings.Scheme, and forPaletteSettings.Scheme.CUSTOMa colour perPaletteSettings.Slotthat replaces Classic's. - PaletteSettings.Scheme - Enum in privbot.ui.overlay
-
The built-in colour schemes, the ones the Workflow Studio HUD offers.
- PaletteSettings.Slot - Enum in privbot.ui.overlay
-
The colours of a palette, one per
OverlayPalettefield. - panel() - Method in class privbot.ui.overlay.Rows
-
Access to the underlying component for anything the row shapes do not cover.
- panel() - Method in class privbot.ui.PluginUi
-
The sidebar panel this handle attached.
- panel(String) - Static method in class privbot.ui.overlay.PrivBotOverlays
-
Starts a HUD panel titled
title(top-left, above widgets,OverlayTheme.PANEL_WIDTHwide). - PANEL_WIDTH - Static variable in class privbot.ui.overlay.OverlayTheme
-
Default HUD panel width; the plugin values ranged 200..260 for the same content.
- panelAt(Point) - Method in class privbot.ui.overlay.OverlayMoveMode
-
The movable panel under
pin last frame's bounds (topmost wins), or null; null while off. - PanelStatus - Enum in privbot.ui
-
The states a plugin sidebar shows, each with a glyph so state is never carried by colour alone.
- Parent<C> - Class in privbot.task
-
Shared parent node that owns a local group of
Childtasks and selects the highest-priority eligible child when it executes. - Parent(String) - Constructor for class privbot.task.Parent
-
Creates a parent with priority
0. - Parent(String, int) - Constructor for class privbot.task.Parent
- parse(String) - Static method in class privbot.api.ApiVersion
-
Parses
MAJOR[.MINOR[.PATCH]][-qualifier][+build], for example1.2.0,1.2or1.3.0-SNAPSHOT. - parse(String) - Static method in class privbot.hooks.container.ItemLines
-
Parses a free-form item list.
- parse(String[]) - Static method in class privbot.hooks.shop.ShopOption
-
Parses a widget's live action array into purchasable options, largest amount first.
- parse(String, List<String>) - Static method in class privbot.mechanics.WeaponSpeeds
-
Parses
"Dark bow=9, Abyssal whip=4"into lower-cased keys. - parseLines(String) - Static method in class privbot.hooks.bank.WithdrawPlan
-
Parses a free-form item list, e.g.
- parseLines(String) - Static method in class privbot.hooks.shop.BuyPlan
-
Parses a free-form item list into buy lines.
- PARTIAL - Enum constant in enum privbot.api.Support
-
Works in some cases; read
Capabilities.note(Capability)for which. - passive(int) - Method in class privbot.mechanics.AttackCues.Builder
- passive(int) - Method in class privbot.mechanics.AttackCues
- patch() - Method in class privbot.api.ApiVersion
- path(List<WorldPoint>, Color) - Method in class privbot.ui.overlay.SceneCanvas
-
A polyline through tile centres; unprojectable tiles break the line rather than skew it.
- PAUSED - Enum constant in enum privbot.ui.PanelStatus
-
Running but temporarily idle by design (waiting, held).
- pending - Variable in class privbot.mechanics.PvpArbiter.Context
- pending(int, Integer, Integer, Boolean) - Static method in class privbot.mechanics.AttackTiming
-
Whether a known unsettled send is still in its pending window; null if unsettled or send is unreadable.
- pending(int, Map<String, Integer>) - Method in class privbot.mechanics.AttackHistory
-
True, false or unknown: a missing fire estimate cannot establish a pending deadline.
- pending(int, Map<String, Integer>) - Method in class privbot.mechanics.OwnAttackClock
- PENDING - Enum constant in enum privbot.actions.confirm.ActionStatus
- PENDING - Enum constant in enum privbot.mechanics.DrinkProof.State
- PENDING - Enum constant in enum privbot.mechanics.FoodProof.State
- PENDING - Enum constant in enum privbot.mechanics.SwitchCheck.State
- PENDING - Enum constant in enum privbot.movement.pathing.NavigationSession.Result
- PENDING_GRACE_TICKS - Static variable in class privbot.mechanics.AttackTiming
- PENDING_MIN_TICKS - Static variable in class privbot.mechanics.AttackTiming
- pendingCount() - Method in class privbot.actions.confirm.ActionTracker
- pendingSpell - Variable in class privbot.mechanics.PvpArbiter.Context
- percentBelow(int) - Static method in class privbot.ui.overlay.ColorRamp
-
A vital against a percentage threshold (the eat/pray thresholds plugins configure): at or below half the threshold is
OverlayTheme.BAD, at or below the thresholdOverlayTheme.WARN, above itOverlayTheme.GOOD. - phase() - Method in class privbot.mechanics.SpecialAttackPolicy.Decision
- pick(List<String>) - Method in class privbot.mechanics.OffensivePrayerUpkeep
-
The prayer to keep on: the first in
chainnot given up, or null (empty chain, or all dropped). - picked() - Method in class privbot.restock.GroundLoot
- PICKED - Enum constant in enum privbot.restock.GroundLoot.Outcome
- PIN_CLOSE - Static variable in class privbot.hooks.bank.BankSession
- PIN_CLOSE_ID - Static variable in class privbot.hooks.bank.BankSession
- PIN_CLOSE_P0 - Static variable in class privbot.hooks.bank.BankSession
- PIN_CLOSE_WIDGET - Static variable in class privbot.hooks.bank.BankSession
- PIN_DEPOSIT_1 - Static variable in class privbot.hooks.bank.BankSession
- PIN_DEPOSIT_ALL - Static variable in class privbot.hooks.bank.BankSession
-
Per-item "Store-All" on the bank-side inventory widget (Elorin).
- PIN_DEPOSIT_EQUIPMENT - Static variable in class privbot.hooks.bank.BankSession
- PIN_DEPOSIT_EQUIPMENT_ID - Static variable in class privbot.hooks.bank.BankSession
- PIN_DEPOSIT_EQUIPMENT_P0 - Static variable in class privbot.hooks.bank.BankSession
- PIN_DEPOSIT_EQUIPMENT_WIDGET - Static variable in class privbot.hooks.bank.BankSession
- PIN_DEPOSIT_INVENTORY - Static variable in class privbot.hooks.bank.BankSession
- PIN_DEPOSIT_INVENTORY_ID - Static variable in class privbot.hooks.bank.BankSession
- PIN_DEPOSIT_INVENTORY_P0 - Static variable in class privbot.hooks.bank.BankSession
- PIN_DEPOSIT_INVENTORY_WIDGET - Static variable in class privbot.hooks.bank.BankSession
- PIN_INVENTORY_WIDGET - Static variable in class privbot.hooks.bank.BankSession
- pinPolicy(GameThreadPolicy) - Static method in class privbot.context.GameThread
-
Fixes how reads are routed, so a later
GameThread.init(net.runelite.api.Client, net.runelite.client.callback.ClientThread)orGameThread.setGameThread(java.lang.Thread)cannot change it. - Place(String, WorldPoint, int) - Constructor for class privbot.hooks.Places.Place
- places - Variable in class privbot.context.PrivContext
-
Named-location registry (banks, NPC anchors, areas) shared with
PrivContext.travel. - places - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.places. - Places - Class in privbot.hooks
-
Named-location registry: resolves a human place name ("Bank", "Edgeville bank", "Banker", an NPC/area name) to an anchor
WorldPoint+ arrival radius, drawing from the current server's movement config (banks + NPC anchors). - Places.Place - Class in privbot.hooks
-
A resolved named location: an anchor tile and the radius that counts as "at" it.
- plan(Map<Integer, Integer>, int) - Method in class privbot.mechanics.PrayerPlanner
- plan(ConsumePlanner.Settings, ConsumePlanner.State) - Static method in class privbot.mechanics.ConsumePlanner
- plan(PvpFightHistory.View, Boolean, Boolean, Boolean, Boolean, int, Set<Integer>, Boolean, Integer, Boolean, PvpArbiter.Context) - Static method in class privbot.mechanics.InstantMaulPlan
-
Select an instant finisher using current HP bar, distance, energy, orb and exact container items.
- plan(PvpFightHistory.View, ConsumePlanner.Settings, ConsumePlanner.State, PvpArbiter.Context, List<PvpArbiter.Action>) - Static method in class privbot.mechanics.PvpActionPlanner
-
The fight view, consume state, arbiter facts and other proposed actions must describe the same tick.
- plan(PvpFightHistory.View, ConsumePlanner.Settings, ConsumePlanner.State, PvpArbiter.Context, SpecialAttackPolicy.Decision, Boolean, List<PvpArbiter.Action>) - Static method in class privbot.mechanics.PvpActionPlanner
-
As above, with same-tick proof that the special set is worn.
- plan(PvpFightHistory.View, ConsumePlanner.Settings, ConsumePlanner.State, PvpArbiter.Context, SpecialAttackPolicy.Decision, Boolean, PvpMovement.Decision, List<PvpArbiter.Action>) - Static method in class privbot.mechanics.PvpActionPlanner
-
Also arbitrate a same-tick movement proposal with its proven destination.
- plan(PvpFightHistory.View, ConsumePlanner.Settings, ConsumePlanner.State, PvpArbiter.Context, SpecialAttackPolicy.Decision, Boolean, PvpMovement.Decision, StylePlanner.Decision, List<PvpArbiter.Action>) - Static method in class privbot.mechanics.PvpActionPlanner
-
Also turn a same-tick, frame-derived style decision into gear proposals.
- plan(PvpFightHistory.View, ConsumePlanner.Settings, ConsumePlanner.State, PvpArbiter.Context, SpecialAttackPolicy.Decision, List<PvpArbiter.Action>) - Static method in class privbot.mechanics.PvpActionPlanner
-
As above, also translating a same-tick special decision into an arm or disarm proposal when required.
- plan(PvpFightHistory.View, KnockoutWeaponDecision.Decision, Set<Integer>, GearSetup, Boolean, PvpArbiter.Context) - Static method in class privbot.mechanics.KnockoutWeaponPlan
-
Bind a same-tick KO decision to exact server-verified weapon IDs and frame containers.
- planned() - Method in class privbot.mechanics.SpecialAttackPolicy.Decision
-
Null means the inputs cannot establish whether the episode is planned.
- planWithSpecialSet(PvpFightHistory.View, ConsumePlanner.Settings, ConsumePlanner.State, PvpArbiter.Context, SpecialAttackPolicy.Decision, GearSetup, PvpMovement.Decision, StylePlanner.Decision, List<PvpArbiter.Action>) - Static method in class privbot.mechanics.PvpActionPlanner
-
Derive special-set readiness from the exact frame being planned, avoiding a stale caller-retained flag.
- player - Variable in class privbot.context.PrivContext
-
The local player as tri-state reads (name, tiles, animation, HP, interacting target).
- player - Variable in class privbot.task.PrivTaskContext
-
Mirrors
PrivContext.player. - player() - Method in class privbot.mechanics.ThreatSnapshot
- player() - Method in interface privbot.restock.RestockHost
-
The player's tile on the last sample, or null.
- PLAYER_READ - Enum constant in enum privbot.api.Capability
- playerEastOf() - Method in class privbot.query.NPCQuery
-
Keeps NPCs the local player stands east of (player X > NPC X).
- playerEastOf() - Method in class privbot.query.ObjectQuery
-
Keeps objects the local player stands east of (player X > object X).
- playerEastOf(WorldPoint, WorldPoint) - Static method in class privbot.query.PlayerRelativeToPoint
-
Player tile is strictly east of
anchor(higher X). - playerIds(int...) - Method in interface privbot.query.PlayerSearch
- playerNorthOf() - Method in class privbot.query.NPCQuery
-
Keeps NPCs whose tile the local player stands strictly north of (player Y > NPC Y, same plane).
- playerNorthOf() - Method in class privbot.query.ObjectQuery
-
Keeps objects whose tile the local player stands strictly north of (player Y > object Y, same plane).
- playerNorthOf(WorldPoint, WorldPoint) - Static method in class privbot.query.PlayerRelativeToPoint
-
Player tile is strictly north of
anchor(higher Y). - PlayerRelativeToPoint - Class in privbot.query
-
Strict cardinal comparisons between the player's tile and an anchor tile.
- players - Variable in class privbot.context.PrivContext
-
Other players in the scene.
- players - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.players. - players() - Method in class privbot.mechanics.FightFrame
- PlayerSearch - Interface in privbot.query
-
Fluent filter chain over the loaded players, returned by
ctx.players.query(). - PlayerSearch.Source - Interface in privbot.query
-
The facade that hands out searches:
ctx.players. - PlayersHook - Class in privbot.hooks
-
Thin wrapper so
PrivContextexposes players via injectedClient. - playerSouthOf() - Method in class privbot.query.NPCQuery
-
Keeps NPCs the local player stands south of (player Y < NPC Y).
- playerSouthOf() - Method in class privbot.query.ObjectQuery
-
Keeps objects the local player stands south of (player Y < object Y).
- playerSouthOf(WorldPoint, WorldPoint) - Static method in class privbot.query.PlayerRelativeToPoint
-
Player tile is strictly south of
anchor(lower Y). - PlayerView - Class in privbot.mechanics
-
One player reduced to what a PvP fight needs.
- PlayerView(String, int, Integer, String, String, Integer, Integer, Integer, Integer, List<Integer>, WorldPoint, Boolean, Integer) - Constructor for class privbot.mechanics.PlayerView
- PlayerView(String, int, Integer, String, String, Integer, Integer, Integer, Integer, List<Integer>, WorldPoint, Boolean, Integer, Integer) - Constructor for class privbot.mechanics.PlayerView
-
As above; weaponId is the worn weapon's item ID, -1 for an empty slot, or null if unreadable.
- PlayerView(String, int, Integer, String, String, Integer, Integer, Integer, Integer, List<Integer>, WorldPoint, Boolean, Integer, Integer, String) - Constructor for class privbot.mechanics.PlayerView
-
As above, with the name resolved from the item definition, or null when unavailable.
- playerWestOf() - Method in class privbot.query.NPCQuery
-
Keeps NPCs the local player stands west of (player X < NPC X).
- playerWestOf() - Method in class privbot.query.ObjectQuery
-
Keeps objects the local player stands west of (player X < object X).
- playerWestOf(WorldPoint, WorldPoint) - Static method in class privbot.query.PlayerRelativeToPoint
-
Player tile is strictly west of
anchor(lower X). - PLUGIN_MANIFEST_ATTRIBUTE - Static variable in class privbot.api.ApiVersion
-
Plugin jar manifest attribute that carries the API version the plugin compiled against.
- pluginApiVersion() - Method in class privbot.api.ApiVersion.Verdict
-
The plugin's declared version (canonical when it parsed), or null for a legacy plugin.
- PluginIconUtil - Class in privbot.ui
-
Shared helpers for plugin nav and panel icons.
- PluginUi - Class in privbot.ui
-
The plugin-side wiring every sidebar needed: build the panel on the EDT, add the navigation button, and take both down again on
shutDown(). - policy() - Static method in class privbot.context.GameThread
-
The pinned policy, or
GameThreadPolicy.AUTO. - Policy(int, long, long, long, long) - Constructor for class privbot.movement.pathing.NavigationSession.Policy
- poll() - Method in class privbot.actions.confirm.ActionHandle
- poll() - Method in class privbot.actions.confirm.ActionTracker
-
Poll each retained action once, returning current pending and newly terminal observations.
- poll() - Method in class privbot.movement.pathing.ExactStepHandle
- poll() - Method in class privbot.ui.overlay.OverlayMoveMode
-
Saves the held moves once 30 s have passed since the last drag (the timer calls this each second).
- pollDialogueLog() - Method in class privbot.hooks.Dialogue
-
Logs the on-screen dialogue if there is one, for callers that want the log WITHOUT asking a question about dialogue state.
- polled - Variable in class privbot.hooks.Events.ChatEvent
-
True when polled from the client's message list; false when forwarded.
- polled - Variable in class privbot.hooks.Events.HitsplatEvent
-
True when this facade polled it; false when it came from a forwarded
HitsplatApplied. - pollNow() - Method in class privbot.ui.PrivBotPanel
-
Run every registered poller once (stats and running state); called by the refresh timer.
- pollsHitsplats() - Method in interface privbot.hooks.Events.Source
- POOL - Enum constant in enum privbot.restock.RestockCycle.Stage
- position - Variable in class privbot.ui.fx.FxConfigPageBuilder.SectionRef
-
Declared position;
FxConfigPageBuilder.sections(net.runelite.client.config.Config)sorts by it. - position() - Method in interface privbot.movement.pathing.ExactStepHandle.Driver
-
null represents an unavailable player/location observation.
- position() - Method in interface privbot.movement.pathing.NavigationSession.Driver
- position(OverlayPosition) - Method in class privbot.ui.overlay.PrivBotOverlays.PanelBuilder
-
Screen anchor; default
TOP_LEFT. - POST_RAID - Enum constant in enum privbot.task.AutomationStage
-
Post-raid loot / leave (typically 25–40).
- POST_RAID - Static variable in class privbot.task.TaskPriorityBands
-
Post-raid loot and leave.
- POSTED_UNCONFIRMED - Enum constant in enum privbot.hooks.Magic.CastOutcome
-
The target click was queued but its outcome could not be waited for (EDT, client thread, timeout).
- POTION - Enum constant in enum privbot.mechanics.ConsumeTiming.Kind
- potionDoseTierFromName(String) - Static method in class privbot.query.ConsumableSelectionOrder
-
Parses dose from potion-style display names using the last
(n)group (e.g. - prayer - Variable in class privbot.context.PrivContext
-
Prayer state reads and prayer toggles.
- prayer - Variable in class privbot.mechanics.ConsumePlanner.State
- prayer - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.prayer. - Prayer - Class in privbot.hooks
-
Prayer activation, deactivation, and state checks.
- PRAYER_READ - Enum constant in enum privbot.api.Capability
- PRAYER_RENEWAL - Static variable in class privbot.effects.EffectTracker
- PRAYER_TOGGLE - Enum constant in enum privbot.api.Capability
- Prayer.Book - Enum in privbot.hooks
-
Which prayer book the prayer tab has mounted, as
Prayer.mountedBook()reads it. - prayerNames() - Method in class privbot.mechanics.ThreatQuery
- PrayerPlanner - Class in privbot.mechanics
-
Protection-prayer planner for several simultaneous attackers.
- PrayerPlanner(AttackCues, PrayerPlanner.Options) - Constructor for class privbot.mechanics.PrayerPlanner
- PrayerPlanner.Options - Class in privbot.mechanics
-
Planner settings.
- prayerPoints() - Method in class privbot.mechanics.ThreatSnapshot
- prayers(String...) - Method in class privbot.mechanics.ThreatQuery
- PrayerToggleGuard - Class in privbot.mechanics
-
Stops a prayer toggle the state read never confirmed from being sent again and again.
- PrayerToggleGuard.Toggle - Class in privbot.mechanics
-
One unconfirmed toggle: the direction asked for and when it was sent.
- PREP - Enum constant in enum privbot.task.AutomationStage
-
Supplies / preset (e.g.
- PREP_BEFORE_COMBAT - Static variable in class privbot.task.TaskPriorityBands
-
Boss-specific setup that must complete before normal combat can start (e.g.
- PREP_HIGH - Static variable in class privbot.task.TaskPriorityBands
-
Top of the supplies and preset band.
- PREP_LOW - Static variable in class privbot.task.TaskPriorityBands
-
Bottom of the supplies and preset band.
- preparatoryEquip() - Method in class privbot.mechanics.InstantMaulPlan.Plan
-
True when an eligible equip may be sent alone while awaiting a later worn observation.
- prepare(Font) - Static method in class privbot.ui.overlay.FallbackText
-
Derives (and caches) the fallback fonts for
primary's size and style. - preset() - Method in class privbot.mechanics.RestockTarget
- preset(String) - Method in class privbot.mechanics.RestockTarget.Builder
-
A server preset to try before withdrawing.
- presetAction - Variable in class privbot.restock.RestockRoute
- presetConfirmMs - Variable in class privbot.restock.RestockRoute
- previous - Variable in class privbot.hooks.Events.AnimationEvent
-
The previous animation (-1 = none).
- previous - Variable in class privbot.hooks.Events.VarChange
-
The value on the previous readable tick.
- primeEmbeddedFxToolkitOnEdt() - Static method in class privbot.ui.fx.FxPlatformUtil
-
Starts the embedded JavaFX toolkit so
javafx.scene.controltypes (e.g. - priority(OverlayPriority) - Method in class privbot.ui.overlay.PrivBotOverlays.PanelBuilder
-
Overlay priority; default
LOW. - priority(OverlayPriority) - Method in class privbot.ui.overlay.PrivBotOverlays.SceneBuilder
-
Overlay priority; default
LOW. - PRIORITY - Enum constant in enum privbot.task.CompositeTaskNode.Strategy
-
Run the highest-priority valid child.
- priv() - Method in class privbot.task.PrivTaskContext
-
The underlying full
PrivContext(e.g. - privbot.actions.confirm - package privbot.actions.confirm
-
Worker-polled proof that a dispatched action took effect:
ActionTracker(fromctx.actions.createTracker()), theActionHandleit returns per action, andActionStatus, whichctx.travel.exactStep(...)also reports. - privbot.api - package privbot.api
-
The PrivBot plugin API boundary: what is supported, and which version of it a runtime provides.
- privbot.behavior - package privbot.behavior
-
Pacing for player-visible automation:
Human, reached asctx.humanfrom a node'sexecute()on the script worker. - privbot.config - package privbot.config
-
Plugin settings helpers:
ConfigMigration, the versioned migration a plugin runs first instartUpwhenever it changes a config default or the meaning of a key. - privbot.context - package privbot.context
-
Plugin-scoped runtime:
PrivContextandGameThread. - privbot.effects - package privbot.effects
-
Plugin-owned effect timers:
EffectTracker(fromctx.effects.createTracker()) and theEffectObservationit answers with. - privbot.hooks - package privbot.hooks
-
ctx.*facades: inventory, bank, NPCs, widgets, and the other one-liners. - privbot.hooks.bank - package privbot.hooks.bank
-
Bank session internals used by
ctx.bank. - privbot.hooks.container - package privbot.hooks.container
-
Inventory and bank container slot reads.
- privbot.hooks.shop - package privbot.hooks.shop
-
Shop interface helpers used by
ctx.shop. - privbot.mechanics - package privbot.mechanics
-
Pure game-mechanic rules shared by plugins on every server: the same name and meaning on Impact, Elorin, Orion, SpawnPK and Roat Pkz.
- privbot.movement.pathing - package privbot.movement.pathing
-
Travel types that appear in
ctx.travelsignatures:NavigationSession,NavigationOptionsandSceneReachability. - privbot.query - package privbot.query
-
Fluent queries behind
ctx.npcs.query(), objects, ground items, and widgets. - privbot.restock - package privbot.restock
-
Restock and loot helpers shared by plugins:
RestockRunnerwith itsRestockRoute,RestockCycleandRestockHost, plusGroundLootandLootNames. - privbot.sdk - package privbot.sdk
- privbot.task - package privbot.task
- privbot.ui - package privbot.ui
-
The Swing half of the PrivBot UI kit: the plugin sidebar, the shared theme and a few widgets.
- privbot.ui.fx - package privbot.ui.fx
-
The settings studio: a JavaFX window hosted in Swing, shared by every plugin.
- privbot.ui.overlay - package privbot.ui.overlay
-
The in-game overlay kit: HUD panels and scene drawing that work the same on every server.
- privbot.wrappers - package privbot.wrappers
-
PrivNPC,PrivObject,PrivItem,PrivPlayer,PrivGroundItem. - PrivBotAPI - Class in privbot.sdk
-
Documentation hub for the supported PrivBot plugin interface.
- PrivBotChatboxOverlayComponents - Class in privbot.ui.overlay
-
Shared drawing helpers for PrivBot-branded chatbox overlays.
- PrivBotChatboxOverlayLayout - Class in privbot.ui.overlay
-
Shared metric layout helpers for PrivBot chatbox overlays.
- PrivBotChatboxOverlayLayout.MetricRow - Class in privbot.ui.overlay
-
One key/value row for the chatbox layouts; build with
row(...). - PrivBotContextModule - Class in privbot.context
-
Guice module that binds
PrivContextso a plugin injector can supplyctx. - PrivBotContextModule() - Constructor for class privbot.context.PrivBotContextModule
- PrivBotFrame - Class in privbot.ui
-
Reusable main frame for PrivBot plugin GUIs.
- PrivBotFrame(String, int, int) - Constructor for class privbot.ui.PrivBotFrame
-
Creates the frame with the given title and default size.
- PrivBotFrame.SectionInfo - Class in privbot.ui
-
Section metadata.
- PrivBotFxStyles - Class in privbot.ui.fx
-
Shared PrivBot JavaFX stylesheet and style-class tokens (studio / settings shell).
- PrivBotOverlayPanel<S> - Class in privbot.ui.overlay
-
A themed HUD panel composed from a published state on every render.
- PrivBotOverlayPanel(String, Supplier<S>) - Constructor for class privbot.ui.overlay.PrivBotOverlayPanel
- PrivBotOverlays - Class in privbot.ui.overlay
-
Entry point of the overlay kit: describe a HUD panel or a scene overlay, then install the set.
- PrivBotOverlays.PanelBuilder - Class in privbot.ui.overlay
-
Describes a HUD panel;
PrivBotOverlays.PanelBuilder.rows(java.util.function.Supplier<S>, java.util.function.BiConsumer<privbot.ui.overlay.Rows, S>)is the terminal step. - PrivBotOverlays.SceneBuilder - Class in privbot.ui.overlay
-
Describes a scene overlay;
PrivBotOverlays.SceneBuilder.draw(java.util.function.Supplier<S>, java.util.function.BiConsumer<privbot.ui.overlay.SceneCanvas, S>)is the terminal step. - PrivBotPanel - Class in privbot.ui
-
Reusable sidebar panel for PrivBot plugins.
- PrivBotPanel(String) - Constructor for class privbot.ui.PrivBotPanel
-
Creates a sidebar panel with the given plugin name.
- PrivBotPanel.Builder - Class in privbot.ui
-
Fluent description of a sidebar;
PrivBotPanel.Builder.build()assembles it. - PrivBotSceneOverlay<S> - Class in privbot.ui.overlay
-
A scene overlay (tiles, outlines, labels, paths) drawn from a published state on every render.
- PrivBotSceneOverlay(Client, Supplier<S>) - Constructor for class privbot.ui.overlay.PrivBotSceneOverlay
-
Projects through
SceneProjection.of(Client);stateis read on the render thread. - PrivBotSceneOverlay(SceneProjection, Supplier<S>) - Constructor for class privbot.ui.overlay.PrivBotSceneOverlay
-
Uses
projection; the overlay is dynamic, above the scene, low priority. - privContext - Variable in class privbot.task.PrivTaskContext
-
Full PrivContext reference.
- PrivContext - Class in privbot.context
-
Single entry point for scripts: hooks and timing helpers.
- PrivGroundItem - Class in privbot.wrappers
-
Ground stack wrapper;
interact("Take")routes through the game client. - PrivItem - Class in privbot.wrappers
-
Inventory/bank/equipment slot wrapper; interactions route through the game client.
- PrivNPC - Class in privbot.wrappers
-
NPC wrapper returned by
ctx.npcs.query(); interactions route through the game client. - PrivObject - Class in privbot.wrappers
-
Scene object wrapper; interactions go through the game client.
- PrivPlayer - Class in privbot.wrappers
-
Other-player wrapper.
- PrivTaskContext - Class in privbot.task
-
Base context for TaskNode-based scripts that exposes all PrivContext hooks directly.
- PrivTaskContext(PrivContext) - Constructor for class privbot.task.PrivTaskContext
-
Copies every hook reference from
ctxand creates a freshHuman. - production - Variable in class privbot.context.PrivContext
-
Production (make-X) interfaces for skilling.
- production - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.production. - Production - Class in privbot.hooks
-
Create/make an item via the standard skill-creation interface (smithing/anvil, cooking, fletching, crafting, …).
- Production.Make - Class in privbot.hooks
-
Fluent make builder.
- PROFILE_NAME_FIELD - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for a profile-name text field.
- ProfileStateParticipant - Interface in privbot.ui
-
Interface for panels that participate in profile save/load.
- progress(long) - Method in class privbot.mechanics.ProgressWatchdog
-
Something useful happened at
nowMs: the idle clock restarts. - progress(String, double, String, Color) - Method in class privbot.ui.overlay.Rows
-
A bar filled to
fraction(0..1) withlabelon the left andvalueTexton the right, e.g. - progress(String, long, long) - Method in class privbot.ui.overlay.Rows
- progress(String, long, long, Color) - Method in class privbot.ui.overlay.Rows
-
A progress bar
valueofmaxincolor, withvalue/maxas its text. - progressBar(int, int, int, int, double, Color) - Method in class privbot.ui.overlay.SceneCanvas
-
A rounded progress bar in canvas space.
- progressMs - Variable in class privbot.movement.pathing.NavigationSession.Policy
- ProgressWatchdog - Class in privbot.mechanics
-
Notices a bot that has stopped making progress.
- ProgressWatchdog(long) - Constructor for class privbot.mechanics.ProgressWatchdog
- projectile(int) - Method in class privbot.mechanics.AttackCues
- projectile(int, CombatStyle) - Method in class privbot.mechanics.AttackCues.Builder
- PROJECTILE_EVENTS - Enum constant in enum privbot.api.Capability
- ProjectileEvent(int, int, int, Actor, Boolean, int) - Constructor for class privbot.hooks.Events.ProjectileEvent
- projectiles - Variable in class privbot.hooks.Events.Needs
-
Read the projectile list.
- projectiles(List<Events.ProjectileSeen>) - Method in class privbot.hooks.Events.Frame.Builder
- ProjectileSeen(String, int, int, int, Actor, Boolean) - Constructor for class privbot.hooks.Events.ProjectileSeen
- projection() - Method in class privbot.ui.overlay.PrivBotSceneOverlay
-
The projection this overlay draws with.
- projection() - Method in class privbot.ui.overlay.SceneCanvas
-
The projection tiles and points go through.
- ProofState - Enum in privbot.actions.confirm
-
A missing/stale observation is UNKNOWN, never evidence that an action succeeded.
- proseGroups() - Method in class privbot.hooks.Dialogue
-
EVERY on-screen text group that reads like a dialogue message, best-scoring first.
- PROTECT_ITEM - Enum constant in enum privbot.mechanics.PvpArbiter.Kind
- PROTECTABLE - Enum constant in enum privbot.mechanics.RiskValuation.Disposition
- PROTECTION - Enum constant in enum privbot.mechanics.PvpArbiter.Kind
- protectPrayer() - Method in enum privbot.mechanics.CombatStyle
-
The normal-book prayer that blocks this style, e.g.
- prune(int) - Method in class privbot.mechanics.HazardMap
-
Drops timed tiles that have expired at
nowTick. - pruneTo(Set<Integer>) - Method in class privbot.mechanics.TagAllTracker
-
Forgets tags for NPCs that are no longer present.
- PublicApi - Annotation Type in privbot.api
-
Marks a package or type as part of the supported PrivBot plugin API.
- publish(S) - Method in class privbot.ui.overlay.Snapshot
-
Replace the published value (tick thread).
- PULSE_QUEUE - Enum constant in enum privbot.context.GameThreadPolicy
-
Inline on the client thread, the game thread and the EDT; anything else waits on a queue drained once per frame.
- PULSE_QUEUE - Enum constant in enum privbot.context.GameThreadRouting.Route
-
Queued on the
ClientThreadand awaited; the game thread's frame pulse drains it. - PURCHASE_REFUSED - Enum constant in enum privbot.hooks.shop.BuyPlan.Skip
-
Clicks dispatched but the inventory count never moved — typically out of coins.
- PURPLE - Enum constant in enum privbot.hooks.GameObjects.ToaRewardsRoomChest.Kind
- purpleGateAction() - Method in class privbot.hooks.GameObjects.ToaRewardsRoomChest.Config
- putStateInto(Map<String, Object>) - Method in interface privbot.ui.ProfileStateParticipant
-
Saves the panel's current state into the profile map.
- pvp - Variable in class privbot.context.PrivContext
-
A detached per-tick snapshot of a PvP fight (opponents' overheads, skulls, HP bars, animations, graphics, worn ids, tiles and targets), plus spell-effect trackers in this server's ids.
- pvp - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.pvp. - Pvp - Class in privbot.hooks
-
ctx.pvp: a detached, per-tick copy of a PvP fight (the local player and the players around it: overhead, skull, HP bar, animation, graphic, worn item ids, tile and who they interact with), the same on every server. - PVP_DAMAGE_MODEL - Enum constant in enum privbot.api.Capability
-
Historical per-weapon PvP damage distributions.
- PVP_EFFECTS - Enum constant in enum privbot.api.Capability
-
Server-specific freeze, vengeance and teleblock cue interpretation.
- PVP_ESCAPE - Enum constant in enum privbot.api.Capability
-
Cancellable escape to a verified safe destination.
- PVP_FIGHT_EVENTS - Enum constant in enum privbot.api.Capability
-
Newly observed local fight hits and graphics.
- PVP_READS - Enum constant in enum privbot.api.Capability
-
Detached opponent observations.
- PVP_RISK - Enum constant in enum privbot.api.Capability
-
PvP risk valuation from detached containers and supplied rules.
- PVP_WILDERNESS - Enum constant in enum privbot.api.Capability
-
Wilderness level from supplied verified coordinate rules.
- Pvp.FightObserver - Class in privbot.hooks
- PvpActionPlanner - Class in privbot.mechanics
-
Composes detached consumption decisions with the PvP action-family arbiter.
- PvpActionPlanner.Plan - Class in privbot.mechanics
-
The original consume decision is explanatory; dispatch only non-held entries from
PvpActionPlanner.Plan.actions(). - PvpArbiter - Class in privbot.mechanics
-
Pure action-family conflict resolution for a detached PvP plan.
- PvpArbiter.Action - Class in privbot.mechanics
- PvpArbiter.Context - Class in privbot.mechanics
-
Current decision facts.
- PvpArbiter.Kind - Enum in privbot.mechanics
- PvpFightHistory - Class in privbot.mechanics
-
Single-owner coordinator for detached PvP observations.
- PvpFightHistory(Map<Integer, CombatStyle>, Map<Integer, CombatStyle>, Set<Integer>, Set<Integer>, Set<Integer>, Set<Integer>) - Constructor for class privbot.mechanics.PvpFightHistory
- PvpFightHistory(Map<Integer, CombatStyle>, Map<Integer, CombatStyle>, Set<Integer>, Set<Integer>, Set<Integer>, Set<Integer>, boolean) - Constructor for class privbot.mechanics.PvpFightHistory
-
Enable energy-drop fire detection only when that rule has been verified for this server and session.
- PvpFightHistory(Map<Integer, CombatStyle>, Map<Integer, CombatStyle>, Set<Integer>, Set<Integer>, Set<Integer>, Set<Integer>, boolean, boolean) - Constructor for class privbot.mechanics.PvpFightHistory
-
Also opt into the historical Elorin weapon-name style catalogue when appropriate for this server.
- PvpFightHistory.Inputs - Class in privbot.mechanics
-
Detached inputs derived from the same observation.
- PvpFightHistory.View - Class in privbot.mechanics
-
Immutable results for one sampled tick.
- PvpFinisherCoordinator - Class in privbot.mechanics
-
Chooses between same-frame instant-maul and KO-weapon episodes before combining with ordinary actions.
- PvpFinisherCoordinator.Plan - Class in privbot.mechanics
- PvpKoCoordinator - Class in privbot.mechanics
-
Combines a KO-weapon gear episode with an ordinary same-frame PvP plan.
- PvpKoCoordinator.Plan - Class in privbot.mechanics
- PvpMaulCoordinator - Class in privbot.mechanics
-
Combines an ordinary PvP proposal and an instant-maul proposal from the exact same frame and arbiter facts.
- PvpMaulCoordinator.Plan - Class in privbot.mechanics
- PvpMovement - Class in privbot.mechanics
-
Detached proposal for the flagship PvP closing and step-out rules.
- PvpMovement.Decision - Class in privbot.mechanics
- PvpMovement.Kind - Enum in privbot.mechanics
- PvpQuery - Class in privbot.mechanics
-
What a
ctx.pvp.snapshot(..)call should include. - PvpSnapshot - Class in privbot.mechanics
-
A detached copy of one tick of a PvP fight: the local player and the other players around it.
- PvpSnapshot(int, PlayerView, List<PlayerView>, Integer) - Constructor for class privbot.mechanics.PvpSnapshot
Q
- qualifier() - Method in class privbot.api.ApiVersion
-
Pre-release qualifier such as
SNAPSHOT, or null. - quantity - Variable in class privbot.hooks.bank.WithdrawPlan.Line
- quantity - Variable in class privbot.hooks.container.ItemContainerSnapshot.Item
-
Item id, slot index and stack quantity.
- quantity - Variable in class privbot.hooks.container.ItemLines.Line
- quantity - Variable in class privbot.hooks.shop.BuyPlan.Line
- quantity - Variable in class privbot.restock.GroundLoot.Ground
- quantity() - Method in class privbot.hooks.bank.BankSlot
-
Units banked in this slot, as reported by the container's quantity array.
- quantity() - Method in class privbot.hooks.container.ContainerSlot
-
Stack size in this slot.
- quantity() - Method in class privbot.hooks.LootDrop
- quantity() - Method in class privbot.mechanics.GearSetup.Entry
- quantityGreaterThan(int) - Method in class privbot.query.ItemQuery
-
Same as
ItemQuery.quantityOver(int); KSBot-style name. - quantityOver(int) - Method in class privbot.query.ItemQuery
-
Keeps rows whose quantity is strictly greater than
n. - query() - Method in class privbot.hooks.Bank
-
A fresh query over the bank's items (only meaningful while the bank is open).
- query() - Method in class privbot.hooks.Equipment
-
A fresh query over the worn items (one read per call).
- query() - Method in class privbot.hooks.GameObjects
-
A query over the scene's objects, read once per game tick on the client thread and reused within the tick.
- query() - Method in class privbot.hooks.GraphicsObjects
-
A query over the graphics objects in the scene, read once on the client thread.
- query() - Method in class privbot.hooks.GroundItems
- query() - Method in class privbot.hooks.Inventory
-
A fresh query over the carried items (one read per call).
- query() - Method in class privbot.hooks.NPCs
- query() - Method in class privbot.hooks.Widgets
-
Empty widget query — add
WidgetQuery.root(int)/WidgetQuery.expandImmediateChildren()as needed. - query() - Method in interface privbot.query.PlayerSearch.Source
- queryAt(int) - Method in class privbot.hooks.Widgets
-
Query the widget at this inspector packed id (
group.child) plus its immediate child layer.
R
- radius - Variable in class privbot.hooks.Places.Place
-
Tiles from the anchor that count as "at" the place.
- radius() - Method in class privbot.mechanics.Destination
- radius() - Method in class privbot.mechanics.NpcAttackerEvidence
-
Maximum square-distance covered by the scan.
- radius() - Method in class privbot.mechanics.PvpQuery
- radius() - Method in class privbot.mechanics.ThreatQuery
- RADIUS_LG - Static variable in class privbot.ui.GearTheme
-
Large corner radius in pixels.
- RADIUS_LG - Static variable in class privbot.ui.ModernTheme
-
Corner radius: 12 px.
- RADIUS_MD - Static variable in class privbot.ui.GearTheme
-
Medium corner radius in pixels.
- RADIUS_MD - Static variable in class privbot.ui.ModernTheme
-
Corner radius: 8 px.
- RADIUS_SM - Static variable in class privbot.ui.GearTheme
-
Small corner radius in pixels.
- RADIUS_SM - Static variable in class privbot.ui.ModernTheme
-
Corner radius: 4 px.
- RADIUS_XL - Static variable in class privbot.ui.GearTheme
-
Extra-large corner radius in pixels.
- RADIUS_XL - Static variable in class privbot.ui.ModernTheme
-
Corner radius: 16 px.
- RAGNAR - Enum constant in enum privbot.api.ServerId
- RAID_FLOW - Enum constant in enum privbot.task.AutomationStage
-
Raid flow before low combat — e.g.
- random(long, long) - Method in class privbot.behavior.Human
-
Uniform milliseconds in
[minMs, maxMs](inclusive). - range() - Method in class privbot.mechanics.LootSpec
- range(int) - Method in class privbot.mechanics.LootSpec.Builder
-
Tiles around the player to look (default 8).
- RANGED - Enum constant in enum privbot.mechanics.CombatStyle
- RANGED - Static variable in class privbot.ui.GearTheme
-
Ranged combat-style accent (green).
- RANGED_CHAIN - Static variable in class privbot.mechanics.OffensivePrayerUpkeep
-
Ranged offensive prayers, best first.
- RANGED_DEFAULT - Static variable in class privbot.mechanics.WeaponSpeeds
- rangedGraphics() - Static method in class privbot.mechanics.ElorinPvpCues
-
Historically observed local crossbow fire graphic.
- rawId() - Method in class privbot.hooks.User.Overhead
-
The server's own icon id on Impact, Elorin and SpawnPK (255 or -1 = nothing drawn); the icon's ordinal or -1 on RuneLite-API servers;
Integer.MIN_VALUEwhen unreadable. - reachability() - Method in class privbot.hooks.Travel
-
One immutable reachability grid per read scope, using the shared local pathfinder.
- read(Supplier<T>) - Method in class privbot.context.PrivContext
-
Batch a read-only decision in one client callback, reusing snapshots until it returns.
- read(Supplier<T>) - Method in class privbot.task.PrivTaskContext
-
Batch a read-only decision; actions and waits belong outside this callback.
- read(Events.Needs) - Method in interface privbot.hooks.Events.Source
- ReadScope - Class in privbot.context
-
Reuses detached observations within one synchronous decision, never across decisions or threads.
- ready(ConsumeTiming.Mode, ConsumeTiming.Kind, int, Integer, Integer, Integer) - Static method in class privbot.mechanics.ConsumeTiming
-
Whether an action is off its cooldown.
- readyTick(Integer, Integer) - Static method in class privbot.mechanics.AttackTiming
-
Combine a known attack-ready estimate with the observed spell cooldown floor.
- realLevel(String) - Method in class privbot.hooks.Skills
- realLevel(Skill) - Method in class privbot.hooks.Skills
- realLevel(Skill) - Method in class privbot.hooks.User
- reason() - Method in class privbot.api.Observed
-
Why the read is UNREADABLE, or the note an ABSENT result carries; null for VALUE (and for an ABSENT without a note).
- reason() - Method in class privbot.api.Outcome
-
Why, in words; empty for a plain dispatch.
- reason() - Method in class privbot.mechanics.ConsumePlanner.Plan
- reason() - Method in class privbot.mechanics.GraniteMaulDecision.Decision
- reason() - Method in class privbot.mechanics.InstantMaulPlan.Plan
- reason() - Method in interface privbot.mechanics.Job
-
Why the job is not RUNNING (what failed or why it is unsupported); "" while RUNNING.
- reason() - Method in class privbot.mechanics.KnockoutWeaponDecision.Decision
- reason() - Method in class privbot.mechanics.KnockoutWeaponPlan.Plan
- reason() - Method in class privbot.mechanics.PvpArbiter.Action
- reason() - Method in class privbot.mechanics.PvpMovement.Decision
- reason() - Method in class privbot.mechanics.SpecialAttackPolicy.Decision
- reason() - Method in class privbot.mechanics.StylePlanner.Decision
- reason() - Method in class privbot.mechanics.SustainChoice
- reason() - Method in class privbot.mechanics.SustainOutcome
- reason() - Method in class privbot.mechanics.SwitchResult
- reason() - Method in class privbot.restock.RestockCycle
-
Why the current (or last) trip began.
- reason(ItemContainerSnapshot, int, List<String>, int) - Static method in class privbot.restock.RestockSupplies
-
Why a trip is due, or null when it is not (or the inventory is unreadable).
- record(boolean, long) - Static method in class privbot.mechanics.PrayerToggleGuard
- record(String, String, int, long) - Method in class privbot.mechanics.LootTally
-
Records
qtyofitem(worthvaluein total) fromnpc. - record(String, Map<String, Object>) - Method in class privbot.hooks.Capture
-
Appends one row to a stream.
- recordedFallbackName(String) - Static method in class privbot.hooks.Production
-
Recommended recorded-action name to fall back to when the standard interface is absent.
- recordFailure() - Method in class privbot.mechanics.BoostDosePolicy
-
Records a failed attempt (this changes state).
- recordKill(String) - Method in class privbot.mechanics.LootTally
-
Counts one kill of
npc. - recordMessage(String) - Static method in class privbot.hooks.Chat
-
Record a chat message into the shared buffer.
- recovery - Variable in class privbot.context.PrivContext
-
Death recovery (Impact reclaim; unsupported elsewhere).
- recovery - Variable in class privbot.task.PrivTaskContext
-
Mirrors
PrivContext.recovery. - Recovery - Class in privbot.hooks
-
Recover after the local player dies:
ctx.recovery. - RECOVERY - Enum constant in enum privbot.api.Capability
-
Getting back after a death: waiting out the respawn, reclaiming the dropped items where the server has a reclaim point, restocking and travelling back, with a plain-words reason for every way it can stop.
- RECOVERY - Enum constant in enum privbot.task.AutomationStage
-
Death recovery, supply abort, stuck recovery (typically 240–250).
- RECOVERY_MAX - Static variable in class privbot.task.TaskPriorityBands
-
Top of the recovery band: death recovery, supply abort, stuck recovery.
- RECOVERY_MIN - Static variable in class privbot.task.TaskPriorityBands
-
Bottom of the recovery band.
- RecoveryPlan - Class in privbot.mechanics
-
What
ctx.recovery.afterDeathdoes once the player is back: an optional restock, then an optional trip back. - RecoveryPlan.Builder - Class in privbot.mechanics
-
Builds a
RecoveryPlan. - recoveryWaypoint(WorldPoint, WorldPoint) - Method in interface privbot.movement.pathing.NavigationSession.Driver
- refreshEvery(int) - Method in class privbot.ui.PrivBotPanel.Builder
-
Refresh interval for pollers and stats; default 1000 ms, minimum 100 ms.
- refuseBusy - Variable in class privbot.mechanics.PvpArbiter.Context
- refused(String) - Static method in class privbot.api.Outcome
- REFUSED - Enum constant in enum privbot.api.Outcome.Status
-
The API declined to send it (not supported on this client, a guard, actions on hold).
- REFUSED - Enum constant in enum privbot.hooks.Magic.CastOutcome
-
A gate held the target click;
Magic.CastResult.gate()names it. - registerSection(String, String, String, JComponent) - Method in class privbot.ui.PrivBotFrame
-
Registers a section to be displayed in the frame.
- REGULAR - Enum constant in enum privbot.hooks.GameObjects.ToaRewardsRoomChest.Kind
- REJECTED - Enum constant in enum privbot.actions.confirm.ActionStatus
- REJECTED - Enum constant in enum privbot.actions.confirm.DispatchStatus
-
The dispatch API explicitly refused the action or no dispatch was possible.
- RELEASED_DEAD - Enum constant in enum privbot.mechanics.OpponentLockPolicy.Event
- RELEASED_GONE - Enum constant in enum privbot.mechanics.OpponentLockPolicy.Event
- RELEASED_IDLE - Enum constant in enum privbot.mechanics.OpponentLockPolicy.Event
- remaining(WithdrawPlan.Line, int) - Static method in class privbot.hooks.bank.WithdrawPlan
-
Units still needed to reach the line's target.
- remaining(ItemLines.Line, int) - Static method in class privbot.hooks.container.ItemLines
-
Units still needed to reach a line's target.
- remaining(BuyPlan.Line, int) - Static method in class privbot.hooks.shop.BuyPlan
-
Units still needed to reach the line's target.
- remainingCycles() - Method in class privbot.mechanics.ShotView
- remove(WorldPoint) - Method in class privbot.mechanics.HazardMap
-
Forgets a timed tile.
- removeNode(String) - Method in class privbot.task.StagedTaskRunner
-
Removes every node with this name, from every stage.
- removeNode(String) - Method in class privbot.task.TaskNodeRunner
-
Removes a node by name.
- removeNode(TaskNode<C>) - Method in class privbot.task.CompositeTaskNode
-
Removes a child task node.
- removePersistent(WorldPoint) - Method in class privbot.mechanics.HazardMap
-
Forgets a persistent tile.
- removeStatusListener(Consumer<String>) - Method in class privbot.task.SimpleNode
-
Removes a previously registered status listener.
- render(Graphics2D) - Method in class privbot.ui.overlay.PrivBotOverlayPanel
-
Render-thread entry: reads the visibility condition and the state, composes the rows and paints them.
- render(Graphics2D) - Method in class privbot.ui.overlay.PrivBotSceneOverlay
-
Render-thread entry: checks visibility, reads the state and calls
PrivBotSceneOverlay.draw(privbot.ui.overlay.SceneCanvas, S)with a freshSceneCanvas. - RENEWAL_MS - Static variable in class privbot.effects.EffectTracker
- repeating - Variable in class privbot.mechanics.PvpArbiter.Context
- replaceIfEquals(int, String, String, String) - Static method in class privbot.config.ConfigMigration
-
Rewrites
keytonewValueonly while its saved value, trimmed, equalsoldValueexactly (case-sensitive: enums are stored by name). - request() - Static method in class privbot.hooks.Restock
- request(PrivPlayer) - Method in class privbot.hooks.Trade
-
Requests a trade with
player, the way the client's own Trade with click is sent. - requestFocus() - Method in class privbot.ui.SearchField
-
Focuses the inner text field.
- requestOption(PrivPlayer, String, String) - Method in class privbot.hooks.Trade
-
Sends a player right-click option (
optionPrefix, e.g. - resend - Variable in class privbot.mechanics.PvpArbiter.Context
- resendAllowed - Variable in class privbot.mechanics.PvpArbiter.Context
- reset() - Method in class privbot.hooks.Events
-
Forgets every baseline, so the next tick only records the current state (call on disconnect, world hop, and Stop).
- reset() - Method in class privbot.hooks.Pvp.FightObserver
-
Forget baselines and event history before a new session.
- reset() - Method in class privbot.hooks.Recovery
-
Interrupts a running recovery and clears its state (Stop, disconnect, shutDown).
- reset() - Method in class privbot.mechanics.BoostDosePolicy
- reset() - Method in class privbot.mechanics.DeathWatch
-
Forgets any death in progress (Stop, disconnect).
- reset() - Method in class privbot.mechanics.LootTally
-
Forgets everything.
- reset() - Method in class privbot.mechanics.OffensivePrayerUpkeep
-
Death and a new run: a pending click is void.
- reset() - Method in class privbot.mechanics.PrayerPlanner
-
Forget every tracked animation, pending switch and held prayer.
- reset() - Method in class privbot.mechanics.TagAllTracker
- reset() - Method in class privbot.mechanics.TargetLock
-
Forgets the lock and the kill count.
- reset() - Method in class privbot.mechanics.WorldFreeze
-
Forget everything; the next observation starts a new watch.
- reset() - Method in class privbot.restock.GroundLoot
- reset() - Method in class privbot.task.CompositeTaskNode
-
Rewinds a sequence to its first child, clears the active node and resets every child.
- reset() - Method in class privbot.task.Parent
-
Clears the active and remembered child and resets every child.
- reset() - Method in class privbot.task.SimpleNode
-
No-op by default.
- reset() - Method in class privbot.task.StagedTaskRunner
-
Resets every node and clears active state; statistics are kept.
- reset() - Method in interface privbot.task.TaskNode
-
Resets the task's internal state.
- reset() - Method in class privbot.task.TaskNodeRunner
-
Resets all nodes and clears active state.
- reset(long) - Method in class privbot.mechanics.ProgressWatchdog
-
Starts over at
nowMs: no idle time and no hold. - reset(long) - Method in class privbot.restock.RestockCycle
-
A new Start: idle, counts cleared.
- resetForTest() - Static method in class privbot.hooks.BankSeen
-
Test hook: forgets the snapshot.
- resetForTest() - Static method in class privbot.hooks.SessionAccount
-
Test hook: forgets the account.
- resizableListEditor(double, double, double) - Static method in class privbot.ui.fx.FxFormKit
- RESIZE_HANDLE - Static variable in class privbot.ui.overlay.OverlayMoveMode
-
Size of the bottom-right square that resizes instead of moving.
- resolve(String) - Method in class privbot.hooks.Places
-
Resolve a place name to an anchor + radius, or
nullif unknown. - resolve(String[], String) - Static method in class privbot.hooks.shop.TradeVerb
- resolve(NpcView) - Method in class privbot.hooks.Targets
-
Finds the live NPC for a view.
- resolve(PvpArbiter.Context, List<PvpArbiter.Action>) - Static method in class privbot.mechanics.PvpArbiter
-
Resolve and return a stable dispatch ordering.
- resolvePlayerMenuIndex(Client, Player) - Static method in class privbot.hooks.Combat
-
Resolves the menu
identifierindex for a player (list index first). - RESOURCE - Static variable in class privbot.hooks.VarRegistry
-
The bundled data file, on the classpath.
- RESPAWNED - Enum constant in enum privbot.mechanics.DeathWatch.State
-
The first tick that proves the player is back after a death; the next one is ALIVE.
- restock - Variable in class privbot.context.PrivContext
-
Go home and re-gear (Impact restockAtHome; Elorin RestockRunner; unsupported elsewhere).
- restock - Variable in class privbot.task.PrivTaskContext
-
Mirrors
PrivContext.restock. - restock() - Method in class privbot.mechanics.RecoveryPlan
- restock(RestockTarget) - Method in class privbot.mechanics.RecoveryPlan.Builder
- Restock - Class in privbot.hooks
-
Bank to a gear setup:
ctx.restock. - RESTOCK - Enum constant in enum privbot.api.Capability
- Restock.Builder - Class in privbot.hooks
-
Builds a
Restock.Request. - Restock.Request - Class in privbot.hooks
-
What a restock needs; each server reads only its own fields.
- RestockCycle - Class in privbot.restock
-
One restock trip as a stage machine: IDLE --begin--> HOME -> POOL -> BANK -> RETURNING -> IDLE.
- RestockCycle() - Constructor for class privbot.restock.RestockCycle
- RestockCycle.Stage - Enum in privbot.restock
- RestockHost - Interface in privbot.restock
-
What a plugin tells
RestockRunnerandGroundLootabout itself: when to give up, where the player is, what counts as "back at the activity", and where capture rows go. - RestockRoute - Class in privbot.restock
-
What a restock trip clicks and how long each step may take: the home spell and where it lands, the restoring object, the bank and its preset action, and the teleport widget's way back.
- RestockRunner - Class in privbot.restock
-
Runs a
RestockCycleone confirmed step per call, on the script worker (it waits for each confirmation): Home: the home spell, after closing an open bank; confirmed by landing in the route's home area. Pool: the restoring object; confirmed byRestockHost.restored(); skipped when already full. Bank: the preset action on the nearest bank object, else a banker; confirmed by the worn and carried items changing. - RestockRunner(RestockRoute) - Constructor for class privbot.restock.RestockRunner
- RestockSupplies - Class in privbot.restock
-
Whether the carried supplies call for a restock trip: how much food (items with an Eat action) and how many potions (items whose name contains one of the configured names; a flask or a vial counts once whatever its doses) are left, against the plugin's minimums.
- RestockTarget - Class in privbot.mechanics
-
What a restock should end with, the same on every server: an optional worn setup, an optional carried setup, whether to empty the backpack of unwanted items first, and an optional server preset to try before withdrawing.
- RestockTarget.Builder - Class in privbot.mechanics
-
Builds a
RestockTarget. - RESTORE - Enum constant in enum privbot.mechanics.GearSetup.Role
- RESTORE - Enum constant in enum privbot.mechanics.SustainChoice.Kind
- restoreBelowPoints(int) - Method in class privbot.mechanics.SustainPlan.Builder
-
Drink a restore when prayer points are below this many (0 turns it off).
- restored() - Method in interface privbot.restock.RestockHost
-
HP and prayer are full (the Healing font step is done, or not needed).
- restoreEnabled - Variable in class privbot.mechanics.ConsumePlanner.Settings
- restorePrayerAt - Variable in class privbot.mechanics.ConsumePlanner.Settings
- restores - Variable in class privbot.mechanics.ConsumePlanner.Settings
- restores(String...) - Method in class privbot.mechanics.SustainPlan.Builder
-
Restores in preference order; each must carry the "Drink" action.
- result() - Method in class privbot.movement.pathing.NavigationSession
- result() - Method in interface privbot.query.PlayerSearch
- returnConfirmMs - Variable in class privbot.restock.RestockRoute
- RETURNING - Enum constant in enum privbot.restock.RestockCycle.Stage
- risk - Variable in class privbot.mechanics.ConsumePlanner.State
- RiskValuation - Class in privbot.mechanics
-
Pure valuation over caller-supplied prices and death rules.
- RiskValuation.Disposition - Enum in privbot.mechanics
- RiskValuation.Item - Class in privbot.mechanics
-
One physical entry.
- RiskValuation.ItemRule - Class in privbot.mechanics
-
Value and death treatment for one item ID, from a caller-verified server-specific source.
- riskValue(FightFrame, Map<Integer, RiskValuation.ItemRule>, Boolean, Boolean, int, int, boolean) - Method in class privbot.hooks.Pvp
-
Estimate loss from both containers in a detached fight frame using caller-verified item values, death rules, skull and prayer observations.
- ROAT_PKZ - Enum constant in enum privbot.api.ServerId
- role() - Method in class privbot.mechanics.GearSetup.Entry
- roll(double) - Method in class privbot.behavior.Human
- root - Variable in class privbot.ui.fx.FxFormKit.ResizableMultiline
-
The node to add to the layout (text area plus drag grip).
- root(int) - Method in class privbot.query.WidgetQuery
-
Add a widget resolved from an inspector packed id (
group.child). - rootId - Variable in class privbot.hooks.Dialogue.DialogueText
-
The interface root the text was found under.
- roots() - Method in class privbot.query.WidgetQuery
-
Adds all current top-level widget roots.
- route - Variable in class privbot.hooks.Restock.Request
-
Elorin: the route; null means
RestockRoute.elorin(). - route() - Method in class privbot.restock.RestockRunner
- route(RestockRoute) - Method in class privbot.hooks.Restock.Builder
- row(String, Object) - Method in class privbot.ui.overlay.Rows
-
A plain label / value row.
- row(String, Object, Color) - Method in class privbot.ui.overlay.Rows
-
A label / value row whose value colour means something (
OverlayTheme.GOODetc). - row(String, String) - Static method in class privbot.ui.overlay.PrivBotChatboxOverlayLayout
-
A one-line row with the primary text colour.
- row(String, String, Color) - Static method in class privbot.ui.overlay.PrivBotChatboxOverlayLayout
-
A one-line row; null colour means the primary text colour.
- row(String, String, Color, int) - Static method in class privbot.ui.overlay.PrivBotChatboxOverlayLayout
-
A row whose value may wrap over
maxLineslines (at least 1). - rowIf(boolean, String, Object, Color) - Method in class privbot.ui.overlay.Rows
-
Rows.row(String, Object, Color)only whenconditionholds. - rows(Supplier<S>, BiConsumer<Rows, S>) - Method in class privbot.ui.overlay.PrivBotOverlays.PanelBuilder
-
The terminal step: rows composed from
stateon every render. - Rows - Class in privbot.ui.overlay
-
The rows of a HUD panel, composed fresh on every render.
- run() - Method in class privbot.hooks.Production.Make
-
Execute.
- run(String) - Method in class privbot.hooks.Workflows
-
Runs a workflow by display name (blocking).
- run(String, BooleanSupplier) - Method in class privbot.hooks.Workflows
-
Runs a workflow by display name (blocking) with cancellation support.
- run(String, BooleanSupplier, Consumer<String>) - Method in class privbot.hooks.Workflows
-
Runs a workflow by display name (blocking) with cancellation and status logging.
- run(ConfigMigration.ConfigAccess, ConfigMigration.Step...) - Static method in class privbot.config.ConfigMigration
-
Applies every step whose version is above the saved
ConfigMigration.VERSION_KEY, in version order (steps of one version in the order given), then stores the highest version given. - run(Restock.Request) - Method in class privbot.hooks.Restock
-
Deprecated.server-specific and unproved (Impact and Elorin only); use
Restock.to(RestockTarget), which banks to a worn and carried setup on every server and proves each item - RUN_TOGGLE - Enum constant in enum privbot.api.Capability
- runAsync(String) - Method in class privbot.hooks.Workflows
-
Runs a workflow by name asynchronously on a background thread.
- runAsync(String, Runnable) - Method in class privbot.hooks.Workflows
-
Runs a workflow asynchronously with a completion callback.
- runAsync(String, Runnable, Consumer<String>) - Method in class privbot.hooks.Workflows
-
Runs a workflow asynchronously with completion callback and status logging.
- RUNNING - Enum constant in enum privbot.mechanics.JobState
- RUNNING - Enum constant in enum privbot.ui.PanelStatus
-
Running normally.
- runningEpisode - Variable in class privbot.mechanics.SpecialAttackPolicy.State
- runningIndicator(BooleanSupplier) - Method in class privbot.ui.fx.FxStudioShell.Builder
-
Shows an "Automation running / stopped" pill in the masthead, polled once a second on the FX thread.
- runOnClientThread(Runnable) - Method in class privbot.context.PrivContext
-
Runs
ron the client thread (fire-and-forget); inline when already there. - runOnClientThread(Runnable) - Method in class privbot.task.PrivTaskContext
-
GameThread.invokeLater(Runnable): fire-and-forget on the client thread. - runOnFxAndWait(Runnable) - Static method in class privbot.ui.fx.FxPlatformUtil
-
Runs
ron the FX application thread and blocks the caller until completion. - runtime(String, Duration) - Method in class privbot.ui.overlay.Rows
-
elapsedashh:mm:ssin the muted colour; null renders"-". - runtime(String, Instant) - Method in class privbot.ui.overlay.Rows
-
Elapsed time since
startedAtashh:mm:ss; null start renders"-". - runtime(String, Supplier<Instant>) - Method in class privbot.ui.PrivBotPanel.Builder
-
A stat row showing the time elapsed since
startedAt(null start renders "-"). - runtimeApiVersion() - Method in class privbot.api.ApiVersion.Verdict
- Runtime lifecycle - Search tag in class privbot.sdk.PrivBotAPI
- Section
S
- safe(int, int, int, int, int) - Static method in class privbot.mechanics.WildernessModel.Zone
-
An explicitly verified safe rectangle.
- SAFE_GAP - Static variable in class privbot.mechanics.Footprint
-
The smallest gap that a melee attack cannot reach.
- safeTile(HazardMap, int, List<NpcView>, int) - Method in class privbot.hooks.Hazards
-
Finds the nearest tile out of every hazard.
- SafeTiles - Class in privbot.mechanics
-
Finds the nearest tile to step to that is out of every hazard and clear of every big NPC's footprint.
- safetyWildernessLevel - Variable in class privbot.movement.pathing.NavigationOptions
-
Safety routing may stop here for a caller-owned teleport; zero means fully outside.
- sameItem(String, String) - Static method in class privbot.mechanics.GearNames
-
Whether two names are the same piece of gear, ignoring charges and degrade tiers.
- samePlane(WorldPoint, WorldPoint) - Static method in class privbot.query.PlayerRelativeToPoint
-
True when both points are non-null and on the same plane.
- samples() - Method in class privbot.mechanics.DamageRow
- sarcophagusObjectId() - Method in class privbot.hooks.GameObjects.ToaRewardsRoomChest.Config
- satisfied() - Method in class privbot.mechanics.SetupDiff
- SATISFIED - Enum constant in enum privbot.actions.confirm.ProofState
- save(String, GearSetup) - Method in class privbot.hooks.Loadouts
-
Saves a setup under a name for the logged-in account on this server.
- saved(String) - Method in interface privbot.config.ConfigMigration.ConfigAccess
-
The value saved in the settings file right now, or null when the file does not hold the key: what every client launched from now on will read.
- savedIn(ConfigMigration.ConfigAccess, Path, String) - Static method in class privbot.config.ConfigMigration
-
live, withConfigMigration.ConfigAccess.saved(java.lang.String)read from the properties filefile(keys<group>.<key>, as RuneLite saves them), fresh on every read, overlaid with this view's own writes (the client saves those to the file within a second, after the migration has read on). - scene(Client) - Static method in class privbot.ui.overlay.PrivBotOverlays
-
Starts a scene overlay that projects through
SceneProjection.of(Client). - scene(SceneProjection) - Static method in class privbot.ui.overlay.PrivBotOverlays
-
Starts a scene overlay with an explicit projection (tests, or a projection you already hold).
- SceneCanvas - Class in privbot.ui.overlay
-
The scene-drawing primitives every tile overlay used to hand-roll, over one
SceneProjection. - scenePoint() - Method in class privbot.wrappers.PrivObject
-
The scene tile an interaction with this object is dispatched against (menu param0/param1).
- SceneProjection - Class in privbot.ui.overlay
-
World → canvas, the same way on every server.
- SceneReachability - Class in privbot.movement.pathing
-
One detached flood-fill for ranking many destinations.
- SceneReachability(WorldPoint, int, int, boolean[][]) - Constructor for class privbot.movement.pathing.SceneReachability
- SceneReachability(WorldPoint, int, int, boolean[][], int[][]) - Constructor for class privbot.movement.pathing.SceneReachability
- SceneTileObjects - Class in privbot.query
-
Collects every interactable object in the loaded scene, on every plane.
- sceneX() - Method in class privbot.hooks.LootDrop
- sceneY() - Method in class privbot.hooks.LootDrop
- scheme() - Method in interface privbot.ui.overlay.PaletteSettings
-
The chosen scheme.
- scope(Supplier<T>) - Static method in class privbot.context.ReadScope
-
Runs
workwith a fresh observation cache, cleared when it returns. - ScriptExecutor - Class in privbot.task
-
Runs script logic on a dedicated thread so that
sleep()andsleepUntil()block only the script — never the client (game-tick) thread. - ScriptExecutor(String, Runnable) - Constructor for class privbot.task.ScriptExecutor
-
Owned by the plugin that wrote
tickWork: a lambda or method reference is defined in its host class's loader, so a plugin's own lambda names the plugin. - ScriptExecutor(String, Runnable, ClassLoader) - Constructor for class privbot.task.ScriptExecutor
- SearchField - Class in privbot.ui
-
Search field used by Rule Studio and AutoPvP for consistent look and behavior.
- SearchField() - Constructor for class privbot.ui.SearchField
-
A search field with the placeholder
"Search...". - SearchField(String) - Constructor for class privbot.ui.SearchField
-
A search field showing
placeholderwhile empty and unfocused. - SECTION_HOST - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for the node that hosts the selected section.
- sectionCardShell(String, String) - Static method in class privbot.ui.fx.FxFormKit
-
A white
section-cardwith a title and wrapped subtitle; add rows to its children. - SectionInfo(String, String, String, JComponent) - Constructor for class privbot.ui.PrivBotFrame.SectionInfo
-
Creates the metadata; use
PrivBotFrame.registerSection(java.lang.String, java.lang.String, java.lang.String, javax.swing.JComponent)instead of calling this. - sections(Config) - Static method in class privbot.ui.fx.FxConfigPageBuilder
- seen(int, boolean) - Method in class privbot.mechanics.OpponentLock
- seen(int, boolean, boolean) - Method in class privbot.mechanics.OpponentLock
- select(String) - Method in class privbot.hooks.Dialogue
-
Selects a dialogue option by preferring an exact text match first, then falling back to case-insensitive contains matching.
- SELECT_NOT_APPLIED - Enum constant in enum privbot.hooks.Magic.CastOutcome
-
The spell click went out but the client never took the selection.
- selectAll() - Method in class privbot.ui.SearchField
-
Selects all text in the field.
- selectByInspectorPath(String) - Method in class privbot.hooks.Dialogue
-
Same as
Dialogue.selectPacked(int)but resolvesgroup.child[index]...paths when packed ids are ambiguous (e.g. - selectContains(String) - Method in class privbot.hooks.Dialogue
-
Selects a dialogue option by case-insensitive contains matching only.
- selected(String, long) - Method in interface privbot.task.TaskTraceListener
-
One selection pass finished.
- selectExact(String) - Method in class privbot.hooks.Dialogue
-
Selects a dialogue option by exact normalized text match only.
- selectNode() - Method in class privbot.task.TaskNodeRunner
-
Finds the highest-priority enabled node whose
TaskNode.shouldExecute(C)returns true, without executing it. - selectOption(int) - Method in class privbot.hooks.Dialogue
-
Selects a choice by its 1-based index:
1is the first choice the menu offers. - selectPacked(int) - Method in class privbot.hooks.Dialogue
-
Activates a widget by inspector packed id (
group << 16 | child). - selectPreset(int) - Method in class privbot.hooks.Bank
-
Selects a numbered bank preset (1-based).
- selectSection(String) - Method in class privbot.ui.fx.FxStudioShell
-
Selects a section by id.
- sell(String, int) - Method in class privbot.hooks.Shop
-
Sells
quantityof the named inventory item to the open shop, with the shop'sSell 1/5/10/50actions. - sell(List<String>, boolean, boolean, String) - Method in class privbot.hooks.Shop
-
Sells items from the open shop without any per-item delay.
- sell(List<String>, boolean, boolean, String, int) - Method in class privbot.hooks.Shop
-
Shop.sell(List, boolean, boolean, String)against a specific shop widget. - sendCommand(String) - Method in class privbot.hooks.Chat
-
Sends a client command (
::home,::bank) the way a player does: typed on the game canvas and submitted with Enter, through the same keyboard path asChat.sendMessage(String)'s command branch and the Builder's TypeText action. - sendMessage(String) - Method in class privbot.hooks.Chat
-
Deprecated.says nothing about where the text goes, and its non-command branch (and its command branch on the client thread) sends PUBLIC chat. Use
Chat.sendCommand(String)for::commands; public chat isChat.sendPublic(String), which is explicit and currently unsupported. - sendPublic(String) - Method in class privbot.hooks.Chat
-
Public chat, said explicitly.
- sent() - Method in class privbot.hooks.Magic.CastResult
-
The legacy boolean: the target click went out, or was queued behind the select.
- sent() - Method in class privbot.mechanics.SwitchResult
- sent(int, AttackHistory.Family) - Method in class privbot.mechanics.AttackHistory
-
Record only a dispatch known to have been accepted; acceptance is not a fire.
- sent(int, AttackHistory.Family) - Method in class privbot.mechanics.OwnAttackClock
-
Record a send only after the dispatcher accepted it.
- sent(int, GearSetup) - Method in class privbot.mechanics.SwitchCheck
-
Records a switch that went out this tick; it replaces any outstanding one.
- SENT - Enum constant in enum privbot.hooks.Magic.AutocastClick
-
The Autocast click went out (queued).
- sentTick() - Method in class privbot.mechanics.AttackHistory
- SEQUENCE - Enum constant in enum privbot.task.CompositeTaskNode.Strategy
-
Run children in order; each must complete before the next starts.
- server() - Method in interface privbot.api.Capabilities
-
The server these answers are for.
- server() - Method in interface privbot.api.Ids
-
The server whose ids these are.
- server() - Method in class privbot.context.PrivContext
-
The server this client runs on, derived from the injected adapter.
- server() - Method in class privbot.task.PrivTaskContext
-
Mirrors
PrivContext.server(). - ServerId - Enum in privbot.api
-
The live server a plugin runs on, as the unified API names it.
- serverOf(String) - Static method in class privbot.mechanics.GearSetup
- serverTile() - Method in class privbot.hooks.LocalPlayer
-
Where the SERVER has put the player: the first tile of its path, which leads the drawn
LocalPlayer.tile()while walking. - session(WorldPoint, NavigationOptions, NavigationSession.Policy) - Method in class privbot.hooks.Travel
-
Create a bounded journey; call step on your script worker and cancel on stop/reconnect.
- SessionAccount - Class in privbot.hooks
-
Which account the per-session game memory (the manual-click log and the last-seen bank) belongs to.
- set() - Method in class privbot.mechanics.PvpArbiter.Action
- set(String, Object) - Method in class privbot.hooks.Blackboard
-
Stores
valueunderkey. - set(String, String) - Method in interface privbot.config.ConfigMigration.ConfigAccess
- setAccent(Color) - Method in class privbot.ui.ModernTheme.ModernBadge
-
Changes the badge colour; null means
ModernTheme.ACCENT_PRIMARY. - setActive(boolean) - Method in class privbot.ui.ModernTheme.FilterChip
-
Highlights or clears the chip; callers keep one chip in a group active themselves.
- setAttackStyle(int) - Method in class privbot.hooks.Combat
-
Dispatch acceptance only.
- setAutoRetaliate(boolean) - Method in class privbot.hooks.Combat
- setDeathAnimations(int...) - Method in class privbot.hooks.Events
-
Sets the animations that mean "the local player is dying", in this server's numbering.
- setEnabled(boolean) - Method in class privbot.task.SimpleNode
-
Enables or disables this node.
- setExpanded(boolean) - Method in class privbot.ui.CollapsibleSection
-
Sets the expanded state.
- setGameThread(Thread) - Static method in class privbot.context.GameThread
-
Declares the thread the game loop runs on.
- setHoverBackground(Color) - Method in class privbot.ui.ModernTheme.ModernButton
-
Overrides the derived hover fill.
- setOnEnter(Runnable) - Method in class privbot.ui.SearchField
-
Called on the EDT when Enter is released in the field.
- setOnTextChanged(Consumer<String>) - Method in class privbot.ui.SearchField
-
Called on the EDT with the current text after every key release and on
SearchField.clear(). - setOnToggle(Runnable) - Method in class privbot.ui.ToggleSwitch
-
Runs on the EDT after each user toggle or
ToggleSwitch.toggle()call. - setPlaceholder(String) - Method in class privbot.ui.ModernTheme.ModernTextField
-
Hint text drawn while the field is empty; null clears it.
- setPlaceholder(String) - Method in class privbot.ui.SearchField
-
Changes the hint text.
- setPluginTitle(String) - Method in class privbot.ui.PrivBotPanel
-
Sets the plugin title text.
- setQuickPrayers(boolean) - Method in class privbot.hooks.Prayer
-
Turn quick prayers on or off, clicking the orb only when the current state disagrees.
- setRun(boolean) - Method in class privbot.hooks.Game
-
Toggles run when the current state is readable and differs, by clicking this server's run orb.
- setRunning(boolean) - Method in class privbot.ui.PrivBotPanel
-
Updates the Start/Stop button and status badge to reflect the running state.
- setSelected(boolean) - Method in class privbot.ui.ToggleSwitch
-
Sets the state without running the toggle callback.
- setSpinnerValueIfNotEditing(Spinner<T>, T) - Static method in class privbot.ui.fx.FxFormKit
-
Updates spinner value only when the spinner/editor is not actively focused.
- setSpinnerValueIfNotEditing(JSpinner, int) - Static method in class privbot.ui.SwingFormKit
-
Sets
valueunless the user is typing in the spinner, so a periodic refresh does not overwrite a half-entered number. - setStat(String, String) - Method in class privbot.ui.PrivBotPanel
-
Sets a stat value.
- setStatus(String) - Method in class privbot.ui.PrivBotFrame
-
Sets the status bar text.
- setStatus(PanelStatus, String) - Method in class privbot.ui.PrivBotPanel
-
Show a state with its glyph (never colour alone):
● RUNNING,▲ WARNING... - setStatusBadge(String, Color) - Method in class privbot.ui.PrivBotPanel
-
Updates the status badge text and color.
- setStatusMessage(String) - Method in class privbot.ui.fx.FxStudioShell
-
Shows a short message in the footer, beside the footer note.
- setText(String) - Method in class privbot.ui.ModernTheme.ModernBadge
-
Sets the text and resizes the badge to fit it.
- setText(String) - Method in class privbot.ui.SearchField
-
Sets the text without firing the text-changed callback.
- setTextIfNotFocused(TextInputControl, String) - Static method in class privbot.ui.fx.FxFormKit
-
Updates text only when the control is not actively focused by the user.
- SETTING_CHANGED - Enum constant in enum privbot.hooks.Widgets.WidgetEffect
-
Dispatched, and a client setting (varp) changed.
- settings(Runnable) - Method in class privbot.ui.PrivBotPanel.Builder
-
The standard Settings button (
PrivBotPanel.SETTINGS_LABEL);openStudioruns on the EDT. - Settings(ConsumeTiming.Mode, int, int, int, boolean, boolean, int, List<String>, List<String>, List<String>, List<String>, List<String>) - Constructor for class privbot.mechanics.ConsumePlanner.Settings
- SETTINGS_LABEL - Static variable in class privbot.ui.PrivBotPanel
-
The one label for the settings button, so every plugin's sidebar reads the same.
- settleAnimations(Set<Integer>) - Method in class privbot.mechanics.PrayerPlanner.Options
-
Animations whose hit is decided
PrayerPlanner.Options.settleTicksafter they first show (default none). - settleTicks(int) - Method in class privbot.mechanics.PrayerPlanner.Options
-
Ticks from a settle animation's first tick until its hit is decided (minimum 1, default 1).
- setTraceListener(TaskTraceListener) - Method in class privbot.task.TaskNodeRunner
-
Installs an optional diagnostics listener for selection and execution events, or clears it with
null. - setup() - Method in class privbot.mechanics.SwitchCheck
- SetupDiff - Class in privbot.mechanics
-
What a
GearSetupstill lacks, compared with the player's real containers, the same on every server. - setVisible(boolean) - Method in class privbot.ui.overlay.OverlaySet
-
Add every overlay to the manager (true) or remove them (false); idempotent.
- setWorkerPrelude(Runnable) - Method in class privbot.task.TaskNodeRunner
-
Installs detached observation work that must be serialized with node selection.
- setWorn - Variable in class privbot.mechanics.SpecialAttackPolicy.State
- shadowText(int, int, String, Color) - Method in class privbot.ui.overlay.SceneCanvas
-
Text with a 1 px black drop shadow, the way every plugin drew it.
- shop - Variable in class privbot.context.PrivContext
-
NPC shops: open and sell.
- shop - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.shop. - Shop - Class in privbot.hooks
-
High-level shop interaction: open an NPC's shop, then sell items from inventory using the shop's widget actions (Sell 1 / Sell 5 / Sell 10 / Sell 50).
- SHOP_BUY - Enum constant in enum privbot.api.Capability
- SHOP_SELL - Enum constant in enum privbot.api.Capability
- ShopInterface - Class in privbot.hooks.shop
-
Finds the open shop's stock and buys from it;
ctx.shopuses it on Impact, Elorin and SpawnPK. - ShopInterface(Client, Widgets) - Constructor for class privbot.hooks.shop.ShopInterface
- ShopOption - Class in privbot.hooks.shop
-
A single purchasable option read off a live shop-slot widget, e.g.
- ShopSlot - Class in privbot.hooks.shop
-
One occupied slot in a shop's stock container.
- ShopSlot(int, int, int, String, int) - Constructor for class privbot.hooks.shop.ShopSlot
- shortfall() - Method in class privbot.mechanics.SetupDiff
- shortfallReport(ToIntFunction<String>) - Method in class privbot.hooks.bank.WithdrawPlan
-
Human-readable summary of every line that fell short, e.g.
- shortfallReport(ToIntFunction<String>) - Method in class privbot.hooks.shop.BuyPlan
-
Human-readable summary of every line that fell short, e.g.
- SHOT - Enum constant in enum privbot.mechanics.IncomingStyleDecision.Source
- shots() - Method in class privbot.mechanics.ThreatSnapshot
- ShotTracker - Class in privbot.mechanics
-
Tells a new projectile launch from one already seen.
- ShotTracker() - Constructor for class privbot.mechanics.ShotTracker
- ShotView - Class in privbot.mechanics
-
One projectile in flight, reduced to what attack tracking needs.
- ShotView(int, int, int, int, WorldPoint, Boolean) - Constructor for class privbot.mechanics.ShotView
- shouldAbort() - Method in interface privbot.restock.RestockHost
-
Stop, disconnect or death invalidated the work: every wait ends and nothing more is clicked.
- shouldExecute(C) - Method in class privbot.task.CompositeTaskNode
-
CompositeTaskNode.Strategy.PRIORITY: true when any enabled child validates (checked in insertion order). - shouldExecute(C) - Method in class privbot.task.Parent
-
True when
Parent.shouldExecuteParent(C)passes and at least one enabled child validates. - shouldExecute(C) - Method in interface privbot.task.TaskNode
-
Checks if this task should currently execute.
- shouldExecuteParent(C) - Method in class privbot.task.Parent
-
Group-level gate, checked before any child.
- shouldWithdraw() - Method in class privbot.hooks.bank.WithdrawCapacity
-
True when a withdraw should be dispatched.
- show() - Method in class privbot.ui.fx.FxStudioShell
-
Shows the window and brings it to the front, creating it again if it was disposed.
- showCount(int, int) - Method in class privbot.ui.SearchField
-
Shows a
count/totalbadge while the field has text; hidden when it is empty. - showModal(Frame, String, String, String, JComponent, Dimension, boolean) - Static method in class privbot.ui.fx.FxConfigDialog
-
Creates a modal dialog.
- shows(String) - Method in class privbot.hooks.User.Overhead
-
Whether the drawn overhead is the overhead of the prayer with this in-game name ("Protect from Magic", "Deflect Melee", "Soul Split"): a combined icon (Missiles + Magic) shows each part, and a curse shows its own icon.
- showSection(String) - Method in class privbot.ui.PrivBotFrame
-
Switches to the specified section.
- shutdown() - Method in class privbot.task.StagedTaskRunner
-
Calls
TaskNode.cleanup()on every node. - shutdown() - Method in class privbot.task.TaskNodeRunner
-
Shuts down the runner: stops the owned worker if present and calls
TaskNode.cleanup()on all nodes. - signalTick() - Method in class privbot.task.ScriptExecutor
-
Called from
onGameTick()on the client thread. - SimpleNode<C> - Class in privbot.task
-
Abstract convenience base for single-tick task nodes.
- SimpleNode(String) - Constructor for class privbot.task.SimpleNode
-
Creates a leaf task node with priority
0. - SimpleNode(String, int) - Constructor for class privbot.task.SimpleNode
-
Creates a leaf task node.
- size() - Method in class privbot.hooks.container.ItemContainerSnapshot
- size() - Method in class privbot.mechanics.NpcView
-
Edge length of the footprint in tiles, or
0when it could not be read (unknown, not 1). - size() - Method in class privbot.query.GraphicsObjectQuery
-
The number of entries left.
- size() - Method in class privbot.query.GroundItemQuery
-
The number of entries left.
- size() - Method in class privbot.query.ItemQuery
-
The number of rows left (slots, not total quantity).
- size() - Method in class privbot.query.NPCQuery
-
The number of entries left.
- size() - Method in class privbot.query.ObjectQuery
-
The number of entries left.
- size() - Method in class privbot.query.WidgetQuery
-
The number of widgets left.
- size(int, int) - Method in class privbot.ui.fx.FxStudioShell.Builder
-
Window size in pixels; prefer
FxStudioShell.Builder.standardSize(). - SKILL_READ - Enum constant in enum privbot.api.Capability
- SkillIconManager - Class in privbot.ui
-
Lightweight vector skill/category icons for Swing UIs (Rule Studio, etc.).
- skills - Variable in class privbot.context.PrivContext
-
Skill levels and experience.
- skills - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.skills. - Skills - Class in privbot.hooks
-
Skill levels and experience:
ctx.skills. - Skills(Client) - Constructor for class privbot.hooks.Skills
-
Without an adapter: every read goes through the RuneLite client.
- skip(int, WithdrawPlan.Skip) - Method in class privbot.hooks.bank.WithdrawPlan
-
Retires a line that cannot be fulfilled.
- skip(int, BuyPlan.Skip) - Method in class privbot.hooks.shop.BuyPlan
-
Retires a line that cannot be fulfilled.
- SKIPPED_FULL - Enum constant in enum privbot.restock.GroundLoot.Outcome
- skull() - Method in class privbot.mechanics.PlayerView
- sleep(int, int) - Static method in class privbot.context.Time
-
Sleeps for a uniformly random duration in
[min, max]milliseconds. - sleep(int, int) - Method in class privbot.task.PrivTaskContext
-
Time.sleep(int, int): a random sleep in[min, max]ms. - sleep(long) - Static method in class privbot.context.Time
-
Sleeps the calling (script) thread for
msmilliseconds. - sleep(long) - Method in class privbot.task.PrivTaskContext
-
Time.sleep(long): false on the client thread or when interrupted. - sleepTick() - Static method in class privbot.context.Time
-
Waits for one game tick; see
Time.sleepTicks(int). - sleepTick() - Method in class privbot.task.PrivTaskContext
-
Time.sleepTick(): waits for the next game tick. - sleepTicks(int) - Static method in class privbot.context.Time
-
Waits for
ticksgame ticks by watching the client's tick count. - sleepTicks(int) - Method in class privbot.task.PrivTaskContext
-
Time.sleepTicks(int): waits forticksgame ticks. - sleepTicksUntil(BooleanSupplier, int) - Static method in class privbot.context.Time
-
Checks
supplieronce per game tick, for at mostticksticks. - sleepUntil(BooleanSupplier, int) - Static method in class privbot.context.Time
-
Polls
supplierevery 10 ms until it istrueortimeOutms pass. - sleepUntil(BooleanSupplier, int) - Method in class privbot.task.PrivTaskContext
-
Time.sleepUntil(BooleanSupplier, int): true once the condition holds, false on timeout. - sleepUntil(BooleanSupplier, int, int) - Static method in class privbot.context.Time
-
Time.sleepUntil(BooleanSupplier, BooleanSupplier, int, int)with no reset condition. - sleepUntil(BooleanSupplier, int, int) - Method in class privbot.task.PrivTaskContext
-
Time.sleepUntil(BooleanSupplier, int, int)with a custom polling interval. - sleepUntil(BooleanSupplier, BooleanSupplier, int) - Static method in class privbot.context.Time
-
Time.sleepUntil(BooleanSupplier, BooleanSupplier, int, int)polling every 10 ms. - sleepUntil(BooleanSupplier, BooleanSupplier, int, int) - Static method in class privbot.context.Time
-
Polls
supplieruntil it returnstrueortimeOutms pass. - sleepWhile(BooleanSupplier, int) - Static method in class privbot.context.Time
-
Polls every 10 ms while
supplieristrue. - sleepWhile(BooleanSupplier, int) - Method in class privbot.task.PrivTaskContext
-
Time.sleepWhile(BooleanSupplier, int): true once the condition turns false. - sleepWhile(BooleanSupplier, int, int) - Static method in class privbot.context.Time
-
Time.sleepWhile(BooleanSupplier, int)with a custom polling interval in milliseconds. - slot - Variable in class privbot.hooks.container.ItemContainerSnapshot.Item
-
Item id, slot index and stack quantity.
- slot() - Method in class privbot.mechanics.GearSetup.Entry
- slot(int) - Method in class privbot.hooks.container.ItemContainerSnapshot
- slotIndex() - Method in class privbot.hooks.bank.BankSlot
-
Position within the container — the
param0of a withdraw. - slotIndex() - Method in class privbot.hooks.container.ContainerSlot
-
Position within the container — the
param0. - slotIndex() - Method in class privbot.hooks.shop.ShopSlot
-
Position within the container — the
param0of a buy. - snapshot() - Method in class privbot.actions.confirm.ActionHandle
- snapshot() - Method in class privbot.hooks.Equipment
-
Immutable worn-slot facts; see
Inventory.snapshot()for source and read-scope rules. - snapshot() - Method in class privbot.hooks.Inventory
-
Detached facts captured in one client callback.
- snapshot() - Method in class privbot.movement.pathing.ExactStepHandle
- snapshot(PvpQuery) - Method in class privbot.hooks.Pvp
-
Reads the fight once.
- snapshot(ThreatQuery) - Method in class privbot.hooks.Threats
-
Reads the fight once.
- Snapshot<S> - Class in privbot.ui.overlay
-
State published on the game tick and read on the render thread.
- softBlocked - Variable in class privbot.mechanics.SpecialAttackPolicy.State
- sort(Comparator<PrivItem>) - Method in class privbot.query.ItemQuery
-
Sort the working list in place (e.g.
- source - Variable in class privbot.hooks.VarRegistry.Entry
-
Where the entry came from: this client's own names, or the bundled list with its evidence note.
- source() - Method in class privbot.mechanics.IncomingStyleDecision.Decision
- SPACE_LG - Static variable in class privbot.ui.GearTheme
-
Large spacing in pixels.
- SPACE_LG - Static variable in class privbot.ui.ModernTheme
-
Spacing: 16 px.
- SPACE_MD - Static variable in class privbot.ui.GearTheme
-
Medium spacing in pixels.
- SPACE_MD - Static variable in class privbot.ui.ModernTheme
-
Spacing: 12 px.
- SPACE_SM - Static variable in class privbot.ui.GearTheme
-
Small spacing in pixels.
- SPACE_SM - Static variable in class privbot.ui.ModernTheme
-
Spacing: 8 px.
- SPACE_XL - Static variable in class privbot.ui.GearTheme
-
Extra-large spacing in pixels.
- SPACE_XL - Static variable in class privbot.ui.ModernTheme
-
Spacing: 24 px.
- SPACE_XS - Static variable in class privbot.ui.GearTheme
-
Extra-small spacing in pixels.
- SPACE_XS - Static variable in class privbot.ui.ModernTheme
-
Spacing: 4 px.
- SPACE_XXL - Static variable in class privbot.ui.ModernTheme
-
Spacing: 32 px.
- SPACE_XXS - Static variable in class privbot.ui.ModernTheme
-
Spacing: 2 px.
- SPAWNPK - Enum constant in enum privbot.api.ServerId
- spec() - Method in class privbot.mechanics.PvpFightHistory.View
-
Energy-drop interpretation, or null when the server rule was not selected; the interval may span ticks.
- SPEC - Enum constant in enum privbot.mechanics.Commitment.Episode
- SPEC - Enum constant in enum privbot.mechanics.GraniteMaulDecision.Kind
- specArmed() - Method in class privbot.mechanics.FightFrame
- SpecEnergy - Class in privbot.mechanics
-
Whether a special attack fired between two readings of special-attack energy: a fire is an energy drop.
- SpecEnergy.Fired - Enum in privbot.mechanics
- specFired - Variable in class privbot.mechanics.PvpFightHistory.Inputs
- SPECIAL - Static variable in class privbot.ui.GearTheme
-
Special-attack accent (amber).
- specialAttackArmedOrNull() - Method in class privbot.hooks.Combat
-
Whether the spec orb is armed, or null when it could not be read.
- specialAttackPercentOrNull() - Method in class privbot.hooks.Combat
-
Special attack energy 0–100, or null when it could not be read.
- SpecialAttackPolicy - Class in privbot.mechanics
-
Pure special-attack phase ordering.
- SpecialAttackPolicy.Decision - Class in privbot.mechanics
- SpecialAttackPolicy.Phase - Enum in privbot.mechanics
- SpecialAttackPolicy.State - Class in privbot.mechanics
-
All flags are nullable: null is unreadable.
- specialSetReady(FightFrame, GearSetup) - Static method in class privbot.mechanics.PvpActionPlanner
-
Compares a nonempty special set with this frame's actual equipment.
- SpecWatch - Class in privbot.mechanics
-
Single-owner special-energy observation history; it never treats an unreadable sample as an energy value.
- SpecWatch() - Constructor for class privbot.mechanics.SpecWatch
- SpecWatch.Result - Class in privbot.mechanics
- SpecWatch.Status - Enum in privbot.mechanics
- SPELL - Enum constant in enum privbot.mechanics.AttackHistory.Family
- SPELL - Enum constant in enum privbot.mechanics.PvpArbiter.Kind
- SPELLBOOK_UNAVAILABLE - Enum constant in enum privbot.hooks.Magic.CastOutcome
-
The book could not be shown (overlay, no magic tab, or the tab did not open in time).
- spellbookOpen - Variable in class privbot.mechanics.PvpArbiter.Context
- spellbookOpenMs - Variable in class privbot.restock.RestockRoute
- spellbookTab() - Method in class privbot.hooks.Magic
-
The magic tab's state, read in one
GameThread.ensure(java.util.function.Supplier<T>, T)(EDT-ordered on the EDT-marshal servers, so it sees a tab click queued before it). - spellbookTabInBatch() - Method in class privbot.hooks.Magic
-
Magic.spellbookTab()for a caller that already owns the client-thread batch. - SpellEffects - Class in privbot.mechanics
-
Freeze, Vengeance and Tele Block on us and on opponents, tracked from the graphics and animations a PvP snapshot reads each tick.
- SpellEffects(IntUnaryOperator) - Constructor for class privbot.mechanics.SpellEffects
- stackable() - Method in class privbot.hooks.LootDrop
- stage() - Method in class privbot.restock.RestockCycle
- StagedTaskRunner<C> - Class in privbot.task
-
Runs
TaskNodes inAutomationStageorder. - StagedTaskRunner(Supplier<C>) - Constructor for class privbot.task.StagedTaskRunner
- StagedTaskRunner(Supplier<C>, BooleanSupplier) - Constructor for class privbot.task.StagedTaskRunner
- stageSince() - Method in class privbot.restock.RestockCycle
- stalled(int, Boolean, Map<String, Integer>) - Method in class privbot.mechanics.OwnAttackClock
-
Whether a faced opponent has gone beyond the ready/send deadline without a later confirmed fire.
- stalled(long) - Method in class privbot.mechanics.ProgressWatchdog
- stallMs - Variable in class privbot.movement.pathing.NavigationSession.Policy
- STANDARD_HEIGHT - Static variable in class privbot.ui.fx.FxStudioShell
-
The standard studio height; see
FxStudioShell.STANDARD_WIDTH. - STANDARD_WIDTH - Static variable in class privbot.ui.fx.FxStudioShell
-
The studio size every plugin should use unless it has a reason not to.
- standardSize() - Method in class privbot.ui.fx.FxStudioShell.Builder
- start() - Method in class privbot.hooks.Hotkeys
- start() - Method in class privbot.task.ScriptExecutor
-
Starts the script thread.
- start() - Method in class privbot.task.TaskNodeRunner
-
Starts the owned script worker.
- start(String, Class<?>) - Method in class privbot.hooks.Capture
-
Starts a recording run for this plugin under the current server id.
- start(Client) - Static method in class privbot.query.WidgetQuery
-
Empty query — add widgets with
WidgetQuery.root(int),WidgetQuery.withWidget(Widget), or useWidgets.queryAt(int). - startCycle - Variable in class privbot.hooks.Events.GraphicEvent
-
The client cycle it starts on.
- startCycle - Variable in class privbot.hooks.Events.ProjectileEvent
-
Client cycle it was launched on.
- startCycle() - Method in class privbot.mechanics.GraphicView
- startCycle() - Method in class privbot.mechanics.ShotView
- startRefreshTimer(int) - Method in class privbot.ui.PrivBotFrame
-
Starts a periodic refresh timer.
- startRefreshTimer(int, Runnable) - Method in class privbot.ui.PrivBotPanel
-
Starts a periodic refresh timer.
- startStop(Runnable, Runnable, BooleanSupplier) - Method in class privbot.ui.PrivBotPanel.Builder
-
The Start/Stop button.
- startTimer(String, long) - Method in class privbot.effects.EffectTracker
-
Explicit local timer helper, not evidence of server acceptance.
- stat(String, Supplier<?>) - Method in class privbot.ui.PrivBotPanel.Builder
-
A stat row whose value is read from
valueon every refresh (null renders "-"). - state() - Method in class privbot.api.Observed
- state() - Method in interface privbot.mechanics.Job
-
The state after the latest step; RUNNING before the first.
- state() - Method in class privbot.ui.overlay.PrivBotOverlayPanel
-
The state for this render (the constructor's supplier unless a subclass supplies it).
- State(int, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, ItemContainerSnapshot, KnockoutRisk.Assessment, Integer, Integer, Integer, Integer, Integer, Integer) - Constructor for class privbot.mechanics.ConsumePlanner.State
- State(Boolean, Boolean, Boolean, Boolean, Integer, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Integer) - Constructor for class privbot.mechanics.SpecialAttackPolicy.State
- status - Variable in class privbot.actions.confirm.ActionSnapshot
- status() - Method in class privbot.actions.confirm.ActionHandle
- status() - Method in class privbot.api.ApiVersion.Verdict
- status() - Method in class privbot.api.Outcome
- status() - Method in class privbot.mechanics.AttackFireDetector.Result
- status() - Method in class privbot.mechanics.SpecWatch.Result
- status() - Method in class privbot.movement.pathing.ExactStepHandle
- status() - Method in interface privbot.movement.pathing.NavigationHandle
- status() - Method in class privbot.movement.pathing.NavigationSession
- status(String, Object...) - Method in class privbot.task.SimpleNode
-
Sets the node's status with optional formatting and notifies listeners.
- status(String, Object, Color) - Method in class privbot.ui.overlay.Rows
-
A state row: the value is a status word coloured by
color. - STATUS_OFF - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for an "off" status value.
- STATUS_ON - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for an "on" status value.
- STATUSBAR_PRIMARY - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for the primary status-bar text.
- step(BooleanSupplier) - Method in class privbot.movement.pathing.NavigationSession
- step(PrivTaskContext) - Method in interface privbot.mechanics.Job
-
Advance the job one step and return the state it ended in.
- step(PrivTaskContext, RestockCycle, RestockHost) - Method in class privbot.restock.RestockRunner
-
Runs the current stage's step.
- STEP_OUT - Enum constant in enum privbot.mechanics.PvpArbiter.Kind
- STEP_OUT - Enum constant in enum privbot.mechanics.PvpMovement.Kind
- STEP_REATTACK_TICKS - Static variable in class privbot.mechanics.AttackTiming
- stepTimeoutMs - Variable in class privbot.movement.pathing.NavigationOptions
-
Used only for waiting after teleport/transport (arrival, widget).
- stepWindow(Integer, Integer) - Static method in class privbot.mechanics.AttackTiming
-
Window from the last confirmed fire until two ticks before the estimated next attack.
- stillMissing() - Method in class privbot.mechanics.SwitchCheck
- stock() - Method in class privbot.hooks.shop.ShopSlot
-
Units the shop still has, as reported by the container's quantity array.
- stockOf(ShopSlot) - Method in class privbot.hooks.shop.ShopInterface
-
Remaining shop stock for a slot, or 0 when unreadable.
- stop() - Method in class privbot.hooks.Capture
-
Ends the run: its manifest is finalised.
- stop() - Method in class privbot.hooks.Hotkeys
- stop() - Method in class privbot.task.ScriptExecutor
-
Stops the script thread.
- stop() - Method in class privbot.task.TaskNodeRunner
-
Stops the owned worker (waiting up to 2 s for it to exit), cancels pending HANDS dispatches and resets nodes.
- stopNow(String, long) - Method in class privbot.restock.RestockCycle
-
Stops at once with the reason (no retry would help).
- stopped() - Method in class privbot.restock.RestockCycle
- stopped(String) - Method in interface privbot.restock.RestockHost
-
The cycle stopped for good with this reason: the plugin stops automation.
- STOPPED - Enum constant in enum privbot.restock.RestockCycle.Stage
- stopReason() - Method in class privbot.restock.RestockCycle
- stopRefreshTimer() - Method in class privbot.ui.PrivBotFrame
-
Stops the refresh timer.
- stopRefreshTimer() - Method in class privbot.ui.PrivBotPanel
-
Stops the refresh timer.
- strength - Variable in class privbot.mechanics.ConsumePlanner.State
- strength() - Method in class privbot.mechanics.CombatLevels
- strengthReal - Variable in class privbot.mechanics.ConsumePlanner.State
- strengthReal() - Method in class privbot.mechanics.CombatLevels
- style - Variable in class privbot.hooks.Events.HitsplatEvent
-
The server's style code, or -1 when unknown (always -1 for forwarded events).
- style - Variable in class privbot.mechanics.Commitment
-
The style we are committed to, or null; and the tick it was chosen.
- style - Variable in class privbot.mechanics.ThreatMemory.Hit
- style() - Method in class privbot.mechanics.AttackFireDetector.Result
- style() - Method in class privbot.mechanics.IncomingStyleDecision.Decision
- style() - Method in class privbot.mechanics.PvpArbiter.Action
- style() - Method in class privbot.mechanics.StylePlanner.Candidate
- styleComboBox(JComboBox<?>) - Static method in class privbot.ui.ModernTheme
-
Styles a JComboBox to match the modern theme, including the popup menu.
- styleDangerButton(JButton) - Static method in class privbot.ui.SwingFormKit
-
Restyles a plain
JButtonas a red danger button. - StyledToggleButton() - Constructor for class privbot.ui.ModernTheme.StyledToggleButton
-
Bold, hand-cursor toggle; set its background and foreground for each state.
- styleInput(JComponent) - Static method in class privbot.ui.ModernTheme
-
Applies standard input styling (background, foreground, font, border) to a component.
- styleInput(JComponent) - Static method in class privbot.ui.SwingFormKit
- StylePlanner - Class in privbot.mechanics
-
Deterministic style-set planning with the flagship's least-switching, range and commitment rules.
- StylePlanner.Candidate - Class in privbot.mechanics
- StylePlanner.Decision - Class in privbot.mechanics
- StylePlanner.GearPick - Class in privbot.mechanics
-
One carried item matched to a missing equipment slot.
- StylePolicy - Class in privbot.mechanics
-
Which combat style to fight in against an opponent's protection prayer.
- stylePrimaryButton(JButton) - Static method in class privbot.ui.SwingFormKit
-
Restyles a plain
JButtonas a primary (indigo) button. - styleSecondaryButton(JButton) - Static method in class privbot.ui.SwingFormKit
-
Restyles a plain
JButtonas an outlined secondary button. - STYLESHEET_RESOURCE - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Classpath path of the shared studio stylesheet; colour tokens live on its
.root. - styleSince - Variable in class privbot.mechanics.Commitment
- styleSpinner(JSpinner) - Static method in class privbot.ui.ModernTheme
-
Applies the input colours, font and border to a spinner and its editor field.
- styleToggle(JComponent) - Static method in class privbot.ui.SwingFormKit
-
Input styling for a toggle button or checkbox; other components get
SwingFormKit.styleInput(javax.swing.JComponent). - summary() - Method in class privbot.mechanics.Commitment
-
The commitment part of the capture's memory map (plan T9.5): plain data, never read back.
- supplies(PrivTaskContext) - Static method in class privbot.restock.RestockRunner
-
The carried items by name (the supplies the next fight starts with).
- support(Capability) - Method in interface privbot.api.Capabilities
-
The recorded support level;
Support.UNKNOWNwhen nothing is recorded. - Support - Enum in privbot.api
-
How well the unified API does one
Capabilityon one server. - SUPPORTED - Enum constant in enum privbot.api.Support
-
Verified to work.
- supports(Capability) - Method in interface privbot.api.Capabilities
- survival() - Method in class privbot.mechanics.DamageRow
- SUSPECT_ZERO - Enum constant in enum privbot.mechanics.SpecEnergy.Fired
- SUSPECT_ZERO - Enum constant in enum privbot.mechanics.SpecWatch.Status
- sustain - Variable in class privbot.context.PrivContext
-
Keeps hitpoints, prayer and stat boosts up (eat, brew, restore, dose), each consume proved by the count.
- sustain - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.sustain. - Sustain - Class in privbot.hooks
-
Keeps the player alive and boosted:
ctx.sustain. - SUSTAIN - Enum constant in enum privbot.api.Capability
-
Staying alive and boosted: eating (combo eats included) and brewing for hitpoints, prayer restores, and stat boost doses such as overloads, each consume proved by the carried count dropping.
- SustainChoice - Class in privbot.mechanics
-
What
SustainPolicysays to do about hitpoints, prayer or a boost this tick. - SustainChoice.Kind - Enum in privbot.mechanics
-
The kinds of answer.
- SustainOutcome - Class in privbot.mechanics
-
What one call of
ctx.sustain.maintaindid. - SustainOutcome.Kind - Enum in privbot.mechanics
-
The kinds of outcome.
- SustainPlan - Class in privbot.mechanics
-
What to eat and drink, and when.
- SustainPlan.Builder - Class in privbot.mechanics
-
Builds a
SustainPlan. - SustainPolicy - Class in privbot.mechanics
-
Chooses the one sustain action to take this tick (eat, brew, prayer restore, boost dose) from values the caller has already read.
- SwingFormKit - Class in privbot.ui
-
Swing form layout + button styling helpers shared across plugins (sidebar panels, Swing dialogs).
- swingsUnseen(int) - Method in class privbot.mechanics.AttackExpiryTracker
-
Whether the observed run reaches the chosen threshold; null when missing evidence could change the answer.
- swingsUnseen(int) - Method in class privbot.mechanics.OwnAttackClock
-
Whether consecutive accepted sends expired unseen; null if a gap prevents a reliable count.
- SwitchCheck - Class in privbot.mechanics
-
Proves a same-tick gear switch on later ticks, and backs off a switch that keeps failing.
- SwitchCheck() - Constructor for class privbot.mechanics.SwitchCheck
-
A check with 3 verify ticks.
- SwitchCheck(int) - Constructor for class privbot.mechanics.SwitchCheck
- SwitchCheck.State - Enum in privbot.mechanics
-
A verdict on the outstanding switch.
- SWITCHED - Enum constant in enum privbot.mechanics.OpponentLockPolicy.Event
- SwitchResult - Class in privbot.mechanics
-
What one
ctx.loadouts.switchTo(..)call sent. - SwitchResult(List<String>, List<String>, List<String>, List<String>, boolean) - Constructor for class privbot.mechanics.SwitchResult
- switchTo(GearSetup) - Method in class privbot.hooks.Loadouts
-
Puts on every missing worn piece of
wornin this one call: a same-tick gear switch.
T
- TagAllTracker - Class in privbot.mechanics
-
Spreads a first hit across every NPC in a group before finishing any, the tag-all-then-kill pattern.
- TagAllTracker() - Constructor for class privbot.mechanics.TagAllTracker
- taggedCount() - Method in class privbot.mechanics.TagAllTracker
-
How many indices are currently tagged (diagnostics).
- take() - Method in class privbot.wrappers.PrivGroundItem
-
Takes this item from the ground.
- take(String...) - Method in class privbot.hooks.GroundItems
-
Takes the closest ground item matching any supplied name.
- takeClosest(String...) - Method in class privbot.hooks.GroundItems
-
Takes the closest ground item matching any supplied name.
- takeConfiguredDrop(Predicate<LootDrop>, int) - Method in class privbot.hooks.GroundItems
-
Scans like
GroundItems.configuredDrop(java.util.function.Predicate<privbot.hooks.LootDrop>, int), rechecks the policy and sends a Take on the nearest accepted stack, all on the client thread. - takeOne(PrivTaskContext, List<String>, RestockHost) - Method in class privbot.restock.GroundLoot
-
Takes the nearest wanted item and confirms it by the inventory count of its id rising.
- target - Variable in class privbot.hooks.Events.ProjectileEvent
-
The target, or null when it has none or it did not resolve.
- target() - Method in class privbot.mechanics.PvpArbiter.Action
-
Detached attack target from the decision frame, or null for untyped actions.
- targetBusy - Variable in class privbot.mechanics.PvpArbiter.Context
- targetedByUs - Variable in class privbot.mechanics.OpponentLockPolicy.Candidate
- TARGETING - Enum constant in enum privbot.api.Capability
-
Choosing and keeping a target.
- TargetLock - Class in privbot.mechanics
-
Chooses which NPC to fight and sticks to it, so a bot does not flip between two targets every tick.
- TargetLock() - Constructor for class privbot.mechanics.TargetLock
- targetPoint() - Method in class privbot.hooks.TransportRequest
- targetRadius() - Method in class privbot.hooks.TransportRequest
- targets - Variable in class privbot.context.PrivContext
-
Picking a target: a sticky lock over a snapshot's NPCs, and a safe way back to the live NPC.
- targets - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.targets. - Targets - Class in privbot.hooks
-
Picking a target:
ctx.targets. - targetsLocalPlayer - Variable in class privbot.hooks.Events.ProjectileEvent
-
TRUE when the target is the local player, FALSE when it is someone else, null when there is no resolved target (a ground-targeted projectile, or a target that could not be read): null is not "not at me".
- targetsOther() - Method in class privbot.mechanics.NpcView
-
Legacy convenience: false also when unreadable; use observedTargetsOther for decisions.
- TargetSpec - Class in privbot.mechanics
-
Which NPCs count as a target: by name, by id, minus an ignore list, optionally inside an area.
- targetsUs - Variable in class privbot.mechanics.OpponentLockPolicy.Candidate
- targetsUs() - Method in class privbot.mechanics.NpcView
-
Legacy convenience: false also when unreadable; use observedTargetsUs for decisions.
- targetsUs() - Method in class privbot.mechanics.PlayerView
- targetsUs() - Method in class privbot.mechanics.ShotView
-
True or false when the target was read,
nullwhen it could not be. - taskContext - Variable in class privbot.hooks.Restock.Request
-
Elorin: the plugin's task context (the runner reads facades through it).
- taskContext(PrivTaskContext) - Method in class privbot.hooks.Restock.Builder
- Task contract - Search tag in class privbot.sdk.PrivBotAPI
- Section
- TaskNode<C> - Interface in privbot.task
-
Base interface for all task nodes in the PrivBot task framework.
- TaskNodeRunner<C> - Class in privbot.task
-
Manages a flat list of
TaskNodes and executes the highest-priority valid node each tick. - TaskNodeRunner(C) - Constructor for class privbot.task.TaskNodeRunner
-
Creates a runner that holds
contextfor every tick. - TaskNodeRunner(C, String) - Constructor for class privbot.task.TaskNodeRunner
- TaskNodeRunner(C, BooleanSupplier) - Constructor for class privbot.task.TaskNodeRunner
-
Creates a runner that holds
contextand skips ticks whenrunnableCheckreturns false. - TaskNodeRunner(Supplier<C>) - Constructor for class privbot.task.TaskNodeRunner
-
Creates a runner with the given context supplier.
- TaskNodeRunner(Supplier<C>, BooleanSupplier) - Constructor for class privbot.task.TaskNodeRunner
-
Creates a runner with a runnable guard.
- TaskPriorityBands - Class in privbot.task
-
Optional named integers for catalog and staged task trees.
- TaskTraceListener - Interface in privbot.task
-
Optional read-only diagnostics.
- TELEBLOCK - Enum constant in enum privbot.mechanics.Commitment.Episode
- TELEBLOCK_GRAPHIC - Static variable in class privbot.mechanics.SpellEffects
-
Tele Block hit graphic.
- TELEBLOCK_TICKS - Static variable in class privbot.mechanics.SpellEffects
-
Tele Block length: 300 s (ElorinPvP
ElorinPvPConstants.TELEBLOCK_SECONDS, ElorinPvPConstants.java:187), 500 ticks. - teleblocked(int) - Method in class privbot.mechanics.SpellEffects
-
Whether we are tele-blocked at
tick(upper bound:SpellEffects.TELEBLOCK_TICKSfrom the graphic). - teleblockedUntil() - Method in class privbot.mechanics.SpellEffects
-
The estimated upper-bound end of the last observed Tele Block, or
SpellEffects.NEVER. - teleport() - Method in class privbot.mechanics.Destination
- TELEPORT - Enum constant in enum privbot.api.Capability
- teleportBackAction - Variable in class privbot.restock.RestockRoute
- teleporter - Variable in class privbot.context.PrivContext
-
Teleport spells, tabs and item teleports.
- teleporter - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.teleporter. - Teleporter - Class in privbot.hooks
-
Teleport actions: casting teleport spells, using teleport tabs, and item-based teleports.
- teleportImprovementThreshold - Variable in class privbot.movement.pathing.NavigationOptions
- teleportMinDistance - Variable in class privbot.movement.pathing.NavigationOptions
- teleports - Variable in class privbot.context.PrivContext
-
Teleport to a named destination (Impact fairy trees; the movement catalog elsewhere).
- teleports - Variable in class privbot.task.PrivTaskContext
-
Mirrors
PrivContext.teleports. - Teleports - Class in privbot.hooks
-
Teleport to a named destination with whatever this server provides:
ctx.teleports. - teleportToItem(int) - Method in class privbot.hooks.Teleporter
-
Activates the first inventory item matching
itemIdusing its primary action ("Rub", "Break", "Activate", etc. - teleportToItem(int, String) - Method in class privbot.hooks.Teleporter
-
Uses a teleport item with a specific action label (case-insensitive).
- teleportToItem(String) - Method in class privbot.hooks.Teleporter
-
Breaks (or otherwise activates) the first inventory item matching
name. - teleportToItem(String, String) - Method in class privbot.hooks.Teleporter
-
Uses the first inventory item matching
namewithaction("Rub","Break","Activate", …). - teleportWidget - Variable in class privbot.restock.RestockRoute
- Tell(int, int) - Constructor for class privbot.mechanics.ThreatMemory.Tell
- TELL - Enum constant in enum privbot.mechanics.IncomingStyleDecision.Source
- tellActive() - Method in class privbot.mechanics.ThreatMemory.View
-
Null when a new tell could not be read and no earlier tell is known to remain active.
- tellGraphic() - Method in class privbot.mechanics.ThreatMemory.View
- terminal() - Method in enum privbot.actions.confirm.ActionStatus
- test(Player) - Method in interface privbot.query.PlayerSearch
- text - Variable in class privbot.hooks.Dialogue.DialogueText
-
The text group's joined text.
- text() - Method in class privbot.hooks.TransportRequest.WidgetPathStep
- text(String) - Static method in class privbot.hooks.TransportRequest.WidgetPathStep
-
A step that clicks the visible option with this text (matched like dialogue options).
- text(String) - Method in class privbot.ui.overlay.Rows
-
A single line of muted text (no value column).
- text(String, Color) - Method in class privbot.ui.overlay.Rows
-
A single line of text in
color(no value column). - TEXT_DIM - Static variable in class privbot.ui.GearTheme
-
Dimmest text: disabled or placeholder content.
- TEXT_INVERSE - Static variable in class privbot.ui.ModernTheme
-
Dark text for light or saturated backgrounds.
- TEXT_MUTED - Static variable in class privbot.ui.GearTheme
-
Muted text: hints and captions.
- TEXT_MUTED - Static variable in class privbot.ui.ModernTheme
-
Muted text, still readable on
ModernTheme.BG_CARD. - TEXT_PRIMARY - Static variable in class privbot.ui.GearTheme
-
Main text.
- TEXT_PRIMARY - Static variable in class privbot.ui.ModernTheme
-
Main text (near white).
- TEXT_SECONDARY - Static variable in class privbot.ui.GearTheme
-
Secondary text and labels.
- TEXT_SECONDARY - Static variable in class privbot.ui.ModernTheme
-
Secondary text and labels.
- TEXT_SHADOW - Static variable in class privbot.ui.overlay.OverlayTheme
-
Drop shadow under scene text.
- textAnchor(WorldPoint, Graphics2D, String, int) - Method in class privbot.ui.overlay.SceneProjection
-
Where to draw
textcentred over a tile (baseline point), or null when off-screen. - textArea - Variable in class privbot.ui.fx.FxFormKit.ResizableMultiline
-
The editable text area; read and write its text here.
- textScale() - Method in class privbot.ui.overlay.PrivBotOverlayPanel
-
The text scale (1.0 = the client's overlay font).
- textScale(double) - Method in class privbot.ui.overlay.PrivBotOverlayPanel
-
Text size relative to the client's overlay font (1.0 = unchanged).
- threat() - Method in class privbot.mechanics.PvpFightHistory.View
- THREAT_READS - Enum constant in enum privbot.api.Capability
-
Reading who and what is threatening the player: attackers, projectiles, graphics, as one snapshot.
- ThreatMemory - Class in privbot.mechanics
-
Single-owner rolling threat memory.
- ThreatMemory() - Constructor for class privbot.mechanics.ThreatMemory
- ThreatMemory.Hit - Class in privbot.mechanics
- ThreatMemory.Tell - Class in privbot.mechanics
-
A verified magic tell and its lead in client cycles; callers perform server-ID matching before construction.
- ThreatMemory.View - Class in privbot.mechanics
- ThreatQuery - Class in privbot.mechanics
-
What a
ctx.threats.snapshot(..)call should include. - threats - Variable in class privbot.context.PrivContext
-
A detached per-tick snapshot of the fight (NPCs, projectiles, graphics, HP, chosen prayers) for the pure planners in
privbot.mechanics. - threats - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.threats. - threats() - Method in class privbot.mechanics.FightFrame
- Threats - Class in privbot.hooks
-
ctx.threats: a detached, per-tick copy of the fight around the local player (NPCs, projectiles, graphics, hitpoints and chosen prayers), the same on every server. - ThreatSnapshot - Class in privbot.mechanics
-
A detached copy of one tick of a fight: the local player, the NPCs, projectiles and graphics around them, and the prayers that were checked.
- ThreatSnapshot(int, int, WorldPoint, Integer, Integer, Integer, int, List<NpcView>, List<ShotView>, List<GraphicView>, Set<String>, Set<String>) - Constructor for class privbot.mechanics.ThreatSnapshot
- tick - Variable in class privbot.hooks.Events.AnimationEvent
-
The game tick it was seen on (-1 when unknown).
- tick - Variable in class privbot.hooks.Events.ChatEvent
-
The game tick it was seen on (-1 when unknown).
- tick - Variable in class privbot.hooks.Events.DeathEvent
-
The game tick it was detected on (-1 when unknown).
- tick - Variable in class privbot.hooks.Events.GraphicEvent
-
The game tick it was seen on (-1 when unknown).
- tick - Variable in class privbot.hooks.Events.HitsplatEvent
-
The game tick it was seen on (-1 when unknown).
- tick - Variable in class privbot.hooks.Events.ProjectileEvent
-
The game tick it was seen on (-1 when the tick could not be read).
- tick - Variable in class privbot.hooks.Events.VarChange
-
The game tick it was seen on (-1 when unknown).
- tick - Variable in class privbot.mechanics.ConsumePlanner.State
- tick() - Method in class privbot.hooks.Game
-
The game's tick counter (one per 600 ms server tick), with "cannot read" kept apart:
Game.getTickCount()answers -1 for that, which tick arithmetic easily mistakes for a number. - tick() - Method in class privbot.hooks.Recovery
-
Deprecated.Impact-only and unproved; use
Recovery.afterDeath(RecoveryPlan), which waits for the respawn, reclaims where the server can, restocks and returns, on every server - tick() - Method in class privbot.mechanics.FightFrame
- tick() - Method in class privbot.mechanics.InstantMaulPlan.Plan
-
Decision tick, or null when no fight frame was available.
- tick() - Method in class privbot.mechanics.KnockoutWeaponDecision.Decision
- tick() - Method in class privbot.mechanics.KnockoutWeaponPlan.Plan
- tick() - Method in class privbot.mechanics.OpponentLockPolicy.Result
- tick() - Method in class privbot.mechanics.PvpFinisherCoordinator.Plan
- tick() - Method in class privbot.mechanics.PvpKoCoordinator.Plan
- tick() - Method in class privbot.mechanics.PvpMaulCoordinator.Plan
-
Decision tick.
- tick() - Method in class privbot.mechanics.PvpMovement.Decision
- tick() - Method in class privbot.mechanics.PvpSnapshot
- tick() - Method in class privbot.mechanics.StylePlanner.Candidate
-
Tick and exact item picks are available only for a candidate derived from a fight frame.
- tick() - Method in class privbot.mechanics.ThreatMemory.View
-
Tick for which this detached memory view was calculated.
- tick() - Method in class privbot.mechanics.ThreatSnapshot
- tick() - Method in class privbot.task.StagedTaskRunner
-
Runs one tick: the highest-priority valid node of the first stage that has one executes.
- tick() - Method in class privbot.task.TaskNodeRunner
-
Executes one tick.
- tick(int) - Method in class privbot.hooks.Events.Frame.Builder
- ticks(int, int) - Static method in class privbot.ui.overlay.ColorRamp
-
A tick countdown:
value <= urgentAtisOverlayTheme.BAD,<= warnAtisOverlayTheme.WARN, anything later isOverlayTheme.INFO. - ticks(int, int, Color, Color, Color) - Static method in class privbot.ui.overlay.ColorRamp
-
ColorRamp.ticks(int, int)with your own three colours. - ticks(String, CombatStyle, Map<String, Integer>) - Static method in class privbot.mechanics.WeaponSpeeds
-
The attack cycle of this weapon in ticks:
overrides(keys lower-cased, matched by containment, asWeaponSpeeds.parse(java.lang.String, java.util.List<java.lang.String>)produces them), then the keyword table, then the OSRS table, then the style's default. - ticksIntoEpisode(int) - Method in class privbot.mechanics.Commitment
-
Ticks into the running episode at
tick, or -1 when none runs. - ticksSince(int) - Method in class privbot.hooks.Game
-
Primitive form of
Game.observedTicksSince(int): the elapsed ticks, or-1when unknown. - tile - Variable in class privbot.hooks.Events.DeathEvent
-
Where the player was on the last readable tick, or null.
- tile - Variable in class privbot.restock.GroundLoot.Ground
- tile() - Method in class privbot.hooks.LocalPlayer
-
Where the player is drawn (the client's player location).
- tile() - Method in class privbot.mechanics.Destination
- tile() - Method in class privbot.mechanics.GraphicView
- tile() - Method in class privbot.mechanics.NpcView
-
South-west corner of the footprint, or
nullwhen it could not be read. - tile() - Method in class privbot.mechanics.PlayerView
- tile() - Method in class privbot.mechanics.PvpArbiter.Action
-
Destination for a planned movement, or null on other actions.
- tile() - Method in class privbot.mechanics.PvpMovement.Decision
- tile(WorldPoint, Color) - Method in class privbot.ui.overlay.SceneCanvas
-
Fill a tile with
coloratOverlayTheme.TILE_ALPHAand outline it solid. - tile(WorldPoint, Color, Color) - Method in class privbot.ui.overlay.SceneCanvas
-
Fill and outline a tile with explicit colours; either may be null to skip it.
- TILE_ALPHA - Static variable in class privbot.ui.overlay.OverlayTheme
-
Alpha for filled tiles: the value every tile overlay converged on.
- tileFill(Color) - Static method in class privbot.ui.overlay.OverlayTheme
-
A tile fill for
c: same hue atOverlayTheme.TILE_ALPHA. - tileOf(Actor, Color) - Method in class privbot.ui.overlay.SceneCanvas
-
Fill the tile under an actor.
- tilePoly(Actor) - Method in class privbot.ui.overlay.SceneProjection
-
The tile polygon under an actor (its world location, which on Impact is the centre tile).
- tilePoly(WorldPoint) - Method in class privbot.ui.overlay.SceneProjection
-
The four-corner canvas polygon of a world tile, or null when off-screen / out of scene.
- tiles(int) - Method in class privbot.mechanics.HazardMap
-
A copy of every tile that is dangerous at
nowTick. - tiles(Iterable<WorldPoint>, Color) - Method in class privbot.ui.overlay.SceneCanvas
-
SceneCanvas.tile(WorldPoint, Color)for each tile; null draws nothing. - Time - Class in privbot.context
-
Script-thread sleep utilities — matching the Unethicalite
Time/ DreamBotSleepAPI. - TIMED_OUT - Enum constant in enum privbot.actions.confirm.ActionStatus
- TIMED_OUT - Enum constant in enum privbot.mechanics.DrinkProof.State
- TIMED_OUT - Enum constant in enum privbot.mechanics.FoodProof.State
- timeoutMs - Variable in class privbot.movement.pathing.NavigationSession.Policy
- timersStamped(ConsumePlanner.Settings, ConsumePlanner.Action) - Static method in class privbot.mechanics.ConsumePlanner
-
Timers to stamp after this plan's action is accepted.
- times(int) - Method in class privbot.hooks.Production.Make
-
Make exactly
n(>=1). - title - Variable in class privbot.ui.overlay.OverlayPalette
-
The resolved colours, all opaque: card
backgroundandborder,title, rowlabelandvalue,accent(LEVEL bars), and the status coloursinfo,good,warn,muted. - title - Variable in class privbot.ui.PrivBotFrame.SectionInfo
-
Text on the navigation button and in the status bar.
- title() - Method in class privbot.ui.overlay.PrivBotOverlayPanel
-
The title given to the constructor.
- title(String) - Method in class privbot.ui.overlay.Rows
-
A title line in
OverlayTheme.TITLEgold. - title(String, Color) - Method in class privbot.ui.overlay.Rows
-
A title line in
color; null text renders empty. - TITLE - Enum constant in enum privbot.ui.overlay.PaletteSettings.Slot
- TITLE - Static variable in class privbot.ui.overlay.OverlayTheme
-
HUD panel title: the brand gold every plugin overlay already used.
- titleFor(S) - Method in class privbot.ui.overlay.PrivBotOverlayPanel
-
The title shown for
state; the constructor's title unless a subclass names one per state. - to - Variable in class privbot.config.ConfigMigration.Change
- to() - Method in class privbot.mechanics.AttackTiming.Window
- to(String) - Method in class privbot.hooks.Teleports
-
Takes one step toward
destination. - to(String) - Method in class privbot.hooks.Travel
-
Blocking: travel to a named place.
- to(WorldPoint) - Method in class privbot.hooks.Travel
-
Blocking: travel to a raw world point (arrive radius 2).
- to(WorldPoint, NavigationOptions, long) - Method in class privbot.hooks.Travel
-
Blocking: travel to a raw world point with caller-chosen options and timeout.
- to(Places.Place) - Method in class privbot.hooks.Travel
-
Blocking: travel to a resolved
Places.Place. - to(RestockTarget) - Method in class privbot.hooks.Restock
-
Starts a job that banks until the player wears
target.worn()and carriestarget.carried(), the same on every server (Impact, Elorin, Orion, SpawnPK, Roat Pkz). - toaDefaults(int, int, int) - Static method in class privbot.hooks.GameObjects.ToaRewardsRoomChest.Config
- toBank() - Method in class privbot.hooks.Travel
-
Blocking: travel to the nearest configured bank (uses PathingAPI's bank routing).
- toggle() - Method in class privbot.ui.ToggleSwitch
-
Flips the state and runs the toggle callback (also what a click does).
- toggle(String) - Method in class privbot.hooks.Prayer
-
Sends a toggle for the prayer with this in-game name, whatever its current state.
- Toggle(boolean, long) - Constructor for class privbot.mechanics.PrayerToggleGuard.Toggle
- TOGGLE_OFF - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for a toggle in the off state.
- TOGGLE_ON - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for a toggle in the on state; see
FxFormKit.applyToggleStyle(javafx.scene.control.ToggleButton). - toggleQuickPrayers() - Method in class privbot.hooks.Prayer
-
Click the quick-prayer orb once, the way this server's own orb click is sent.
- toggleSpecialAttack() - Method in class privbot.hooks.Combat
-
Clicks the special attack orb once, whatever its state.
- ToggleSwitch - Class in privbot.ui
-
Modern toggle switch for ON/OFF (same visual language as RuleEngine; lives in shared-lib for reuse).
- ToggleSwitch() - Constructor for class privbot.ui.ToggleSwitch
-
An off switch, fixed at 44 x 22 px; a click toggles it.
- ToggleSwitch(boolean) - Constructor for class privbot.ui.ToggleSwitch
-
A switch in
initialState. - toggleWithdrawNotes() - Method in class privbot.hooks.Bank
-
Toggle the observed Note/Item control once.
- toJson() - Method in class privbot.mechanics.GearSetup
- toJson(String) - Method in class privbot.mechanics.GearSetup
-
The JSON form with the server it belongs to recorded as
"server". - toNullableBoolean(Observed<Boolean>) - Static method in class privbot.api.Observed
-
Converts a boolean read into the nullable
Booleanconvention (null = cannot tell). - TOOLBAR_BTN - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for toolbar buttons.
- toOptional() - Method in class privbot.api.Observed
-
Lossy conversion: ABSENT and UNREADABLE both become empty.
- TOPBAR - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for a page top bar.
- toString() - Method in class privbot.api.ApiVersion
-
Canonical
MAJOR.MINOR.PATCH[-qualifier]. - toString() - Method in class privbot.api.ApiVersion.Verdict
- toString() - Method in class privbot.api.Observed
- toString() - Method in class privbot.api.Outcome
- toString() - Method in enum privbot.api.ServerId
- toString() - Method in class privbot.config.ConfigMigration.Change
- toString() - Method in class privbot.hooks.bank.BankSlot
- toString() - Method in class privbot.hooks.bank.WithdrawCapacity
- toString() - Method in class privbot.hooks.bank.WithdrawOption
- toString() - Method in class privbot.hooks.bank.WithdrawPlan.Line
- toString() - Method in class privbot.hooks.container.ContainerSlot
- toString() - Method in class privbot.hooks.container.ItemContainerSnapshot.Item
- toString() - Method in class privbot.hooks.container.ItemLines.Line
- toString() - Method in class privbot.hooks.Dialogue.DialogueText
- toString() - Method in class privbot.hooks.Events.AnimationEvent
- toString() - Method in class privbot.hooks.Events.ChatEvent
- toString() - Method in class privbot.hooks.Events.DeathEvent
- toString() - Method in class privbot.hooks.Events.GraphicEvent
- toString() - Method in class privbot.hooks.Events.HitsplatEvent
- toString() - Method in class privbot.hooks.Events.ProjectileEvent
- toString() - Method in class privbot.hooks.Events.VarChange
- toString() - Method in class privbot.hooks.Magic.CastResult
- toString() - Method in class privbot.hooks.Places.Place
- toString() - Method in class privbot.hooks.shop.ShopOption
- toString() - Method in class privbot.hooks.shop.ShopSlot
- toString() - Method in class privbot.hooks.User.Overhead
- toString() - Method in class privbot.hooks.VarRegistry.Entry
- toString() - Method in class privbot.mechanics.Commitment
- toString() - Method in class privbot.mechanics.Destination
- toString() - Method in class privbot.mechanics.GearSetup.Entry
- toString() - Method in class privbot.mechanics.GearSetup
- toString() - Method in class privbot.mechanics.GraphicView
- toString() - Method in class privbot.mechanics.NpcView
- toString() - Method in class privbot.mechanics.OpponentLock
- toString() - Method in class privbot.mechanics.OverheadWatch
- toString() - Method in class privbot.mechanics.PlayerView
- toString() - Method in class privbot.mechanics.PrayerToggleGuard.Toggle
- toString() - Method in class privbot.mechanics.RecoveryPlan
- toString() - Method in class privbot.mechanics.RestockTarget
- toString() - Method in class privbot.mechanics.ShotView
- toString() - Method in class privbot.mechanics.SustainChoice
- toString() - Method in class privbot.mechanics.SustainOutcome
- toString() - Method in class privbot.mechanics.SwitchResult
- toString() - Method in class privbot.mechanics.ThreatSnapshot
- toString() - Method in class privbot.task.SimpleNode
-
Debug form with name, priority and enabled flag.
- totalValue() - Method in class privbot.mechanics.LootTally
- toward(WorldPoint, int, int) - Method in class privbot.movement.pathing.SceneReachability
-
Substantial recovery waypoint closer to the destination, excluding the unloaded scene edge.
- track(String, DispatchStatus, Supplier<ProofState>, BooleanSupplier, long) - Method in class privbot.actions.confirm.ActionTracker
-
Record one dispatch.
- trade - Variable in class privbot.context.PrivContext
-
Player-to-player trade.
- trade - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.trade. - Trade - Class in privbot.hooks
-
Trade interface state and interaction via
Clientand the game client. - TRADE - Enum constant in enum privbot.api.Capability
- TradeVerb - Class in privbot.hooks.shop
-
Resolves which action to click in order to open a shop.
- transport(String, String...) - Method in class privbot.hooks.Teleporter
-
Uses a movement-catalog transport or NPC entry, then clicks an exact widget path.
- transport(TransportRequest) - Method in class privbot.hooks.Teleporter
-
Same as
Teleporter.transport(TransportRequest, PrivTaskContext)without a task context (widget ready-waits poll on theClientThread). - transport(TransportRequest, PrivTaskContext) - Method in class privbot.hooks.Teleporter
-
Uses a movement-catalog transport or NPC entry, then clicks an exact widget path.
- TransportRequest - Class in privbot.hooks
-
Request for using a movement-catalog transport/NPC entry followed by an exact widget path.
- TransportRequest(String, List<String>) - Constructor for class privbot.hooks.TransportRequest
-
A movement-catalog entry followed by option texts, with default timeouts (30 s to reach the entry, 7.5 s per widget step) and the legacy workflow fallback allowed.
- TransportRequest(String, List<String>, long, long, boolean) - Constructor for class privbot.hooks.TransportRequest
- TransportRequest.WidgetPathStep - Class in privbot.hooks
-
One step along the post-interaction widget path: label text, packed widget id, or inspector path with optional
[index]nesting. - travel - Variable in class privbot.context.PrivContext
-
Getting to a place: walking, transports and teleports.
- travel - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.travel. - Travel - Class in privbot.hooks
-
Get to a named place (walk + transports + teleports), unifying
PathingAPIwith thePlacesnamed-location registry. - trigger(Integer, int, Integer, int) - Static method in class privbot.mechanics.KnockoutWeaponDecision
-
True when either readable HP percentage meets its configured threshold.
- trips() - Method in class privbot.restock.RestockCycle
- tripStartedAt() - Method in class privbot.restock.RestockCycle
- tryArmSpecialAttackOrb() - Method in class privbot.hooks.Combat
-
Arms the orb unless armed, then re-reads it in the same client-thread call.
- tryInteractEat(PrivItem) - Static method in class privbot.hooks.InventoryFoodQueries
-
Dispatches "Eat" on
food. - tryParse(String) - Static method in class privbot.api.ApiVersion
-
ApiVersion.parse(java.lang.String), or empty for a null, blank or malformed value. - type - Variable in class privbot.hooks.Events.ChatEvent
-
The message type, or null when unknown.
- type - Variable in class privbot.hooks.Events.HitsplatEvent
-
The hitsplat type (server numbering).
- typeOnGameCanvas(String, boolean) - Method in class privbot.hooks.Chat
-
Types arbitrary text into the focused game input and optionally presses Enter — same behaviour as workflow
TypeTextAction/SendEnterAction.
U
- unavailable() - Static method in class privbot.hooks.container.ItemContainerSnapshot
- unavailable() - Static method in class privbot.movement.pathing.SceneReachability
- UNAVAILABLE - Enum constant in enum privbot.hooks.Magic.SpellbookTab
-
The magic tab has no root (
tabRoots[TAB_MAGIC] == -1): there is no book to open. - unbind(String) - Method in class privbot.hooks.Hotkeys
- unbindAll() - Method in class privbot.hooks.Hotkeys
- under(int, int, int, int, int) - Static method in class privbot.mechanics.Footprint
-
True when (x,y) is inside the footprint.
- underLine() - Method in class privbot.mechanics.KnockoutRisk.Assessment
- unequip(String...) - Method in class privbot.hooks.Equipment
-
Removes the first worn item matching
nameswith its "Remove" action, sent the way this server's own Remove click is sent. - uniform(Integer, Integer) - Static method in class privbot.mechanics.KnockoutRisk.Candidate
- uniformDangerLine(Integer, Integer, Integer, Integer, Integer) - Static method in class privbot.mechanics.KnockoutMath
-
Highest HP at which the estimated KO probability exceeds the requested percentage, assuming a uniform damage roll from zero to max and the caller's hit accuracy.
- UNKNOWN - Enum constant in enum privbot.actions.confirm.ProofState
- UNKNOWN - Enum constant in enum privbot.api.ServerId
- UNKNOWN - Enum constant in enum privbot.api.Support
-
No evidence either way.
- UNKNOWN - Enum constant in enum privbot.effects.EffectObservation.State
- UNKNOWN - Enum constant in enum privbot.hooks.GameObjects.ToaRewardsRoomChest.Kind
- UNKNOWN - Enum constant in enum privbot.hooks.Magic.SpellbookTab
-
Not readable on this server or right now.
- UNKNOWN - Enum constant in enum privbot.hooks.Prayer.Book
-
Cannot tell: never read it as
Prayer.Book.NORMAL. - UNKNOWN - Enum constant in enum privbot.mechanics.AttackFireDetector.Status
- UNKNOWN - Enum constant in enum privbot.mechanics.DeathWatch.State
-
Hitpoints could not be read.
- UNKNOWN - Enum constant in enum privbot.mechanics.EatDeferral.Choice
- UNKNOWN - Enum constant in enum privbot.mechanics.IncomingStyleDecision.Source
- UNKNOWN - Enum constant in enum privbot.mechanics.OpponentLockPolicy.Event
- UNKNOWN - Enum constant in enum privbot.mechanics.SpecialAttackPolicy.Phase
- UNKNOWN - Enum constant in enum privbot.mechanics.SpecWatch.Status
- UNKNOWN_SIZE_ASSUMED - Static variable in class privbot.mechanics.SafeTiles
-
The edge length an avoid-NPC of unknown size (0) is treated as.
- UNKNOWN_SPELL - Enum constant in enum privbot.hooks.Magic.CastOutcome
-
No spellbook entry of that name.
- unmatched(List<String>, List<String>) - Static method in class privbot.mechanics.GearNames
-
The entries of
wantedthathavecannot cover, inwanted's order. - UNREACHABLE - Enum constant in enum privbot.hooks.Magic.CastOutcome
-
PrivBot could not perform the click;
Magic.CastResult.gate()carries the reason. - unreadable() - Method in class privbot.mechanics.SwitchResult
- unreadable(String) - Static method in class privbot.api.Observed
-
A read that could not be made.
- unreadable(String) - Static method in class privbot.mechanics.SustainOutcome
-
Something needed could not be read.
- unreadable(String) - Static method in class privbot.mechanics.SwitchResult
- unreadable(String, String) - Static method in class privbot.mechanics.SustainOutcome
-
An item was clicked but the inventory could not be read to see whether it was consumed.
- UNREADABLE - Enum constant in enum privbot.api.Observed.State
-
The read could not be made; nothing may be concluded.
- UNREADABLE - Enum constant in enum privbot.hooks.bank.WithdrawCapacity.Outcome
-
The inventory could not be read; do not act on a guess.
- UNREADABLE - Enum constant in enum privbot.mechanics.DrinkProof.State
- UNREADABLE - Enum constant in enum privbot.mechanics.FoodProof.State
- UNREADABLE - Enum constant in enum privbot.mechanics.SustainChoice.Kind
- UNREADABLE - Enum constant in enum privbot.mechanics.SustainOutcome.Kind
- UNREADABLE - Enum constant in enum privbot.mechanics.SwitchCheck.State
- UNREADABLE - Enum constant in enum privbot.restock.GroundLoot.Outcome
- UNREADABLE - Static variable in class privbot.hooks.bank.BankWidgetOps
-
The slot's actions could not be read (no client, container not loaded, no child at that slot).
- UNREADABLE - Static variable in class privbot.hooks.User.Overhead
-
The read failed, or the profile cannot name the id that is drawn.
- unreadablePrayers() - Method in class privbot.mechanics.ThreatSnapshot
- UNSATISFIED - Enum constant in enum privbot.actions.confirm.ProofState
- unseen - Variable in class privbot.mechanics.PvpArbiter.Context
- unset(int, String) - Static method in class privbot.config.ConfigMigration
-
Drops
key(a setting that no longer exists); nothing when it is not saved. - unset(String) - Method in interface privbot.config.ConfigMigration.ConfigAccess
- unsettled() - Method in class privbot.mechanics.AttackHistory
- unsettled() - Method in class privbot.mechanics.OwnAttackClock
- unsupported(String) - Static method in class privbot.api.Outcome
- UNSUPPORTED - Enum constant in enum privbot.api.Outcome.Status
-
The unified API cannot do this on this server (
Capabilitiessays so). - UNSUPPORTED - Enum constant in enum privbot.api.Support
-
Known not to work on this server today.
- UNSUPPORTED - Enum constant in enum privbot.mechanics.JobState
- UNSUPPORTED_PROFILE - Enum constant in enum privbot.effects.EffectObservation.Source
- update(int, OpponentLock, List<OpponentLockPolicy.Candidate>, Boolean, Boolean, int, int, boolean, int) - Static method in class privbot.mechanics.OpponentLockPolicy
-
Apply the flagship's own-target, nearest-attacker, absence, idle and optional follow-attacker rules.
- upperBound() - Method in class privbot.mechanics.OpponentEnergy
-
Upper bound at the most recently observed tick, or null before the first observation.
- Usage: - Search tag in class privbot.hooks.Dialogue
- Section
- Usage: - Search tag in class privbot.hooks.Workflows
- Section
- Usage: - Search tag in class privbot.task.PrivTaskContext
- Section
- Usage: - Search tag in class privbot.task.ScriptExecutor
- Section
- Usage: - Search tag in class privbot.task.TaskNodeRunner
- Section
- Usage: - Search tag in class privbot.ui.CollapsibleSection
- Section
- Usage: - Search tag in class privbot.ui.PrivBotFrame
- Section
- Usage: - Search tag in class privbot.ui.PrivBotPanel
- Section
- Usage: - Search tag in interface privbot.ui.ProfileStateParticipant
- Section
- Usage Example: - Search tag in class privbot.task.SimpleNode
- Section
- Usage Example: - Search tag in interface privbot.task.TaskNode
- Section
- Usage Example (Priority): - Search tag in class privbot.task.CompositeTaskNode
- Section
- Usage Example (Sequence): - Search tag in class privbot.task.CompositeTaskNode
- Section
- Usage in a plugin studio - Search tag in class privbot.ui.fx.FxConfigPageBuilder
- Section
- Usage in hooks: - Search tag in class privbot.context.GameThread
- Section
- Usage in nodes: - Search tag in class privbot.context.Time
- Section
- use(String...) - Method in class privbot.hooks.Inventory
-
Uses the first inventory item matching any supplied name.
- useOn(String, String) - Method in class privbot.hooks.Inventory
-
Uses the first inventory item matching
sourceNameon the first item matchingtargetName(select then use-on-widget). - useOnObject(String, PrivObject) - Method in class privbot.hooks.Inventory
-
Uses the first inventory item matching
itemNameonobject: select the item ("Use"), then use it on the object, the same two clicks a player makes (Elorin: op 447, then op 62 on the object's scene tag). - user - Variable in class privbot.context.PrivContext
-
Local-player state: position, movement, animation, hitpoints, levels, overhead prayer.
- user - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.user. - User - Class in privbot.hooks
-
Local-player state queries via
Clientand the game client. - User.Overhead - Class in privbot.hooks
-
One read of the local overhead:
User.Overhead.isReadable()false means nothing can be said about the prayer the server shows — never treat it as "no overhead". - useRegistry(VarRegistry) - Method in class privbot.hooks.Vars
-
Replaces the name registry (a plugin's own captured names, or tests).
- usesClientProjection() - Method in class privbot.ui.overlay.SceneProjection
-
True when this client's own projection draws the tiles (Elorin), not the CPU camera math.
- useScrollOfRedirectedTeleport() - Method in class privbot.hooks.Teleporter
-
Uses a Scroll of Redirection (item 12403) from inventory with the "Use" action.
V
- VAL_MUTED - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for a muted read-only value.
- VAL_OK - Static variable in class privbot.ui.fx.PrivBotFxStyles
-
Style class for a positive read-only value.
- validation(String, int, String, long, Throwable) - Method in interface privbot.task.TaskTraceListener
-
One node was considered during selection.
- value - Variable in class privbot.ui.overlay.OverlayPalette
-
The resolved colours, all opaque: card
backgroundandborder,title, rowlabelandvalue,accent(LEVEL bars), and the status coloursinfo,good,warn,muted. - value - Variable in class privbot.ui.overlay.PrivBotChatboxOverlayLayout.MetricRow
-
The value; null becomes
"-". - value() - Element in annotation type privbot.api.Internal
-
Why the element is internal, or what a plugin should use instead.
- value(String) - Method in class privbot.mechanics.LootTally
- VALUE - Enum constant in enum privbot.api.Observed.State
-
The read succeeded and holds a value.
- VALUE - Enum constant in enum privbot.ui.overlay.PaletteSettings.Slot
- VALUE - Static variable in class privbot.ui.overlay.OverlayTheme
-
Row values (right column) when they carry no meaning of their own.
- valueAtLeast(long, ToLongFunction<String>) - Method in class privbot.mechanics.LootSpec.Builder
-
Also take any stack worth at least
threshold:quantity * priceOf(name). - valueColor - Variable in class privbot.ui.overlay.PrivBotChatboxOverlayLayout.MetricRow
-
The value colour.
- valueOf(String) - Static method in enum privbot.actions.confirm.ActionStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.actions.confirm.DispatchStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.actions.confirm.ProofState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.api.ApiVersion.Status
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.api.Capability
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.api.Observed.State
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.api.Outcome.Status
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.api.ServerId
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.api.Support
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.context.GameThreadPolicy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.context.GameThreadRouting.Route
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.effects.EffectObservation.Source
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.effects.EffectObservation.State
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.hooks.bank.WithdrawCapacity.Outcome
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.hooks.bank.WithdrawPlan.Skip
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.hooks.GameObjects.ToaRewardsRoomChest.Kind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.hooks.Magic.AutocastClick
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.hooks.Magic.CastOutcome
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.hooks.Magic.SpellbookTab
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.hooks.Prayer.Book
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.hooks.shop.BuyPlan.Skip
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.hooks.VarRegistry.Kind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.hooks.Widgets.MatchMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.hooks.Widgets.WidgetEffect
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.AttackFireDetector.Status
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.AttackHistory.Family
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.CombatStyle
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.Commitment.Episode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.ConsumeTiming.Kind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.ConsumeTiming.Mode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.DeathWatch.State
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.DrinkProof.State
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.EatDeferral.Choice
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.FoodProof.State
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.FreezeClock.Move
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.GearSetup.Kind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.GearSetup.Role
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.GraniteMaulDecision.Kind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.IncomingStyleDecision.Source
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.JobState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.KnockoutWeaponDecision.Kind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.OpponentLockPolicy.Event
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.PvpArbiter.Kind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.PvpMovement.Kind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.RiskValuation.Disposition
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.SpecEnergy.Fired
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.SpecialAttackPolicy.Phase
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.SpecWatch.Status
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.SustainChoice.Kind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.SustainOutcome.Kind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.SwitchCheck.State
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.mechanics.WildernessModel.Rounding
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.movement.pathing.NavigationSession.Result
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.query.ItemContainerKind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.restock.GroundLoot.Outcome
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.restock.RestockCycle.Stage
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.task.AutomationStage
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.task.CompositeTaskNode.Strategy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.ui.overlay.PaletteSettings.Scheme
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.ui.overlay.PaletteSettings.Slot
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum privbot.ui.PanelStatus
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum privbot.actions.confirm.ActionStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.actions.confirm.DispatchStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.actions.confirm.ProofState
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.api.ApiVersion.Status
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.api.Capability
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.api.Observed.State
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.api.Outcome.Status
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.api.ServerId
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.api.Support
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.context.GameThreadPolicy
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.context.GameThreadRouting.Route
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.effects.EffectObservation.Source
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.effects.EffectObservation.State
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.hooks.bank.WithdrawCapacity.Outcome
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.hooks.bank.WithdrawPlan.Skip
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.hooks.GameObjects.ToaRewardsRoomChest.Kind
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.hooks.Magic.AutocastClick
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.hooks.Magic.CastOutcome
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.hooks.Magic.SpellbookTab
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.hooks.Prayer.Book
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.hooks.shop.BuyPlan.Skip
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.hooks.VarRegistry.Kind
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.hooks.Widgets.MatchMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.hooks.Widgets.WidgetEffect
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.AttackFireDetector.Status
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.AttackHistory.Family
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.CombatStyle
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.Commitment.Episode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.ConsumeTiming.Kind
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.ConsumeTiming.Mode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.DeathWatch.State
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.DrinkProof.State
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.EatDeferral.Choice
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.FoodProof.State
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.FreezeClock.Move
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.GearSetup.Kind
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.GearSetup.Role
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.GraniteMaulDecision.Kind
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.IncomingStyleDecision.Source
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.JobState
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.KnockoutWeaponDecision.Kind
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.OpponentLockPolicy.Event
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.PvpArbiter.Kind
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.PvpMovement.Kind
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.RiskValuation.Disposition
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.SpecEnergy.Fired
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.SpecialAttackPolicy.Phase
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.SpecWatch.Status
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.SustainChoice.Kind
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.SustainOutcome.Kind
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.SwitchCheck.State
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.mechanics.WildernessModel.Rounding
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.movement.pathing.NavigationSession.Result
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.query.ItemContainerKind
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.restock.GroundLoot.Outcome
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.restock.RestockCycle.Stage
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.task.AutomationStage
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.task.CompositeTaskNode.Strategy
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.ui.overlay.PaletteSettings.Scheme
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.ui.overlay.PaletteSettings.Slot
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum privbot.ui.PanelStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- valueText(Object) - Static method in class privbot.ui.overlay.Rows
-
How a value renders: null and empty become a dash.
- varbit(int) - Method in interface privbot.api.Ids
-
This server's varbit id for OSRS varbit
osrsId. - varbit(int, Observed<Integer>) - Method in class privbot.hooks.Events.Frame.Builder
- VARBIT - Enum constant in enum privbot.hooks.VarRegistry.Kind
-
A bit range of a varp, defined by the client's varbit table.
- VARBIT_READ - Enum constant in enum privbot.api.Capability
- varbits - Variable in class privbot.hooks.Events.Needs
-
Varbit ids to read.
- VarChange(VarRegistry.Kind, int, int, int, int) - Constructor for class privbot.hooks.Events.VarChange
- varp(int, Observed<Integer>) - Method in class privbot.hooks.Events.Frame.Builder
- VARP - Enum constant in enum privbot.hooks.VarRegistry.Kind
-
A player variable (the whole int).
- VARP_READ - Enum constant in enum privbot.api.Capability
- varps - Variable in class privbot.hooks.Events.Needs
-
Varp ids to read.
- VarRegistry - Class in privbot.hooks
-
The evidence-backed names
ctx.vars.byName(...)knows on one server. - VarRegistry.Entry - Class in privbot.hooks
-
One named variable.
- VarRegistry.Kind - Enum in privbot.hooks
-
Whether a name resolves to a whole varp or a varbit.
- vars - Variable in class privbot.context.PrivContext
-
Raw varbit and varp reads.
- vars - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.vars. - Vars - Class in privbot.hooks
-
Player variables:
ctx.vars. - Vars(Client) - Constructor for class privbot.hooks.Vars
- vengeance - Variable in class privbot.mechanics.ConsumePlanner.Settings
- VENGEANCE - Enum constant in enum privbot.mechanics.PvpArbiter.Kind
- VENGEANCE_ANIMATION - Static variable in class privbot.mechanics.SpellEffects
-
Lunar self-cast animation, OSRS id.
- VENGEANCE_COOLDOWN_TICKS - Static variable in class privbot.mechanics.SpellEffects
-
Ticks before Vengeance can be cast again (30 s).
- VENGEANCE_GRAPHIC - Static variable in class privbot.mechanics.SpellEffects
-
Vengeance cast graphic.
- vengeanceReady(int) - Method in class privbot.mechanics.SpellEffects
-
Whether Vengeance can be cast at
tick: never seen cast, orSpellEffects.VENGEANCE_COOLDOWN_TICKShave passed. - vengeanceReadyAt() - Method in class privbot.mechanics.SpellEffects
-
The first tick Vengeance can be cast again, or
SpellEffects.NEVERwhen it has not been seen cast. - vengeanceUp(int) - Method in class privbot.mechanics.SpellEffects
-
Whether our Vengeance is up: cast seen, and not yet used by a damaging hit reported through
SpellEffects.observeLocalDamage(int, java.lang.Integer)on a later tick. - verificationSetup() - Method in class privbot.mechanics.SwitchResult
-
The setup to verify: accepted name-matched clicks use the selected item's actual id in its intended slot.
- version() - Method in interface privbot.config.ConfigMigration.Step
- version() - Static method in class privbot.sdk.PrivBotAPI
-
Build version of the privbot-sdk code module, or
developmentin an IDE build. - VERSION - Static variable in class privbot.sdk.PrivBotAPI
-
Deprecated.use
PrivBotAPI.version()so packaged and IDE builds share one version source. - VERSION_KEY - Static variable in class privbot.config.ConfigMigration
-
The key, inside the plugin's config group, that records the last migration version applied.
- Versions - Search tag in class privbot.sdk.PrivBotAPI
- Section
- viaTeleport(String) - Method in class privbot.mechanics.Destination
- visible() - Method in class privbot.query.WidgetQuery
-
Keeps widgets that are not hidden (
Widget.isHidden()). - visibleWhen(BooleanSupplier) - Method in class privbot.ui.overlay.PrivBotOverlayPanel
-
Hide the panel while
conditionis false (typicallyplugin::isEnabled). - visibleWhen(BooleanSupplier) - Method in class privbot.ui.overlay.PrivBotOverlays.PanelBuilder
-
Draw only while
conditionis true. - visibleWhen(BooleanSupplier) - Method in class privbot.ui.overlay.PrivBotOverlays.SceneBuilder
-
Draw only while
conditionis true; same render-thread rule asPrivBotOverlays.PanelBuilder.visibleWhen(java.util.function.BooleanSupplier). - visibleWhen(BooleanSupplier) - Method in class privbot.ui.overlay.PrivBotSceneOverlay
-
Draw only while
conditionis true (null = always).
W
- WALK - Enum constant in enum privbot.api.Capability
-
Walking to a tile that is on screen.
- WALK_OFFSCREEN - Enum constant in enum privbot.api.Capability
-
Walking to a tile that is not on screen in one call.
- walkChecked(WorldPoint, BooleanSupplier) - Method in interface privbot.movement.pathing.ExactStepHandle.Driver
-
Recheck active on the dispatch thread, immediately before sending the walk.
- walksBypassCap - Variable in class privbot.mechanics.PvpArbiter.Context
- walkTo(WorldPoint) - Method in class privbot.hooks.Travel
-
Blocking: walk/path to a raw world point (arrive radius 2).
- wanted() - Method in class privbot.mechanics.StylePlanner.GearPick
- wanted(String, List<String>) - Static method in class privbot.restock.LootNames
-
Whether an item name contains any fragment.
- wanted(PrivTaskContext, List<String>, RestockHost) - Method in class privbot.restock.GroundLoot
-
The wanted ground items in reach that were not skipped, nearest first.
- wants(String, int, int) - Method in class privbot.mechanics.LootSpec
- warm() - Static method in class privbot.ui.overlay.OverlayIcons
-
Decodes every indexed icon.
- warn - Variable in class privbot.ui.overlay.OverlayPalette
-
The resolved colours, all opaque: card
backgroundandborder,title, rowlabelandvalue,accent(LEVEL bars), and the status coloursinfo,good,warn,muted. - WARN - Enum constant in enum privbot.ui.overlay.PaletteSettings.Slot
- WARN - Static variable in class privbot.ui.overlay.OverlayTheme
-
Needs attention soon (amber).
- WARNING - Enum constant in enum privbot.ui.PanelStatus
-
Running with a condition the user should see, e.g.
- WARNING - Static variable in class privbot.ui.GearTheme
-
Warnings (amber).
- watch() - Method in class privbot.hooks.Recovery
-
A new death watch for one plugin; feed it
ctx.playerhitpoints, animation and tile once per tick. - WEAPON - Enum constant in enum privbot.mechanics.AttackHistory.Family
- weaponId() - Method in class privbot.mechanics.PlayerView
- weaponName() - Method in class privbot.mechanics.PlayerView
- weaponReady() - Method in class privbot.mechanics.KnockoutWeaponPlan.Plan
-
True only when a KEEP decision agrees with an observed worn KO weapon in this frame.
- weapons() - Method in class privbot.mechanics.ThreatMemory.View
- weaponSlot() - Method in class privbot.mechanics.PvpArbiter.Action
- WeaponSpeeds - Class in privbot.mechanics
-
How many ticks a weapon takes between attacks.
- WeaponStyles - Class in privbot.mechanics
-
Weapon name to combat style, for Elorin's RS2-era item names.
- where(Predicate<GraphicsObject>) - Method in class privbot.query.GraphicsObjectQuery
-
Alias of
GraphicsObjectQuery.filter(Predicate). - where(Predicate<Player>) - Method in interface privbot.query.PlayerSearch
-
Alias of
PlayerSearch.filter(Predicate). - where(Predicate<Widget>) - Method in class privbot.query.WidgetQuery
-
Alias of
WidgetQuery.filter(Predicate). - where(Predicate<PrivGroundItem>) - Method in class privbot.query.GroundItemQuery
-
Alias of
GroundItemQuery.filter(Predicate). - where(Predicate<PrivItem>) - Method in class privbot.query.ItemQuery
-
Alias of
ItemQuery.filter(Predicate). - where(Predicate<PrivNPC>) - Method in class privbot.query.NPCQuery
-
Alias of
NPCQuery.filter(Predicate). - where(Predicate<PrivObject>) - Method in class privbot.query.ObjectQuery
-
Alias of
ObjectQuery.filter(Predicate). - WIDGET_GONE - Enum constant in enum privbot.hooks.Widgets.WidgetEffect
-
Dispatched, and the clicked widget is no longer visible.
- WIDGET_INTERACT - Enum constant in enum privbot.api.Capability
- WIDGET_READ - Enum constant in enum privbot.api.Capability
-
Whether a widget is drawn, its text and children.
- widgetInspectorPath() - Method in class privbot.hooks.TransportRequest.WidgetPathStep
-
Non-null only when
TransportRequest.WidgetPathStep.isWidgetInspectorPath()is true. - widgetInspectorPath(String) - Static method in class privbot.hooks.TransportRequest.WidgetPathStep
-
Inspector path such as
820.49[44]whenTransportRequest.WidgetPathStep.packed(int)is ambiguous (duplicate packed ids). - WidgetQuery - Class in privbot.query
- WidgetQuery(List<Widget>, Client) - Constructor for class privbot.query.WidgetQuery
-
Wraps a copy of
raw. - widgets - Variable in class privbot.context.PrivContext
-
Widget queries and widget clicks (
ctx.widgets.query()). - widgets - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.widgets. - Widgets - Class in privbot.hooks
-
Interface widgets:
ctx.widgets(find by id or visible text, read text, click options). - Widgets.MatchMode - Enum in privbot.hooks
-
How visible text is matched.
- Widgets.WidgetEffect - Enum in privbot.hooks
-
What a confirmed widget click observed.
- widgetSteps() - Method in class privbot.hooks.TransportRequest
- widgetTimeoutMs() - Method in class privbot.hooks.TransportRequest
- width() - Method in class privbot.ui.overlay.PrivBotOverlayPanel
-
The panel width in pixels.
- width(int) - Method in class privbot.ui.overlay.PrivBotOverlayPanel
-
Sets the panel width in pixels (at least 80).
- width(int) - Method in class privbot.ui.overlay.PrivBotOverlays.PanelBuilder
-
Panel width in pixels (at least 80); default
OverlayTheme.PANEL_WIDTH. - width(Graphics2D, String, Font) - Static method in class privbot.ui.overlay.FallbackText
-
The advance width of
sasFallbackText.draw(java.awt.Graphics2D, java.lang.String, float, float, java.awt.Font)lays it out. - wield(String...) - Method in class privbot.hooks.Inventory
-
Wields or wears the first inventory item matching any supplied name.
- wildernessLevel(WildernessModel) - Method in class privbot.hooks.Pvp
-
Read the local server tile and apply caller-verified wilderness rules.
- WildernessModel - Class in privbot.mechanics
-
Explicit, caller-verified wilderness coordinate rules.
- WildernessModel(List<WildernessModel.Zone>) - Constructor for class privbot.mechanics.WildernessModel
- WildernessModel.Rounding - Enum in privbot.mechanics
- WildernessModel.Zone - Class in privbot.mechanics
- windowTitle(String) - Method in class privbot.ui.fx.FxStudioShell.Builder
-
The OS window title; must not be null.
- withAction(String...) - Method in class privbot.hooks.GameObjects
-
Start a query filtered to objects with at least one of the given actions.
- withAction(String...) - Method in class privbot.hooks.NPCs
-
Start a query filtered to NPCs with at least one of the given actions.
- withAction(String...) - Method in class privbot.query.ItemQuery
-
Keeps items whose definition exposes at least one of the given actions (e.g.
- withAction(String...) - Method in class privbot.query.NPCQuery
-
Keeps NPCs whose composition has at least one of the given actions (case-insensitive substring).
- withAction(String...) - Method in class privbot.query.ObjectQuery
-
Keeps objects whose definition has at least one of the given actions (case-insensitive substring).
- withAction(String...) - Method in class privbot.query.WidgetQuery
-
Keeps widgets whose
Widget.getActions()list matches any of the given options (normalized text, same rules as component menu interaction: exact normalized match or substring contains). - withAlpha(Color, int) - Static method in class privbot.ui.GearTheme
-
cwith its alpha replaced byalpha, clamped to 0..255. - withAlpha(Color, int) - Static method in class privbot.ui.ModernTheme
-
colorwith alphaalpha; must be 0..255 (not clamped, unlikeGearTheme.withAlpha(java.awt.Color, int)). - withdraw(int, int) - Method in class privbot.hooks.Bank
-
Withdraw
qtyof the first bank slot matchingitemId. - withdraw(String, int) - Method in class privbot.hooks.Bank
- WITHDRAW - Enum constant in enum privbot.hooks.bank.WithdrawCapacity.Outcome
-
WithdrawCapacity.amount()units can be withdrawn now. - WITHDRAW_ALL_IDENTIFIER - Static variable in class privbot.hooks.bank.BankSession
-
The Withdraw-All identifier (CC_OP_LOW_PRIORITY) on Orion, Roat Pkz and SpawnPK.
- WITHDRAW_REFUSED - Enum constant in enum privbot.hooks.bank.WithdrawPlan.Skip
-
Clicks dispatched but the carried count never moved.
- withdraw1(int) - Method in class privbot.hooks.Bank
-
Withdraw exactly 1 of the first bank slot matching the given item id.
- withdraw10(int) - Method in class privbot.hooks.Bank
-
Withdraw 10 of the first bank slot matching the given item id.
- withdraw5(int) - Method in class privbot.hooks.Bank
-
Withdraw 5 of the first bank slot matching the given item id.
- withdrawAll(int) - Method in class privbot.hooks.Bank
-
Withdraw all of the first bank slot matching the given item id.
- withdrawAll(String) - Method in class privbot.hooks.Bank
-
Withdraw all of the first bank slot matching the given display name.
- withdrawAllOutcome(String) - Method in class privbot.hooks.Bank
-
Bank.withdrawAll(String)with an explicit outcome. - WithdrawCapacity - Class in privbot.hooks.bank
-
How many units of one item may be withdrawn right now, given the inventory's free space.
- WithdrawCapacity.Outcome - Enum in privbot.hooks.bank
- WithdrawOption - Class in privbot.hooks.bank
-
One withdraw quantity PrivBot can actually send on this server, e.g.
- withdrawOutcome(int, int) - Method in class privbot.hooks.Bank
-
Bank.withdraw(int, int)with an explicit outcome. - withdrawOutcome(String, int) - Method in class privbot.hooks.Bank
-
Bank.withdraw(String, int)with an explicit outcome. - WithdrawPlan - Class in privbot.hooks.bank
-
Tracks progress through a list of
(item, quantity)withdraw lines. - WithdrawPlan(List<WithdrawPlan.Line>) - Constructor for class privbot.hooks.bank.WithdrawPlan
- WithdrawPlan.Line - Class in privbot.hooks.bank
-
One
(item, quantity)pair — the shared shape, so one parser serves buy and withdraw. - WithdrawPlan.Skip - Enum in privbot.hooks.bank
-
Why a line was retired without reaching its target.
- withExactText(String...) - Method in class privbot.query.WidgetQuery
-
Keeps widgets whose normalized
Widget.getText()orWidget.getName()exactly matches any requested value (case-insensitive, colour tags stripped). - withHome(String, int, int, int) - Method in class privbot.restock.RestockRoute
-
The same route with another home landing (a server whose home differs).
- withId(int...) - Method in class privbot.hooks.GameObjects
-
Start a query filtered to objects matching the given ID(s).
- withId(int...) - Method in class privbot.hooks.NPCs
-
Start a query filtered to NPCs matching the given ID(s).
- withId(int...) - Method in class privbot.query.GraphicsObjectQuery
-
Keeps graphics whose spot-animation id is one of
ids; no ids leaves the query unchanged. - withId(int...) - Method in class privbot.query.GroundItemQuery
-
Keeps stacks whose item id is one of
ids; no ids leaves the query unchanged. - withId(int...) - Method in class privbot.query.ItemQuery
-
Keeps items whose id is one of
ids; no ids leaves the query unchanged. - withId(int...) - Method in class privbot.query.NPCQuery
-
Keeps NPCs whose composition id is one of
ids; no ids leaves the query unchanged. - withId(int...) - Method in class privbot.query.ObjectQuery
-
Keeps objects whose scene id is one of
ids; no ids leaves the query unchanged. - within(int) - Method in class privbot.mechanics.PvpQuery
- within(int) - Method in class privbot.mechanics.ThreatQuery
- within(WorldArea) - Method in class privbot.mechanics.TargetSpec
-
Only matches NPCs whose tile is inside
area. - withinTiles(int) - Method in class privbot.query.GraphicsObjectQuery
-
Keeps graphics within
maxTilestile steps (Chebyshev) of the local player, on the player's plane. - withinTiles(int) - Method in class privbot.query.GroundItemQuery
-
Chebyshev distance on the current plane (OSRS tile steps).
- withinTiles(int) - Method in class privbot.query.NPCQuery
-
Chebyshev distance on the current plane (OSRS tile steps).
- withinTiles(int) - Method in class privbot.query.ObjectQuery
-
Chebyshev distance on the current plane (OSRS tile steps).
- withinTiles(int) - Method in interface privbot.query.PlayerSearch
- withItemOrName() - Method in class privbot.query.WidgetQuery
-
Inventory-style slot:
WidgetQuery.withNonEmptyName()logic or positiveWidget.getItemId()when the client omits the label but sets an item. - withMaximumRetries(int) - Method in class privbot.movement.pathing.NavigationSession.Policy
- withName(String...) - Method in class privbot.hooks.GameObjects
-
Start a query filtered to objects matching the given name(s).
- withName(String...) - Method in class privbot.hooks.NPCs
-
Start a query filtered to NPCs matching the given name(s).
- withName(String...) - Method in class privbot.query.GroundItemQuery
-
Keeps stacks whose item name contains any of
names(case-insensitive substring). - withName(String...) - Method in class privbot.query.ItemQuery
-
Keeps items whose name contains any of
names(case-insensitive substring), so"Shark"also matches"Raw shark". - withName(String...) - Method in class privbot.query.NPCQuery
-
Keeps NPCs whose name contains any of
names(case-insensitive substring, tags stripped). - withName(String...) - Method in class privbot.query.ObjectQuery
-
Name substring match (see
PrivObject.getName()). - withName(String...) - Method in interface privbot.query.PlayerSearch
- withNonEmptyName() - Method in class privbot.query.WidgetQuery
-
Non-blank
Widget.getName()or meaningful text after stripping colour tags (the same normalisation the dialogue hook uses). - withReturn(int, String) - Method in class privbot.restock.RestockRoute
-
The same route with another way back (teleport widget and action).
- withSlot(int) - Method in class privbot.query.ItemQuery
-
Keeps the row in container slot
slot(0-based). - withText(String...) - Method in class privbot.query.WidgetQuery
-
Keeps widgets whose
Widget.getText()orWidget.getName()contains any of the given substrings (case-insensitive, colour tags stripped). - withWidget(Widget) - Method in class privbot.query.WidgetQuery
-
Adds
wto the working set; null is ignored. - workflow - Variable in class privbot.context.PrivContext
-
Runs saved Builder workflows from a plugin (
ctx.workflow.run(...)). - workflow - Variable in class privbot.task.PrivTaskContext
-
Same object as
PrivContext.workflow. - Workflows - Class in privbot.hooks
-
Workflow execution hook — the simplest way to run workflows from plugin code.
- WorldFreeze - Class in privbot.mechanics
-
Notices a world that has stopped changing while the tick counter keeps running: the signature of a death or a disconnect the client never reported (a real fight always moves something).
- WorldFreeze(int) - Constructor for class privbot.mechanics.WorldFreeze
- worn() - Method in class privbot.mechanics.GraniteMaulDecision.Decision
- worn() - Method in class privbot.mechanics.RestockTarget
- worn(GearSetup) - Method in class privbot.mechanics.RestockTarget.Builder
- worn(GearSetup, ItemContainerSnapshot) - Static method in class privbot.mechanics.SetupDiff
-
Compares worn equipment with a worn setup.
- WORN - Enum constant in enum privbot.mechanics.GearSetup.Kind
- wornItemIds() - Method in class privbot.mechanics.PlayerView
- worstDrop(int, List<String>, List<String>) - Method in class privbot.mechanics.HealthHistory
-
Largest drop into a sample in [tick-11,tick].
- worstHit - Variable in class privbot.mechanics.ConsumePlanner.State
- wrap(String, String, Node) - Static method in class privbot.ui.fx.FxPageChrome
-
FxPageChrome.wrap(String, String, Node, boolean)with an outer scroll pane. - wrap(String, String, Node, boolean) - Static method in class privbot.ui.fx.FxPageChrome
- wrap(String, String, JComponent) - Static method in class privbot.ui.fx.FxSwingSection
-
FxSwingSection.wrap(String, String, JComponent, boolean)with an outer scroll pane. - wrap(String, String, JComponent, boolean) - Static method in class privbot.ui.fx.FxSwingSection
- wrap(Player) - Method in class privbot.hooks.PlayersHook
- wrapSectionBlock(JComponent) - Static method in class privbot.ui.ModernTheme
-
Wraps a component in a panel with bottom spacing, for use in vertical layouts.
- wrapSectionBlock(JComponent) - Static method in class privbot.ui.SwingFormKit
- wrapToWidth(Graphics2D, String, int, int) - Static method in class privbot.ui.overlay.PrivBotChatboxOverlayComponents
-
Word-wraps
texttomaxWidthin the value font, at mostmaxLineslines; empty gives["-"].
X
- xp(String) - Method in class privbot.hooks.Skills
-
Skills.xp(Skill)by in-game name. - xp(Skill) - Method in class privbot.hooks.Skills
-
Experience in
skill. - XP_READ - Enum constant in enum privbot.api.Capability
Z
- zoomedIcon(BufferedImage, int) - Static method in class privbot.ui.PluginIconUtil
-
Center-crop the image to the given size so the graphic fills the frame (zoom in).
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
Bank.close()