Actions (BotHack JavaDoc)

Object
- Actions

```
public final class Actions
extends Object
```
Factories for primitive BotHack actions.
When using these actions you should first make sure the action can actually be performed in the current context before returning it in an ActionHandler. A bot can get stuck easily for example by attempting to wield something repeatedly when it has no hands since trying it takes no game turns.

Many actions have a "smarter" variant in ActionsComplex that also checks preconditions.

See Also:
ActionsComplex

Method Summary

Methods
Modifier and Type	Method and Description
`static IAction`	`Apply(Character slot)` Apply item at given inventory slot.
`static IAction`	`ApplyAt(Character slot, Direction dir)` Apply the item in the given direction (if prompted).
`static IAction`	`Ascend()` Go up the stairs or climb a ladder.
`static IAction`	`Attack(Direction dir)` Force attack in the given direction (NetHack 'F' command).
`static IAction`	`Chat(Direction dir)` Chat with monster at direction dir.
`static IAction`	`Close(Direction dir)` Close a door
`static IAction`	`Contribute(Direction dir, Long amount)` Offer a donation to a priest at dir.
`static IAction`	`Descend()` Go down the stairs or a ladder.
`static IAction`	`Dip(Character itemSlot, Character potionSlot)` Dip item at itemSlot into potion at potionSlot (or a fountain if it is '.')
`static IAction`	`Drop(Character slot)` Drop one of item at slot.
`static IAction`	`Drop(Character slot, Long num)` Drop a specific amount of item at slot.
`static IAction`	`Eat(Character slot)` Eat item at slot.
`static IAction`	`Eat(String label)` Eat item from the ground by label.
`static IAction`	`EngraveAppending(Character slot, String engraving)` Engrave action overwriting the current engraving (if prompted).
`static IAction`	`EngraveOverwriting(Character slot, String engraving)` Engrave action appending to the current engraving (if prompted).
`static IAction`	`Enhance()` Enhance specific skills.
`static IAction`	`ForceLock()` Use current weapon to force a lock on a container.
`static IAction`	`Kick(Direction dir)` Kick in the given direction.
`static IAction`	`Move(Direction dir)` Move or attack in the given direction.
`static IAction`	`Offer(Character slot)` Offer item at slot as sacrifice.
`static IAction`	`Offer(String label)` Offer item from the ground by label.
`static IAction`	`Open(Direction dir)` Open a door
`static IAction`	`PickUp(List<String> labels)` Pick up all items in the list by label.
`static IAction`	`PickUp(String label)` Pick up all of item by label.
`static IAction`	`Pray()` #pray action.
`static IAction`	`PutIn(Character bagSlot, Character itemSlot)` Put all of item at itemSlot into the container at bagSlot.
`static IAction`	`PutIn(Character bagSlot, Character itemSlot, Long amount)` Put amount of item at itemSlot into the container at bagSlot.
`static IAction`	`PutOn(Character slot)` Put on item at slot (for jewelry).
`static IAction`	`Quaff(Character slot)` Drink a potion at slot.
`static IAction`	`Read(Character slot)` Read scrolls or spellbooks.
`static IAction`	`Remove(Character slot)` Remove item at slot (for jewelry).
`static IAction`	`Rub(Character slot)` Rub a lamp at slot.
`static IAction`	`Search()` Search the around the current tile once.
`static IAction`	`Search(Long num)` Shorthand for searching multiple times
`static IAction`	`Sit()` Sit down (only useful on thrones).
`static IAction`	`TakeOff(Character slot)` Take off item at slot (for armor).
`static IAction`	`TakeOut(Character bagSlot, String itemLabel)` Take out all of item with label itemLabel from container at bagSlot.
`static IAction`	`TakeOut(Character bagSlot, String itemLabel, Long amount)` Take out amount of item with label itemLabel from container at bagSlot.
`static IAction`	`Throw(Character slot, Direction dir)` Throw item at slot in direction dir.
`static IAction`	`Unlock(Character slot, Direction dir)` Use key, lockpick or credit card at slot to unlock a door.
`static IAction`	`Wait()` Do nothing in the next turn.
`static IAction`	`Wear(Character slot)` Wear item at slot (for armor).
`static IAction`	`Wield(Character slot)` Wield item at slot as a weapon.
`static IAction`	`Wipe()` Wipe own face.
`static IAction`	`ZapWand(Character slot)` Zap a known non-directional wand.
`static IAction`	`ZapWandAt(Character slot, Direction dir)` Zap a wand in the given direction (if prompted for a direction).

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - Attack
```
public static IAction Attack(Direction dir)
```
    Force attack in the given direction (NetHack 'F' command). Note that you can't attack when overtaxed or worse.
    
    See Also:
    IPlayer.isOvertaxed()
  - Move
