Game.LambdaHack.Common.Item

Weapons, treasure and all the other items in the game. No operation in this module involves the State or Action type. TODO: Document after it's rethought and rewritten wrt separating inventory manangement and items proper.

Teh Item type

data ItemId

A unique identifier of an item in the dungeon.

Instances

Enum ItemId

Eq ItemId

Ord ItemId

Show ItemId

Binary ItemId

data Item

Game items in inventories or strewn around the dungeon. The fields jsymbol, jname and jflavour make it possible to refer to and draw an unidentified item. Full information about item is available through the jkindIx index as soon as the item is identified.

Constructors

Item

Fields

jkindIx :: !ItemKindIx

index pointing to the kind of the item

jsymbol :: !Char

individual map symbol

jname :: !Text

individual generic name

jflavour :: !Flavour

individual flavour

jeffect :: !(Effect Int)

the effect when activated

Instances

Eq Item

Ord Item

Show Item

Generic Item

Binary Item

Hashable Item

jkind :: Discovery -> Item -> Maybe (Id ItemKind)

Recover a kind id of an item, if identified.

buildItem :: FlavourMap -> DiscoRev -> Id ItemKind -> ItemKind -> Effect Int -> Item

Build an item with the given stats.

newItem :: Ops ItemKind -> FlavourMap -> DiscoRev -> Frequency Text -> Int -> Int -> Rnd (Item, Int, ItemKind)

Generate an item based on level.

viewItem :: Item -> (Char, Color)

Represent an item on the map.

Inventory search

strongestSearch :: [(ItemId, Item)] -> Maybe (Int, (ItemId, Item))

strongestSword :: COps -> [(ItemId, Item)] -> Maybe (Int, (ItemId, Item))

strongestRegen :: [(ItemId, Item)] -> Maybe (Int, (ItemId, Item))

The item discovery types

data ItemKindIx

An index of the kind id of an item. Clients have partial knowledge how these idexes map to kind ids. They gain knowledge by identifying items.

Instances

Enum ItemKindIx

Eq ItemKindIx

Ord ItemKindIx

Show ItemKindIx

Ix ItemKindIx

Binary ItemKindIx

Hashable ItemKindIx

type Discovery = EnumMap ItemKindIx (Id ItemKind)

The map of item kind indexes to item kind ids. The full map, as known by the server, is a bijection.

type DiscoRev = EnumMap (Id ItemKind) ItemKindIx

The reverse map to Discovery, needed for item creation.

serverDiscos :: Ops ItemKind -> Rnd (Discovery, DiscoRev)

The FlavourMap type

data FlavourMap

Flavours assigned by the server to item kinds, in this particular game.

Instances

Show FlavourMap

Binary FlavourMap

emptyFlavourMap :: FlavourMap

dungeonFlavourMap :: Ops ItemKind -> Rnd FlavourMap

Randomly chooses flavour for all item kinds for this game.

Textual description

partItem :: Ops ItemKind -> Discovery -> Item -> (Part, Part)

The part of speech describing the item.

partItemWs :: Ops ItemKind -> Discovery -> Int -> Item -> Part

partItemAW :: Ops ItemKind -> Discovery -> Item -> Part