All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary
| Class |
Description |
| Actionable |
Represents an entity whose definition contains "actions" that can be performed on the entity.
|
| ActionableQuery<EntityType extends Actionable,QueryType extends Query<EntityType,QueryType>> |
A query to search over entities with actions
|
| Antiban |
|
| AntibanProperties |
Generates and stores values based on the currently logged in Runescape account, which are used in the API as modifiers
to ensure every account has slightly different behavior
|
| AntibanProperties.Props |
|
| Area |
Represents a contiguous set of tiles in the game
|
| AutomationClient |
Utilities for interacting with and extending the functionality of the TRiBot automation client
|
| AutomationClient.AutomationException |
|
| Bank |
Utilities for interacting with the Runescape bank.
|
| BankCache |
Provides a cache that keeps track of all the items in the bank.
|
| BankEquipment |
Contains methods related to the equipment screen available when at a bank
|
| BankPinScreen |
Utilities for interacting with the Bank Pin screen.
|
| BankQuery |
A query to search over entities of type Item inside of your bank. |
| BankSettings |
Utilities for interacting with the bank settings
|
| BankSettings.WithdrawQuantity |
|
| BasicPaintTemplate |
|
| BasicPaintTemplate.BasicPaintTemplateBuilder |
|
| BreakStartListener |
Represents a listener for tribot break starts
|
| BugReports |
Contains utilities related to generating a bug report in the client
|
| BugReports.WebhookConfig |
|
| BugReports.WebhookConfig.WebhookConfigBuilder |
|
| Camera |
Utilities for controlling the camera in game.
|
| Camera.RotationMethod |
A rotation method for moving the camera
|
| Camera.ZoomMethod |
|
| Character |
Represents a player or npc entity
|
| Character.WalkingDirection |
|
| CharacterQuery<EntityType extends Character,QueryType extends Query<EntityType,QueryType>> |
A query to search over character entities
|
| Chatbox |
Contains methods for inspecting and interacting with the chatbox screen (the box that contains chat messages from players for example)
|
| Chatbox.Tab |
|
| ChatScreen |
Contains methods for inspecting and interacting with the dialog screen that appears over the chatbox, such as when talking to an NPC
|
| ChatScreen.Config |
The config for the chat handler.
|
| ChatScreen.Config.ConfigBuilder |
|
| ChooseOption |
Utilities for using the "ChooseOption" interface, which is the box of options that appears when right-clicking things
in the game.
|
| ClanMessageListener |
Represents a listener for clan chat (or friends chat) messages
|
| Clickable |
Represents something that can be clicked, such as an in-game entity (object, npc, player) or interface entity (item,
interface).
|
| ClickableQuery<EntityType extends Clickable,QueryType extends Query<EntityType,QueryType>> |
A query to search over clickable entities
|
| Combat |
Contains utility methods for interacting with the combat tab and obtaining other combat related information
|
| Combat.AttackStyle |
An attack style that is selectable on the combat tab
|
| Combat.AutocastableSpell |
A spell that can be autocast
|
| Combat.WeaponType |
|
| DaxWalkerAdapter |
A walking adapter for using dax walker.
|
| DaxWalkerAdapter.Teleport |
|
| DuelRequestListener |
Represents a listener for duel requests
|
| EnterInputScreen |
Contains methods for inspecting and interacting with the commonly used 'enter input' screen that appears over the chatbox
|
| Equipment |
Utilities for interacting with the equipment tab
|
| Equipment.Slot |
Represents an equipment slot in the equipment tab
|
| EquipmentItem |
Represents an equipped item
|
| EquipmentQuery |
A query to search over entities of type EquipmentItem which are equipped on your character |
| EventOverride |
|
| GameListening |
Contains listeners for game events.
|
| GameObject |
Represents a game object
|
| GameObjectQuery |
A query to search over entities of type GameObject |
| GameState |
Utilities for inspecting the client game state
|
| GameState.State |
A current state of the game, such as loading, at login screen, or logged in.
|
| GameTab |
A game tab available in the side-panel widgets
|
| GameTab.SwitchPreference |
Default - Tab switching will be either done by keys or mouse, depending on antiban props.
|
| GlobalWalkerAdapter |
Provides a definition for a webwalker that can be set as the engine of the GlobalWalker API
|
| GlobalWalking |
Utilities for walking across the entire game
|
| GrandExchange |
Contains utility methods for inspecting and interacting with the grand exchange
|
| GrandExchange.CollectMethod |
|
| GrandExchange.CreateOfferConfig |
Describes a configuration for a new grand exchange offer.
Each of the following config requirements must be met:
A type must be specified.
A price adjustment or a price must be specified.
A quantity must be specified.
An item name or an item id must be specified.
Custom search text (only used for buying) is completely optional.
|
| GrandExchange.CreateOfferConfig.CreateOfferConfigBuilder |
|
| GrandExchangeOffer |
A grand exchange offer active in the grand exchange
|
| GrandExchangeOffer.Slot |
The grand exchange offer slots, starting from the top left to the top right, then the bottom left to the bottom right
|
| GrandExchangeOffer.Status |
|
| GrandExchangeOffer.Type |
|
| GrandExchangeOfferQuery |
|
| GraphicObject |
Represents a special type of graphical object.
|
| GraphicObjectQuery |
|
| GroundItem |
Represents an item on the ground
|
| GroundItemQuery |
A query to search over entities of type GroundItem |
| Hiscores |
Utility for grabbing data from the game highscores
|
| Hiscores.Activity |
|
| Hiscores.ActivityRanking |
|
| Hiscores.CategoryRanking |
|
| Hiscores.Player |
|
| Hiscores.Skill |
|
| Hiscores.SkillRanking |
|
| Hitsplat |
|
| Hitsplat.Type |
An enumeration of hitsplat types.
|
| Identifiable |
Represents anything with an in-game ID
|
| IdentifiableQuery<EntityType extends Identifiable,QueryType extends Query<EntityType,QueryType>> |
|
| Indexable |
Represents an entity that has an index.
|
| IndexableQuery<EntityType extends Indexable,QueryType extends Query<EntityType,QueryType>> |
|
| Interactable |
Represents an "interactable" entity.
|
| InteractableQuery<EntityType extends Interactable,QueryType extends Query<EntityType,QueryType>> |
|
| Interaction |
Utilities for easily interacting with game entities
|
| Inventory |
Utilities for interacting with and inspecting the inventory
|
| Inventory.DropPattern |
A pattern, or order, to drop items in
|
| InventoryItem |
Represents an item in your inventory
|
| InventoryQuery |
A query to search over entities of type InventoryItem located in your inventory |
| Item |
Represents an item, such as an inventory item.
|
| ItemDefinable |
An entity that has an item definition
|
| ItemDefinableQuery<EntityType extends ItemDefinable,QueryType extends Query<EntityType,QueryType>> |
|
| ItemDefinition |
|
| ItemDefinitionQuery |
A query to search over item definitions
|
| ItemQuery<EntityType extends Item,QueryType extends Query<EntityType,QueryType>> |
|
| Keyboard |
Utilities related to using the keyboard/typing in-game
|
| Keyboard.HoldAction |
Represents a key hold configuration
|
| Keyboard.HoldAction.Key |
Represents a key that can be held.
|
| Keyboard.HoldAction.KeyHoldContext |
Represents the context of a current key hold action.
|
| KeyEventOverrideListener |
An interface to override key events from the user
|
| LocalTile |
Represents a tile in the current scene
|
| LocalTile.Collision |
|
| LocalTile.Direction |
|
| LocalTile.SceneSetting |
|
| LocalWalking |
Utilities for traversing and inspecting the 'local' area.
|
| LocalWalking.Map |
Represents a mapped area from some source position.
|
| LocalWalking.Map.MapBuilder |
|
| Log |
Contains methods for logging
|
| Login |
Utilities for logging in and inspecting current login state
|
| Login.LoginMessage |
Represents a mesage that can be displayed when trying to log in, such as already logged in
|
| Magic |
Utilities for interacting with the Magic Tab.
|
| Magic.SpellBook |
A magic spellbook
|
| MakeScreen |
Contains methods regarding the commonly used 'make' interface.
|
| MakeScreen.Quantity |
|
| MakeScreen.SelectPreference |
|
| MessageListening |
Contains methods to register listeners to listen to specific message types.
|
| Minigame |
A minigame listed in the list of minigames under the minigame tab
|
| Model |
Represents an entity model viewable on the game screen, such as a player or game object
|
| Modellable |
An entity with a model
|
| Mouse |
Utilities related to the virtual mouse.
|
| Mouse.ClickMethod |
Represents an entity clicking method
|
| MouseClickListener |
Represents a listener for mouse clicking
|
| MouseDragListener |
Represents a listener for mouse dragging
|
| MouseEventOverrideListener |
An interface to override mouse events from the user
|
| MouseMoveListener |
Represents a listener for mouse movement
|
| MousePaint |
An interface for displaying the mouse position
|
| MouseReleaseListener |
Represents a listener for when the mouse is released
|
| MouseSplinePaint |
An interface for painting the "mouse spline" (the traversed mouse path)
|
| MyPlayer |
Static convenience methods for the local player.
|
| MyPlayer.AccountType |
An account type
|
| MyPlayer.TeleblockState |
The various states of teleblock
0 = not currently active
0 - 100 = not active, but immune
100 - 600 = currently active
|
| Named |
Represents something with an in-game name
|
| NamedQuery<EntityType extends Named,QueryType extends Query<EntityType,QueryType>> |
|
| Notifications |
|
| Npc |
Represents a non-player-character
|
| NpcDefinition |
|
| NpcQuery |
A query to search over entities of type Npc |
| ObjectDefinition |
|
| Options |
Utilities for getting information related to what's in the Options Tab and Minimap HUD.
|
| Options.AttackOption |
|
| Options.ChatboxScrollPosition |
|
| Options.HouseDoor |
|
| Options.ResizableType |
|
| Options.Tab |
|
| Orientable |
Represents an entity with an orientation
|
| Orientable.Orientation |
Represents the orientation of an entity
|
| Orientable.Orientation.Direction |
Represents a cardinal direction (and the four inter-cardinal directions)
|
| OrientableQuery<EntityType extends Orientable,QueryType extends Query<EntityType,QueryType>> |
|
| PaintComponent |
|
| Painting |
Utilities for painting over the game screen
|
| PaintLocation |
|
| PaintRow |
Describes a paint row that can exist in a paint frame.
|
| PaintRows |
|
| PaintTextRow |
|
| PaintTextRow.PaintTextRowBuilder |
|
| Player |
Represents a player (such as yourself, or another player)
|
| Player.OverheadIcon |
|
| Player.SkullIcon |
|
| PlayerMessageListener |
Represents a listener for public player messages in the chatbox
|
| PlayerPreferences |
Utility class for generating player specific preferences.
|
| PlayerPreferences.Generator |
Class to assist with generating unique player-specific preferences
|
| PlayerQuery |
A query to search over entities of type Player |
| Positionable |
Represents an entity with a location on the game map
|
| PositionableQuery<EntityType extends Positionable,QueryType extends Query<EntityType,QueryType>> |
|
| Prayer |
A prayer listed under the prayer tab
|
| PreBreakStartListener |
Represents a listener for tribot break starts
|
| PreferredTargetSelector<T extends Interactable> |
Provides a way to sort game entities in order of "preference" when it comes to interacting with them.
|
| PrivateMessageListener |
Represents a listener for private messages from other players
|
| Projectile |
Represents a projectile in the air, such as an arrow or a spell
|
| ProjectileQuery |
A query to search over entities of type Projectile |
| Query<EntityType,QueryType extends Query<EntityType,QueryType>> |
An interface for querying entities.
|
| Quest |
A list of all quests
|
| Quest.State |
|
| RandomSelectors |
Contains ResultSelector's to be used with a Stream as a collection operation. |
| Region |
|
| Resources |
Contains utilities to load script resources
|
| Resources.ResourceNotFoundException |
Exception thrown when a resource is not found
|
| ResultSelector<T> |
Represents an interface that extracts a result from a list.
|
| Retry |
|
| RuntimeTypeAdapterFactory<T> |
Adapts values whose runtime type may differ from their declaration type.
|
| Screenshot |
Utility methods for taking screenshots of the game
|
| ScriptConfig |
Defines a set of configuration options for a script.
|
| ScriptListening |
Contains listeners for script events.
|
| ScriptRuntimeInfo |
Contains various methods to get script runtime information
|
| ScriptSettings |
Contains utility methods for saving/loading script settings.
|
| ScriptSettings.ScriptSettingsBuilder |
|
| ServerMessageListener |
Represents a listener for server/game messages.
|
| Shop |
Contains methods for interacting with and inspecting the common shop interface.
|
| Shop.Quantity |
Represents a quantity that can be bought/sold at a shop
|
| ShopItemQuery |
A query to search over items available in the shop
|
| Skill |
A skill listed in the skills tab
|
| Stackable |
Represents a stackable entity (an entity that has a stack)
|
| StackableItemDefinableQuery<EntityType extends ItemDefinable & Stackable,QueryType extends Query<EntityType,QueryType>> |
A query to search over Stackable entities that are ItemDefinable
This type serves as a bridge between ground items/interface items |
| StackableQuery<EntityType extends Stackable,QueryType extends Query<EntityType,QueryType>> |
|
| Tile |
Represents a position in the game.
|
| TileQuery |
A query to search over tiles in the local region
|
| TradeQuery |
A query for searching over items in the trade screen.
|
| TradeRequestListener |
Represents a listener for trade requests
|
| TradeScreen |
Utilities for interacting with the "trading" interface that appears for player-to-player trades.
|
| TradeScreen.MyPlayer |
My player's trade screen information
|
| TradeScreen.OtherPlayer |
The other player's trade screen information
|
| TradeScreen.Stage |
The trade window stage
|
| Tribot |
Contains methods to obtain information about the tribot environment
|
| TribotRandom |
Utility class to generate random numbers
|
| TribotScript |
This interface denotes a runnable tribot script.
|
| TribotScriptManifest |
|
| Waiting |
Utilities for waiting (variable sleeps based on a condition and static waits).
|
| WalkState |
Represents a walk state to be used as a walking condition.
|
| Widget |
Represents an on-screen UI element that is drawn on the game canvas
|
| WidgetAddress |
Contains an "address" (the index path) for a widget to avoid avoid hardcoding the indexes.
|
| WidgetItem |
Represents an item displayed in a widget
|
| WidgetItemQuery |
A query to search over items listed inside of an Widget. |
| WidgetQuery |
A query to search over entities of type Widget |
| Widgets |
Utilities for inspecting Widgets.
|
| World |
Represents a world in the list of worlds available
|
| World.Location |
Represents the location that a world can have.
|
| World.Type |
Represents the types that a world can have.
|
| WorldHopper |
Contains methods for using the world hopper
|
| WorldQuery |
A query to search over all available game worlds
|
| Worlds |
Contains utility methods for accessing worlds
|
| WorldTile |
Represents a unique tile position in Runescape.
|