```
public static IAction Move(Direction dir)
```
    Move or attack in the given direction. Note that you can't move when overloaded.
    
    See Also:
    IPlayer.isOverloaded()
  - Search
```
public static IAction Search()
```
    Search the around the current tile once.
    
    See Also:
    Search(Long)
  - Search
```
public static IAction Search(Long num)
```
    Shorthand for searching multiple times
  - Wait
```
public static IAction Wait()
```
    Do nothing in the next turn. You might as well Search.
  - Ascend
```
public static IAction Ascend()
```
    Go up the stairs or climb a ladder. Note that you can't do this when stressed or worse.
    
    See Also:
    IPlayer.isStressed(), ITile.feature()
  - Descend
```
public static IAction Descend()
```
    Go down the stairs or a ladder.
    
    See Also:
    ITile.feature(), ActionsComplex.descend(IGame)
  - Kick
```
public static IAction Kick(Direction dir)
```
    Kick in the given direction. Note that you can't do this with hurt legs, when trapped or when stressed or worse.
    
    See Also:
    ActionsComplex.kick(IGame, Direction), IPlayer.isStressed(), IPlayer.hasHurtLegs()
  - Close
```
public static IAction Close(Direction dir)
```
    Close a door
  - Open
```
public static IAction Open(Direction dir)
```
    Open a door
  - Pray
```
public static IAction Pray()
```
    #pray action.
    
    See Also:
    IGame.canPray(), ActionsComplex.pray(IGame)
  - EngraveOverwriting
```
public static IAction EngraveOverwriting(Character slot,
                         String engraving)
```
    Engrave action appending to the current engraving (if prompted).
    
    Parameters:
    slot - Inventory slot to engrave with. Use '-' to engrave with fingers.
    engraving - String to engrave
    See Also:
    IGame.canEngrave(), ITile.isEngravable()
  - EngraveAppending
```
public static IAction EngraveAppending(Character slot,
                       String engraving)
```
    Engrave action overwriting the current engraving (if prompted).
    
    Parameters:
    slot - Inventory slot to engrave with. Use '-' to engrave with fingers.
    engraving - String to engrave
    See Also:
    IGame.canEngrave(), ITile.isEngravable()
  - Apply
```
public static IAction Apply(Character slot)
```
    Apply item at given inventory slot. For handling containers and direction prompts use TakeOut, PutIn or ApplyAt.
    
    See Also:
    IPlayer.hasHands(), TakeOut(java.lang.Character, java.lang.String), PutIn(java.lang.Character, java.lang.Character, java.lang.Long), ApplyAt(Character, Direction), ActionsComplex.unbag(IGame, java.util.Map.Entry)
  - TakeOut
```
public static IAction TakeOut(Character bagSlot,
              String itemLabel)
```
    Take out all of item with label itemLabel from container at bagSlot.
    
    Parameters:
    bagSlot - can be '.' for looting containers on the ground.
    See Also:
    ActionsComplex.unbag(IGame, java.util.Map.Entry)
  - TakeOut
```
public static IAction TakeOut(Character bagSlot,
              String itemLabel,
              Long amount)
```
    Take out amount of item with label itemLabel from container at bagSlot.
    
    Parameters:
    bagSlot - can be '.' for looting containers on the ground.
    See Also:
    ActionsComplex.unbag(IGame, java.util.Map.Entry)
  - PutIn
```
public static IAction PutIn(Character bagSlot,
            Character itemSlot,
            Long amount)
```
    Put amount of item at itemSlot into the container at bagSlot.
  - PutIn
```
public static IAction PutIn(Character bagSlot,
            Character itemSlot)
```
    Put all of item at itemSlot into the container at bagSlot.
  - ApplyAt
```
public static IAction ApplyAt(Character slot,
              Direction dir)
```
    Apply the item in the given direction (if prompted). For use with a key, a pickaxe... With a pickaxe wielding it explicitly first is strongly recommended (anything can happen during the wielding).
  - ForceLock
```
public static IAction ForceLock()
```
    Use current weapon to force a lock on a container.
  - Unlock
```
public static IAction Unlock(Character slot,
             Direction dir)
```
    Use key, lockpick or credit card at slot to unlock a door.
  - Wield
