Game.LambdaHack.Common.Item

Weapons, treasure and all the other items in the game. No operation in this module involves the state or any of our custom monads.

The 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 actor possesion 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

jlid :: !LevelId

the level on which item was created

jsymbol :: !Char

map symbol

jname :: !Text

generic name

jflavour :: !Flavour

flavour

jfeature :: ![Feature]

public properties

jweight :: !Int

weight in grams, obvious enough

Instances

Eq Item

Show Item

Generic Item

Binary Item

Hashable Item

type Rep Item

seedToAspectsEffects :: ItemSeed -> ItemKind -> AbsDepth -> AbsDepth -> ItemAspectEffect

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.Ix ItemKindIx

Binary ItemKindIx

Hashable ItemKindIx

type DiscoveryKind = EM.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.

data ItemSeed

A seed for rolling aspects and effects of an item Clients have partial knowledge of how item ids map to the seeds. They gain knowledge by identifying items.

Instances

Enum ItemSeed

Eq ItemSeed

Ord ItemSeed

Show ItemSeed

Binary ItemSeed

Hashable ItemSeed

data ItemAspectEffect

Constructors

ItemAspectEffect

Fields

jaspects :: ![Aspect Int]

the aspects of the item

jeffects :: ![Effect]

the effects when activated

Instances

Eq ItemAspectEffect

Show ItemAspectEffect

Generic ItemAspectEffect

Binary ItemAspectEffect

Hashable ItemAspectEffect

type Rep ItemAspectEffect

type DiscoveryEffect = EM.EnumMap ItemId ItemAspectEffect

The map of item ids to item aspects and effects. The full map is known by the server.

data ItemFull

Constructors

ItemFull

Fields

itemBase :: !Item

itemK :: !Int

itemTimer :: !ItemTimer

itemDisco :: !(Maybe ItemDisco)

Instances

Show ItemFull

data ItemDisco

Constructors

ItemDisco

Fields

itemKindId :: !(Id ItemKind)

itemKind :: !ItemKind

itemAE :: !(Maybe ItemAspectEffect)

Instances

Show ItemDisco

itemNoDisco :: (Item, Int) -> ItemFull

itemNoAE :: ItemFull -> ItemFull

Inventory management types

type ItemTimer = [Time]

type ItemQuant = (Int, ItemTimer)

type ItemBag = EM.EnumMap ItemId ItemQuant

type ItemDict = EM.EnumMap ItemId Item

All items in the dungeon (including in actor inventories), indexed by item identifier.

type ItemKnown = (ItemKindIx, ItemAspectEffect)

The essential item properties, used for the ItemRev hash table from items to their ids, needed to assign ids to newly generated items. All the other meaningul properties can be derived from the two. Note that jlid is not meaningful; it gets forgotten if items from different levels roll the same random properties and so are merged.