IPlayer (BotHack JavaDoc)

All Superinterfaces:

Associative, Counted, ILookup, IPersistentCollection, IPersistentMap, IPosition, Iterable, Seqable
```
public interface IPlayer
extends IPosition
```
Immutable representation of player-related state and functionality.

Method Summary

Methods
Modifier and Type	Method and Description
`Long`	`AC()` Armor class – lower is better.
`Alignment`	`alignment()` Returns the player's current alignment.
`Boolean`	`canEat(IItem food)` True if the player can eat the food with no ill effects.
`Boolean`	`canEatWithBenefit(IItem corpse)` True if the player can gain intrinsics or stats by eating the corpse.
`Boolean`	`canEnhance()` True if there are skills that can be Enhanced.
`Long`	`carryingCapacity()` How much weight the player can carry before getting burdened.
`Encumbrance`	`encumbrance()` Returns the current outstanding encumbrance status (possibly null).
`Long`	`experienceLevel()` The player's level.
`Long`	`getDisplayedStr()` The displayed value of strenght – may be something like 18/10 or 18/**
`Long`	`getStat(Stat stat)` Get the effective integer value of stat.
`Boolean`	`hasHands()` False when polymorphed into a handless or limbless monster.
`Boolean`	`hasHurtLegs()` True if the player has wounded legs.
`Boolean`	`hasIntrinsic(Intrinsic intrinsic)` Returns true if the player has the given intrinsic.
`Boolean`	`hasLycantrophy()` True if the player is a were-something.
`Long`	`HP()` The amount of hit points remanining.
`Hunger`	`hunger()` Returns the current hunger status (possibly null).
`Map<Character,IItem>`	`inventory()` The player's inventory.
`Boolean`	`isBlind()` True if the player is blinded.
`Boolean`	`isBlindExternally()` True if the player is blinded by a cream pie or venom.
`Boolean`	`isBurdened()` True if the player is burdened or worse.
`Boolean`	`isDizzy()` True if the player is confused or stunned.
`Boolean`	`isEngulfed()` True if the player is engulfed by a monster.
`Boolean`	`isHungry()` True if the player is hungry or worse.
`Boolean`	`isIll()` True if the player is deathly sick (including food poisoning).
`Boolean`	`isOverloaded()` True if the player is overloaded.
`Boolean`	`isOvertaxed()` True if the player is overtaxed or worse.
`Boolean`	`isStatDrained()` True if the player has restorable drained stats.
`Boolean`	`isStoning()` True if the player is about to turn into stone.
`Boolean`	`isStrained()` True if the player is strained or worse.
`Boolean`	`isStressed()` True if the player is stressed or worse.
`Boolean`	`isStunned()` True if the player is stunned.
`Boolean`	`isTrapped()` True if the player is stuck in a trap.
`Boolean`	`isWeak()` True if the hunger status is WEAK or worse
`Long`	`maxHP()` The maximum amount of hit points.
`Long`	`maxPW()` The maximum amount of magic power.
`String`	`nickname()` Name displayed on the status line.
`IMonsterType`	`polymorphed()` Returns the monster type into which the player is currently polymorphed.
`Long`	`protection()` How many times the player bought divine protection.
`Long`	`PW()` The amount of magic power.
`String`	`title()` Title displayed on the status line.
`Map.Entry<Character,IItem>`	`wielding()` The slot-item pair for item wielded in hand.

Methods inherited from interface IPosition
x, y

Methods inherited from interface IPersistentMap
assoc, assocEx, without

Methods inherited from interface Iterable
iterator

Methods inherited from interface Associative
containsKey, entryAt

Methods inherited from interface IPersistentCollection
cons, count, empty, equiv

Methods inherited from interface Seqable
seq

Methods inherited from interface ILookup
valAt, valAt

Methods inherited from interface Counted
count

- Method Detail
  - alignment
```
Alignment alignment()
```
    Returns the player's current alignment. Not to be confused with alignment record, which is currently untracked.
  - hunger
```
Hunger hunger()
```
    Returns the current hunger status (possibly null).
  - encumbrance
```
Encumbrance encumbrance()
```
    Returns the current outstanding encumbrance status (possibly null).
  - canEnhance
```
Boolean canEnhance()
```
    True if there are skills that can be Enhanced.
    
    See Also:
    Actions.Enhance(), ActionsComplex.enhanceAll(IGame)
  - hasHands
```
Boolean hasHands()
```
    False when polymorphed into a handless or limbless monster.
  - hasHurtLegs
```
Boolean hasHurtLegs()
```
    True if the player has wounded legs. This can be caused by xan attacks, land mines, bad kicks etc. and fixes itself in a while.
  - isOverloaded
```
Boolean isOverloaded()
```
    True if the player is overloaded. Almost all actions are impossible in this state.
  - isOvertaxed
```
Boolean isOvertaxed()
```
    True if the player is overtaxed or worse. Most actions are impossible in this state.
  - isStrained
```
Boolean isStrained()
```
    True if the player is strained or worse. Some actions are impossible in this state.
  - isStressed
```
Boolean isStressed()
```
    True if the player is stressed or worse. Some actions are impossible in this state.
  - isBurdened
```
Boolean isBurdened()
```
    True if the player is burdened or worse.
  - isWeak
```
Boolean isWeak()
```
    True if the hunger status is WEAK or worse
  - isHungry
```
Boolean isHungry()
```
    True if the player is hungry or worse.
  - isBlindExternally
```
Boolean isBlindExternally()
```
    True if the player is blinded by a cream pie or venom.
  - isEngulfed
```
Boolean isEngulfed()
```
    True if the player is engulfed by a monster.
  - polymorphed
```
IMonsterType polymorphed()
```
    Returns the monster type into which the player is currently polymorphed.
  - hasIntrinsic
```
Boolean hasIntrinsic(Intrinsic intrinsic)
```
    Returns true if the player has the given intrinsic.
  - nickname
```
String nickname()
```
    Name displayed on the status line.
  - title
```
String title()
```
    Title displayed on the status line.
  - HP
```
Long HP()
```
    The amount of hit points remanining.
  - maxHP
```
Long maxHP()
```
    The maximum amount of hit points.
  - PW
```
Long PW()
```
    The amount of magic power.
  - maxPW
```
Long maxPW()
```
    The maximum amount of magic power.
  - AC
```
Long AC()
```
    Armor class – lower is better.
  - experienceLevel
```
Long experienceLevel()
```
    The player's level. You need at least 14 to be able to enter the quest.
  - inventory
```
Map<Character,IItem> inventory()
```
    The player's inventory.
  - wielding
```
Map.Entry<Character,IItem> wielding()
```
    The slot-item pair for item wielded in hand.
  - isTrapped
```
Boolean isTrapped()
```
    True if the player is stuck in a trap.
  - isStatDrained
```
Boolean isStatDrained()
```
    True if the player has restorable drained stats.
  - hasLycantrophy
```
Boolean hasLycantrophy()
```
    True if the player is a were-something.
    
    See Also:
    polymorphed()
  - isStoning
```
Boolean isStoning()
```
    True if the player is about to turn into stone.
  - isBlind
```
Boolean isBlind()
```
    True if the player is blinded.
    
    See Also:
    isBlindExternally()
  - isStunned
```
Boolean isStunned()
```
    True if the player is stunned.
  - isIll
```
Boolean isIll()
```
    True if the player is deathly sick (including food poisoning).
  - isDizzy
```
Boolean isDizzy()
```
    True if the player is confused or stunned.
  - canEat
```
Boolean canEat(IItem food)
```
    True if the player can eat the food with no ill effects. Does not check corpse freshness!
    
    See Also:
    IGame.isCorpseFresh(IPosition, IItem)
  - canEatWithBenefit
```
Boolean canEatWithBenefit(IItem corpse)
```
    True if the player can gain intrinsics or stats by eating the corpse. Does not check corpse freshness!
    
    See Also:
    IGame.isCorpseFresh(IPosition, IItem)
  - carryingCapacity
```
Long carryingCapacity()
```
    How much weight the player can carry before getting burdened.
  - getStat
```
Long getStat(Stat stat)
```
    Get the effective integer value of stat.
    
    See Also:
    getDisplayedStr()
  - getDisplayedStr
```
Long getDisplayedStr()
```
    The displayed value of strenght – may be something like 18/10 or 18/**
  - protection
```
Long protection()
```
    How many times the player bought divine protection.

Interface IPlayer

Method Summary

Methods inherited from interface IPosition

Methods inherited from interface IPersistentMap

Methods inherited from interface Iterable

Methods inherited from interface Associative

Methods inherited from interface IPersistentCollection

Methods inherited from interface Seqable

Methods inherited from interface ILookup

Methods inherited from interface Counted

Method Detail

alignment

hunger

encumbrance

canEnhance

hasHands

hasHurtLegs

isOverloaded

isOvertaxed

isStrained

isStressed

isBurdened

isWeak

isHungry

isBlindExternally

isEngulfed

polymorphed

hasIntrinsic

nickname

title

HP

maxHP

PW

maxPW

AC

experienceLevel

inventory

wielding

isTrapped

isStatDrained

hasLycantrophy

isStoning

isBlind

isStunned

isIll

isDizzy

canEat

canEatWithBenefit

carryingCapacity

getStat

getDisplayedStr

protection