```
public static IAction Wield(Character slot)
```
    Wield item at slot as a weapon.
    
    See Also:
    ActionsComplex.wield(IGame, Character)
  - Wear
```
public static IAction Wear(Character slot)
```
    Wear item at slot (for armor).
    
    See Also:
    ActionsComplex.makeUse(IGame, Character)
  - PutOn
```
public static IAction PutOn(Character slot)
```
    Put on item at slot (for jewelry).
    
    See Also:
    ActionsComplex.makeUse(IGame, Character)
  - TakeOff
```
public static IAction TakeOff(Character slot)
```
    Take off item at slot (for armor).
    
    See Also:
    ActionsComplex.removeUse(IGame, Character)
  - Remove
```
public static IAction Remove(Character slot)
```
    Remove item at slot (for jewelry).
    
    See Also:
    ActionsComplex.removeUse(IGame, Character)
  - Drop
```
public static IAction Drop(Character slot)
```
    Drop one of item at slot.
  - Drop
```
public static IAction Drop(Character slot,
           Long num)
```
    Drop a specific amount of item at slot.
    
    See Also:
    IItem.quantity()
  - PickUp
```
public static IAction PickUp(List<String> labels)
```
    Pick up all items in the list by label. It is currently not possible to pick up specific amounts (but you can drop any amount after pick up).
    
    See Also:
    IItem.label()
  - PickUp
```
public static IAction PickUp(String label)
```
    Pick up all of item by label. It is currently not possible to pick up specific amounts (but you can drop any amount after pick up).
    
    See Also:
    IItem.label()
  - Enhance
```
public static IAction Enhance()
```
    Enhance specific skills. IEnhanceWhatHandler should be registered beforehand (or use EnhanceAll).
    
    See Also:
    IEnhanceWhatHandler, IPlayer.canEnhance(), ActionsComplex.enhanceAll(IGame)
  - Read
```
public static IAction Read(Character slot)
```
    Read scrolls or spellbooks.
  - Sit
```
public static IAction Sit()
```
    Sit down (only useful on thrones).
    
    See Also:
    ITile.feature()
  - Eat
```
public static IAction Eat(Character slot)
```
    Eat item at slot.
  - Eat
```
public static IAction Eat(String label)
```
    Eat item from the ground by label.
  - Quaff
```
public static IAction Quaff(Character slot)
```
    Drink a potion at slot.
  - Offer
```
public static IAction Offer(Character slot)
```
    Offer item at slot as sacrifice.
    
    See Also:
    ITile.feature()
  - Offer
```
public static IAction Offer(String label)
```
    Offer item from the ground by label.
    
    See Also:
    ITile.feature()
  - Dip
```
public static IAction Dip(Character itemSlot,
          Character potionSlot)
```
    Dip item at itemSlot into potion at potionSlot (or a fountain if it is '.')
  - Throw
```
public static IAction Throw(Character slot,
            Direction dir)
```
    Throw item at slot in direction dir.
  - Wipe
```
public static IAction Wipe()
```
    Wipe own face.
    
    See Also:
    IPlayer.isBlindExternally(), IPlayer.hasHands()
  - ZapWand
```
public static IAction ZapWand(Character slot)
```
    Zap a known non-directional wand.
    
    See Also:
    ZapWandAt(Character, Direction)
  - ZapWandAt
```
public static IAction ZapWandAt(Character slot,
                Direction dir)
```
    Zap a wand in the given direction (if prompted for a direction).
  - Rub
```
public static IAction Rub(Character slot)
```
    Rub a lamp at slot.
  - Chat
```
public static IAction Chat(Direction dir)
```
    Chat with monster at direction dir.
    
    See Also:
    Contribute(Direction, Long)
  - Contribute
```
public static IAction Contribute(Direction dir,
                 Long amount)
```
    Offer a donation to a priest at dir.
    
    Parameters:
    amount - Amount of gold to donate

Class Actions

Method Summary

Methods inherited from class Object

Method Detail

Attack

Move

Search

Search

Wait

Ascend

Descend

Kick

Close

Open

Pray

EngraveOverwriting

EngraveAppending

Apply

TakeOut

TakeOut

PutIn

PutIn

ApplyAt

ForceLock

Unlock

Wield

Wear

PutOn

TakeOff

Remove

Drop

Drop

PickUp

PickUp

Enhance

Read

Sit

Eat

Eat

Quaff

Offer

Offer

Dip

Throw

Wipe

ZapWand

ZapWandAt

Rub

Chat

Contribute