Game.LambdaHack.ItemAction

Item UI code with the Action type and everything it depends on that is not already in Action.hs and EffectAction.hs. This file should not depend on Actions.hs. TODO: Add an export list and document after it's rewritten according to #17.

Documentation

inventory :: ActionFrame ()

Display inventory

getGroupItem

Arguments

:: [Item]

all objects in question

-> Object

name of the group

-> [Char]

accepted item symbols

-> String

prompt

-> String

how to refer to the collection of objects

-> Action Item

Let the player choose any item with a given group name. Note that this does not guarantee the chosen item belongs to the group, as the player can override the choice.

applyGroupItem

Arguments

:: ActorId

actor applying the item (is on current level)

-> Verb

how the applying is called

-> Item

the item to be applied

-> Action ()

playerApplyGroupItem :: Verb -> Object -> [Char] -> Action ()

projectGroupItem

Arguments

:: ActorId

actor projecting the item (is on current lvl)

-> Point

target location of the projectile

-> Verb

how the projecting is called

-> Item

the item to be projected

-> Action ()

playerProjectGroupItem :: Verb -> Object -> [Char] -> ActionFrame ()

playerProjectGI :: Verb -> Object -> [Char] -> ActionFrame ()

targetMonster :: TgtMode -> ActionFrame ()

Start the monster targeting mode. Cycle between monster targets.

targetFloor :: TgtMode -> ActionFrame ()

Start the floor targeting mode or reset the cursor location to the player.

setCursor :: TgtMode -> ActionFrame ()

Set, activate and display cursor information.

epsIncr :: Bool -> Action ()

Tweak the eps parameter of the targeting digital line.

endTargeting :: Bool -> Action ()

End targeting mode, accepting the current location or not.

endTargetingMsg :: Action ()

cancelCurrent :: ActionFrame () -> ActionFrame ()

Cancel something, e.g., targeting mode, resetting the cursor to the position of the player. Chosen target is not invalidated.

acceptCurrent :: ActionFrame () -> ActionFrame ()

Accept something, e.g., targeting mode, keeping cursor where it was. Or perform the default action, if nothing needs accepting.

clearCurrent :: Action ()

Clear current messages, show the next screen if any.

dropItem :: Action ()

Drop a single item.

removeOnlyFromInventory :: ActorId -> Item -> Point -> Action ()

removeFromInventory :: ActorId -> Item -> Point -> Action ()

Remove given item from an actor's inventory or floor. TODO: this is subtly wrong: if identical items are on the floor and in inventory, the floor one will be chosen, regardless of player intention. TODO: right now it ugly hacks (with the ploc) around removing items of dead heros/monsters. The subtle incorrectness helps here a lot, because items of dead heroes land on the floor, so we use them up in inventory, but remove them after use from the floor.

removeFromLoc :: Item -> Point -> Action Bool

Remove given item from the given location. Tell if successful.

actorPickupItem :: ActorId -> Action ()

pickupItem :: Action ()

allObjectsName :: String

getAnyItem

Arguments

:: String

prompt

-> [Item]

all items in question

-> String

how to refer to the collection of items

-> Action Item

Let the player choose any item from a list of items.

data ItemDialogState

Constructors

INone

ISuitable

IAll

Instances

Eq ItemDialogState

getItem

Arguments

:: String

prompt message

-> (Item -> Bool)

which items to consider suitable

-> String

how to describe suitable items

-> [Item]

all items in question

-> String

how to refer to the collection of items

-> Action Item

Let the player choose a single, preferably suitable, item from a list of items.