IGame (BotHack JavaDoc)

```
public interface IGame
```
Immutable representation of the game state at some point.

Method Summary

Methods
Modifier and Type	Method and Description
`Long`	`actionTurn()` Return the number of actions performed since the bot started.
`Boolean`	`canEngrave()` True if the player is capable of engraving and is not currently on the plane of air or water.
`Boolean`	`canPray()` True if the player can safely pray (95% confidence)
`ILevel`	`currentLevel()` Returns the current dungeon level.
`IFrame`	`frame()` Returns the last snapshot of the virtual terminal screen.
`Set<String>`	`genocided()` Returns the set of monster types and classes that have been genocided in the game.
`Long`	`gold()` How much gold the player is carrying in total (including bagged gold).
`Long`	`goldAvailable()` How much gold the player is carrying in main inventory.
`Map.Entry<Character,IItem>`	`have(IPredicate<IItem> selector, HaveOption... opts)` Return an inventory slot-item pair of an item accepted by a custom predicate.
`Map.Entry<Character,IItem>`	`have(String itemName, HaveOption... opts)` Return an inventory slot-item pair of an item with the given name.
`List<Map.Entry<Character,IItem>>`	`haveAll(IPredicate<IItem> selector, HaveOption... opts)` Return all inventory slot-item pairs of items accepted by a custom predicate.
`List<Map.Entry<Character,IItem>>`	`haveAll(String itemName, HaveOption... opts)` Return all inventory slot-item pairs of items with the given name.
`Map.Entry<Character,IItem>`	`haveLevitationItemOn()` Returns the slot-item pair of a levitation item currently in use (or null)
`List<IItemType>`	`identifyPossibilities(IItem item)` Returns the list of possible item types for the item considering the current game discoveries.
`IItemType`	`identifyType(IItem item)` Returns IItemType with properties of the item that can be determined considering the current game discoveries.
`Boolean`	`isBelowCastle()` True when the player is below the castle or on the right side of the castle moat.
`Boolean`	`isBelowMedusa()` True when the player is below the medusa's level or on the right side of the island.
`Boolean`	`isCorpseFresh(IPosition pos, IItem corpse)` Corpse freshness tracker – checks if the corpse at given position is likely good to eat.
`Boolean`	`isInGehennom()` Gehennom including the valley excluding Vlad's – prayers will be redirected to Moloch
`Boolean`	`knowIdentity(IItem item)` Returns true if the IItemType for the item can be determined unambiguously from current discoveries (the item is identified for practical purposes).
`IPlayer`	`player()` Returns the player representation.
`IGame`	`previousGamestate()` Returns the IGame snapshot from previous action turn.
`Long`	`score()` Return the current game score.
`Long`	`turn()` Return the number of game turns passed since the bot started.
`Boolean`	`wantPriceId(IItem item)` True if trying to buy or sell the item would help its identification.
`Boolean`	`wasTried(IItem item)` True if trying to use the item may help with identification.
`Long`	`weightSum()` Estimate of the sum of weight of all carried items.

- Method Detail
  - frame
```
IFrame frame()
```
    Returns the last snapshot of the virtual terminal screen.
  - player
```
IPlayer player()
```
    Returns the player representation.
  - canPray
```
Boolean canPray()
```
    True if the player can safely pray (95% confidence)
  - canEngrave
```
Boolean canEngrave()
```
    True if the player is capable of engraving and is not currently on the plane of air or water.
  - haveLevitationItemOn
```
Map.Entry<Character,IItem> haveLevitationItemOn()
```
    Returns the slot-item pair of a levitation item currently in use (or null)
  - genocided
```
Set<String> genocided()
```
    Returns the set of monster types and classes that have been genocided in the game.
  - currentLevel
```
ILevel currentLevel()
```
    Returns the current dungeon level.
  - weightSum
```
Long weightSum()
```
    Estimate of the sum of weight of all carried items.
  - gold
```
Long gold()
```
    How much gold the player is carrying in total (including bagged gold).
  - goldAvailable
```
Long goldAvailable()
```
    How much gold the player is carrying in main inventory.
  - isCorpseFresh
```
Boolean isCorpseFresh(IPosition pos,
                    IItem corpse)
```
    Corpse freshness tracker – checks if the corpse at given position is likely good to eat. May return false even for fresh corpses if there is any uncertainity.
    
    See Also:
    IPlayer.canEat(IItem)
  - turn
```
Long turn()
```
    Return the number of game turns passed since the bot started.
  - actionTurn
```
Long actionTurn()
```
    Return the number of actions performed since the bot started.
  - score
```
Long score()
```
    Return the current game score.
  - identifyType
```
IItemType identifyType(IItem item)
```
    Returns IItemType with properties of the item that can be determined considering the current game discoveries. Undeterminable properties will be null. If the item can be unambiguously identified will return the full IItemType.
    
    See Also:
    knowIdentity(IItem)
  - identifyPossibilities
```
List<IItemType> identifyPossibilities(IItem item)
```
    Returns the list of possible item types for the item considering the current game discoveries.
  - knowIdentity
```
Boolean knowIdentity(IItem item)
```
    Returns true if the IItemType for the item can be determined unambiguously from current discoveries (the item is identified for practical purposes).
  - wantPriceId
```
Boolean wantPriceId(IItem item)
```
    True if trying to buy or sell the item would help its identification.
  - wasTried
```
Boolean wasTried(IItem item)
```
    True if trying to use the item may help with identification.
    
    See Also:
    ActionsComplex.makeUse(IGame, Character)
  - previousGamestate
```
IGame previousGamestate()
```
    Returns the IGame snapshot from previous action turn.
  - have
```
Map.Entry<Character,IItem> have(IPredicate<IItem> selector,
                              HaveOption... opts)
```
    Return an inventory slot-item pair of an item accepted by a custom predicate.
    
    Parameters:
    selector - Custom-implemented filter
  - have
```
Map.Entry<Character,IItem> have(String itemName,
                              HaveOption... opts)
```
    Return an inventory slot-item pair of an item with the given name. Tries to match both IItem.name() and the IItemType.name() if the item can be identified.
    
    Parameters:
    itemName - The sought item or type name
    opts - Additional restrictions
  - haveAll
```
List<Map.Entry<Character,IItem>> haveAll(IPredicate<IItem> selector,
                                       HaveOption... opts)
```
    Return all inventory slot-item pairs of items accepted by a custom predicate.
    
    Parameters:
    selector - Custom-implemented filter
    opts - Additional restrictions
  - haveAll
```
List<Map.Entry<Character,IItem>> haveAll(String itemName,
                                       HaveOption... opts)
```
    Return all inventory slot-item pairs of items with the given name. Tries to match both IItem.name() and the IItemType.name() if the item can be identified.
    
    Parameters:
    itemName - The sought item or type name
    opts - Additional restrictions
  - isInGehennom
```
Boolean isInGehennom()
```
    Gehennom including the valley excluding Vlad's – prayers will be redirected to Moloch
  - isBelowMedusa
```
Boolean isBelowMedusa()
```
    True when the player is below the medusa's level or on the right side of the island.
  - isBelowCastle
```
Boolean isBelowCastle()
```
    True when the player is below the castle or on the right side of the castle moat.

Interface IGame

Method Summary

Method Detail

frame

player

canPray

canEngrave

haveLevitationItemOn

genocided

currentLevel

weightSum

gold

goldAvailable

isCorpseFresh

turn

actionTurn

score

identifyType

identifyPossibilities

knowIdentity

wantPriceId

wasTried

previousGamestate

have

have

haveAll

haveAll

isInGehennom

isBelowMedusa

isBelowCastle