- IAboutToChooseActionHandler - Interface in bothack.events
-
Called before IActionHandler#chooseAction is about to be triggered.
- IAction - Interface in bothack.actions
-
Representation of a primitive BotHack action.
- IActionChosenHandler - Interface in bothack.events
-
- IActionHandler - Interface in bothack.prompts
-
This is the most crucial interface to implement in your bot
(in one or more registered handlers).
- IAppearance - Interface in bothack.bot
-
Immutable representation of a virtual terminal character.
- IBotHack - Interface in bothack.bot
-
The root of BotHack functionality.
- IChargeWhatHandler - Interface in bothack.prompts
-
Called when the player may choose an item to charge after reading
a scroll of charging.
- identifyPossibilities(IItem) - Method in interface IGame
-
Returns the list of possible item types for the item considering the
current game discoveries.
- identifyType(IItem) - Method in interface IGame
-
Returns IItemType with properties of the item that can be determined
considering the current game discoveries.
- identifyWhat(Map<Character, String>) - Method in interface IIdentifyWhatHandler
-
Called when the player can choose items to identify.
- IDirectionHandler - Interface in bothack.prompts
-
Called when a direction prompt is presented to the player.
- IDlvlChangeHandler - Interface in bothack.events
-
Called when the player switches dungeon levels.
- IDoTeleportHandler - Interface in bothack.prompts
-
Called when the player is prompted whether or not he wants to teleport.
- IDungeon - Interface in bothack.bot.dungeon
-
Immutable representation of the dungeon level tree.
- IEnhanceWhatHandler - Interface in bothack.prompts
-
Called when the Enhance skill menu appears with a choice of skill to enhance.
- IFoundItemsHandler - Interface in bothack.events
-
Called every time the player encounters items on his current tile and in containers on the tile.
- IFrame - Interface in bothack.bot
-
Immutable representation of a 80x24 virtual terminal.
- IFullFrameHandler - Interface in bothack.events
-
Called when the frame on screen is fully drawn – the cursor is on the player,
the map and status lines are completely drawn.
- IGame - Interface in bothack.bot
-
Immutable representation of the game state at some point.
- IGameStateHandler - Interface in bothack.events
-
Notification of game start or end.
- IGenocideHandler - Interface in bothack.prompts
-
Called when the player can choose monsters to genocide.
- IIdentifyWhatHandler - Interface in bothack.prompts
-
Called when the player can choose items to identify.
- IItem - Interface in bothack.bot.items
-
Immutable representation of an item.
- IItemType - Interface in bothack.bot.items
-
Representation of item "prototypes" of all kinds.
- IKnowPositionHandler - Interface in bothack.events
-
Called when the cursor is on the player –
besides full frames this also occurs on location prompts.
- ILevel - Interface in bothack.bot.dungeon
-
Immutable representation of a dungeon level with its inhabitants.
- ILevelTeleportHandler - Interface in bothack.prompts
-
Called when the player can choose a level to teleport to.
- IMakeWishHandler - Interface in bothack.prompts
-
Called when the player can make a wish.
- IMonster - Interface in bothack.bot.monsters
-
Immutable representation a monster on a level.
- IMonsterType - Interface in bothack.bot.monsters
-
Immutable representation of one of the 375 NetHack monsters.
- IMultilineMessageHandler - Interface in bothack.events
-
Called when a fullscreen message is presented to the player.
- Intrinsic - Enum in bothack.bot
-
- inventory() - Method in interface IPlayer
-
The player's inventory.
- IOfferHandler - Interface in bothack.prompts
-
Called when the player can choose the amount of gold to offer.
- IPayDamageHandler - Interface in bothack.prompts
-
Called when the player is asked to pay damage caused in the shop.
- IPlayer - Interface in bothack.bot
-
Immutable representation of player-related state and functionality.
- IPosition - Interface in bothack.bot
-
Immutable representation of a position on the screen.
- IPredicate<T> - Interface in bothack.bot
-
Custom filter function.
- IReallyAttackHandler - Interface in bothack.prompts
-
Called when you move towards a peaceful monster.
- IRedrawHandler - Interface in bothack.events
-
Called every time the screen contents change.
- isAmphibious() - Method in interface IMonsterType
-
- isArtifact() - Method in interface IItem
-
True if the item is an artifact.
- isArtifact() - Method in interface IItemType
-
True if the item type is an artifact.
- isAwake() - Method in interface IMonster
-
True if the monster was seen moving.
- isBelowCastle() - Method in interface IGame
-
True when the player is below the castle or on the right
side of the castle moat.
- isBelowMedusa() - Method in interface IGame
-
True when the player is below the medusa's level or on the right
side of the island.
- isBlind() - Method in interface IPlayer
-
True if the player is blinded.
- isBlindExternally() - Method in interface IPlayer
-
True if the player is blinded by a cream pie or venom.
- isBlocked() - Method in interface ITile
-
True for tiles where navigation failed many times due to a stubborn
peaceful monster.
- isBurdened() - Method in interface IPlayer
-
True if the player is burdened or worse.
- isCharged() - Method in interface IItem
-
True if the item is not known to be empty.
- isContainer() - Method in interface IItem
-
True if the item may contain other items.
- isCorpse() - Method in interface IItem
-
True if the item is a monster's corpse.
- isCorpseFresh(IPosition, IItem) - Method in interface IGame
-
Corpse freshness tracker – checks if the corpse at given position is likely
good to eat.
- isCorrosive() - Method in interface IMonsterType
-
Does the monster corrode weapons passively?
- isCovetous() - Method in interface IMonsterType
-
Monsters that will teleport to the upstairs to heal and steal artifacts.
- isDizzy() - Method in interface IPlayer
-
True if the player is confused or stunned.
- ISeducedHandler - Interface in bothack.prompts
-
Called when a succubus or an incubus makes a request.
- ISellItHandler - Interface in bothack.prompts
-
Called when you drop an item in a shop and the shopkeeper is interested
in buying it.
- isEngravable() - Method in interface ITile
-
True if it is possible to engrave on this tile by some means.
- isEngulfed() - Method in interface IPlayer
-
True if the player is engulfed by a monster.
- isEnteringShop(IGame) - Static method in class Navigation
-
Returns true if the player is just about to enter a shop and should not pick up pickaxes.
- isFixed() - Method in interface IItem
-
True for rustproof/fireproof/fixed items.
- isFlying() - Method in interface IMonsterType
-
- isFollower() - Method in interface IMonsterType
-
- isFriendly() - Method in interface IMonster
-
True for tame monsters
- isGuard() - Method in interface IMonsterType
-
True for the minetown watch and vault guards
- isHostile() - Method in interface IMonsterType
-
Is the monster always hostile when generated?
A peaceful or tame instance of this monster can still exist.
- isHuman() - Method in interface IMonsterType
-
Killing humans has a penalty for lawfuls, as does cannibalism
- isHungry() - Method in interface IPlayer
-
True if the player is hungry or worse.
- isIll() - Method in interface IPlayer
-
True if the player is deathly sick (including food poisoning).
- isInGehennom() - Method in interface IGame
-
Gehennom including the valley excluding Vlad's – prayers will be redirected to Moloch
- isInUse() - Method in interface IItem
-
True if the item is worn or wielded.
- isMimic() - Method in interface IMonsterType
-
- isMindless() - Method in interface IMonsterType
-
Mindless monsters can't be seen by telepathy
- isNasty() - Method in interface IMonsterType
-
Corresponds to a NetHack monster flag
- isOverloaded() - Method in interface IPlayer
-
True if the player is overloaded.
- isOvertaxed() - Method in interface IPlayer
-
True if the player is overtaxed or worse.
- isPassive() - Method in interface IMonsterType
-
Does the monster lack active attacks?
- isPeaceful() - Method in interface IMonster
-
True for peaceful monsters
- isPoisonous() - Method in interface IMonsterType
-
Does the monster have a poisonous corpse?
- isPriest() - Method in interface IMonsterType
-
- isRecharged() - Method in interface IItem
-
True if the item has been recharged.
- isRemembered() - Method in interface IMonster
-
True if the monster is not currently known to be there.
- isRider() - Method in interface IMonsterType
-
Riders of the apocalypse on Astral
- isSafe() - Method in interface IItemType
-
If true generally won't cause any immediate bad effects upon use.
- isSafeToEnchant() - Method in interface IItem
-
True if the item can be safely enchanted.
- isSessile() - Method in interface IMonsterType
-
Sessile monsters don't move at all.
- isShopkeeper() - Method in interface IMonsterType
-
- isStackable() - Method in interface IItemType
-
True if items of this type may stack.
- isStatDrained() - Method in interface IPlayer
-
True if the player has restorable drained stats.
- isStoning() - Method in interface IPlayer
-
True if the player is about to turn into stone.
- isStrained() - Method in interface IPlayer
-
True if the player is strained or worse.
- isStressed() - Method in interface IPlayer
-
True if the player is stressed or worse.
- isStrong() - Method in interface IMonsterType
-
Corresponds to a NetHack monster flag
- isStunned() - Method in interface IPlayer
-
True if the player is stunned.
- IStopEatingHandler - Interface in bothack.prompts
-
Called when the player is close to dying from overeating.
- isTrap() - Method in interface ITile
-
True if the tile has a trap.
- isTrapped() - Method in interface IPlayer
-
True if the player is stuck in a trap.
- isTwohanded() - Method in interface IItem
-
True if the item requires both hands to wield.
- isTwohanded() - Method in interface IItemType
-
True if the item requires both hands to wield.
- isUndead() - Method in interface IMonsterType
-
- isUnique() - Method in interface IMonsterType
-
- isVibrating() - Method in interface ITile
-
True for the vibrating square.
- isWeak() - Method in interface IPlayer
-
True if the hunger status is WEAK or worse
- isWerecreature() - Method in interface IMonsterType
-
- isWielded() - Method in interface IItem
-
True if the item wielded by the player.
- isWorn() - Method in interface IItem
-
True if the item worn by the player.
- ITeleportWhereHandler - Interface in bothack.prompts
-
Called when the player can teleport in a controlled way.
- ItemKind - Enum in bothack.bot.items
-
- items() - Method in interface ITile
-
Items laying on the ground on the tile
- ItemSubtype - Enum in bothack.bot.items
-
- ItemType - Class in bothack.bot.items
-
Factory and utility functions for item types.
- ITile - Interface in bothack.bot.dungeon
-
Immutable representation of a tile of the dungeon.
- IToplineMessageHandler - Interface in bothack.events
-
Called when a message appears on the top line (without --More-- if any).
- IVaultGuardHandler - Interface in bothack.prompts
-
Called when a guard finds the player in a vault.
- IWhichRingFingerHandler - Interface in bothack.prompts
-
Called when you can choose which hand to put a ring on.
- score() - Method in interface IGame
-
Return the current game score.
- Search() - Static method in class Actions
-
Search the around the current tile once.
- Search(Long) - Static method in class Actions
-
Shorthand for searching multiple times
- searchCurrentLevel(IGame) - Static method in class Navigation
-
Returns an action to explore or search the current level or null if the first
round of searching is already done.
- searchCurrentLevelRepeatedly(IGame) - Static method in class Navigation
-
Returns an action to explore or search the current level repeatedly.
- searched() - Method in interface ITile
-
Number of times the tile has been searched (est.)
- seducedPuton() - Method in interface ISeducedHandler
-
Called when a succubus or an incubus makes a request to put on a ring.
- seducedRemove() - Method in interface ISeducedHandler
-
Called when a succubus or an incubus makes a request to remove your clothing.
- seek(IGame, IPosition) - Static method in class Navigation
-
Returns an action to look for the specified tile on the current level or
null if already standing at a matching tile.
- seek(IGame, IPredicate<ITile>) - Static method in class Navigation
-
Returns an action to look for the specified tile on the current level or
null if already standing at a matching tile.
- seekBranch(IGame, Branch) - Static method in class Navigation
-
Returns an action to look for the specified branch or null if already there.
- seekInterlevel(IGame, IPredicate<ITile>, long) - Static method in class Navigation
-
Intralevel navigation to the nearest matching tile.
- seekInterlevel(IGame, IPredicate<ITile>) - Static method in class Navigation
-
Interlevel navigation to the nearest matching tile.
- seekInterlevelUpwards(IGame, IPredicate<ITile>) - Static method in class Navigation
-
- seekInterlevelUpwards(IGame, IPredicate<ITile>, long) - Static method in class Navigation
-
- seekLevel(IGame, Branch, String) - Static method in class Navigation
-
Returns an action to go to the specified level or null if already there.
- seekLevel(IGame, Branch, LevelTag) - Static method in class Navigation
-
Returns an action to go to the specified level or null if already there.
- seesInvisible() - Method in interface IMonsterType
-
- sellIt(Integer, String) - Method in interface ISellItHandler
-
Called when you drop an item in a shop and the shopkeeper is interested
in buying it.
- sinkGaveFoocubus() - Method in interface ITile
-
For tiles with the SINK feature - true if kicking it already yielded a succubus or an incubus.
- sinkGavePudding() - Method in interface ITile
-
For tiles with the SINK feature - true if kicking it already yielded a pudding.
- sinkGaveRing() - Method in interface ITile
-
For tiles with the SINK feature - true if kicking it already yielded a ring.
- Sit() - Static method in class Actions
-
Sit down (only useful on thrones).
- speed() - Method in interface IMonsterType
-
How often the monster gets a turn - larger is better
- started() - Method in interface IGameStateHandler
-
Called when the game starts.
- Stat - Enum in bothack.bot
-
- step() - Method in interface Navigation.IPath
-
The next action that will lead towards reaching the target.
- stopEatingHandler(String) - Method in interface IStopEatingHandler
-
Called when the player is close to dying from overeating.
- subtype() - Method in interface IItemType
-
Armor slot or item category.
- valueOf(String) - Static method in enum NavOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum Alignment
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum Color
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum Direction
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum Branch
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum EngravingType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum Feature
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum LevelTag
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum RoomType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum Encumbrance
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum HaveOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum Hunger
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum Intrinsic
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum BUC
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum ItemKind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum ItemSubtype
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum Stat
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum NavOption
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum Alignment
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum Color
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum Direction
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum Branch
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum EngravingType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum Feature
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum LevelTag
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum RoomType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum Encumbrance
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum HaveOption
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum Hunger
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum Intrinsic
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum BUC
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum ItemKind
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum ItemSubtype
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum Stat
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- visitBranch(IGame, Branch) - Static method in class Navigation
-
If the specified branch has never been visited, returns the action to navigate to it
and possibly explore it until identified.
- visitLevel(IGame, Branch, String) - Static method in class Navigation
-
If the specified level has never been visited, returns the action to navigate to it.
- visitLevel(IGame, Branch, LevelTag) - Static method in class Navigation
-
If the specified level has never been visited, returns the action to navigate to it.