Game.LambdaHack.Common.Item

Weapons, treasure and all the other items in the game.

Documentation

data Item

Game items in actor possesion or strewn around the dungeon. The information contained in this time is available to the player from the moment the item is first seen and is never mutated.

Some items are not created identified (IdentityCovered). Then they are presented as having a template kind that is really not their own, though usually close. Full kind information about item's kind is available through the ItemKindIx index once the item is identified and full information about the value of item's aspect record is available elsewhere (both IdentityObvious and IdentityCovered items may or may not need identification of their aspect record).

Constructors

Item

Fields

• jkind :: ItemIdentity

  the kind of the item, or an indiretion

• jfid :: Maybe FactionId

  the faction that created the item, if any

• jflavour :: Flavour

  flavour, always the real one, not hidden; people may not recognize shape, but they remember colour and old vs fancy look

Instances

Eq Item

Defined in Game.LambdaHack.Common.Item

Methods

(==) :: Item -> Item -> Bool

(/=) :: Item -> Item -> Bool

Show Item

Defined in Game.LambdaHack.Common.Item

Methods

showsPrec :: Int -> Item -> ShowS

show :: Item -> String

showList :: [Item] -> ShowS

Generic Item

Defined in Game.LambdaHack.Common.Item

Associated Types

type Rep Item :: Type -> Type

Methods

from :: Item -> Rep Item x

to :: Rep Item x -> Item

Binary Item

Defined in Game.LambdaHack.Common.Item

Methods

put :: Item -> Put

get :: Get Item

putList :: [Item] -> Put

Hashable Item

Defined in Game.LambdaHack.Common.Item

Methods

hashWithSalt :: Int -> Item -> Int

hash :: Item -> Int

type Rep Item

Defined in Game.LambdaHack.Common.Item

type Rep Item = D1 (MetaData "Item" "Game.LambdaHack.Common.Item" "LambdaHack-0.9.5.0-inplace" False) (C1 (MetaCons "Item" PrefixI True) (S1 (MetaSel (Just "jkind") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 ItemIdentity) :*: (S1 (MetaSel (Just "jfid") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 (Maybe FactionId)) :*: S1 (MetaSel (Just "jflavour") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Flavour))))

data ItemIdentity

Either the explicit obvious kind of the item or the kind it's hidden under, with the details covered under the index indirection.

Constructors

IdentityObvious (ContentId ItemKind)

IdentityCovered ItemKindIx (ContentId ItemKind)

Instances

Eq ItemIdentity

Defined in Game.LambdaHack.Common.Item

Methods

(==) :: ItemIdentity -> ItemIdentity -> Bool

(/=) :: ItemIdentity -> ItemIdentity -> Bool

Show ItemIdentity

Defined in Game.LambdaHack.Common.Item

Methods

showsPrec :: Int -> ItemIdentity -> ShowS

show :: ItemIdentity -> String

showList :: [ItemIdentity] -> ShowS

Generic ItemIdentity

Defined in Game.LambdaHack.Common.Item

Associated Types

type Rep ItemIdentity :: Type -> Type

Methods

from :: ItemIdentity -> Rep ItemIdentity x

to :: Rep ItemIdentity x -> ItemIdentity

Binary ItemIdentity

Defined in Game.LambdaHack.Common.Item

Methods

put :: ItemIdentity -> Put

get :: Get ItemIdentity

putList :: [ItemIdentity] -> Put

Hashable ItemIdentity

Defined in Game.LambdaHack.Common.Item

Methods

hashWithSalt :: Int -> ItemIdentity -> Int

hash :: ItemIdentity -> Int

type Rep ItemIdentity

Defined in Game.LambdaHack.Common.Item

type Rep ItemIdentity = D1 (MetaData "ItemIdentity" "Game.LambdaHack.Common.Item" "LambdaHack-0.9.5.0-inplace" False) (C1 (MetaCons "IdentityObvious" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 (ContentId ItemKind))) :+: C1 (MetaCons "IdentityCovered" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 ItemKindIx) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 (ContentId ItemKind))))

data ItemKindIx

An index of the kind identifier of an item. Clients have partial knowledge how these idexes map to kind ids. They gain knowledge by identifying items. The indexes and kind identifiers are 1-1.

Instances

Enum ItemKindIx

Defined in Game.LambdaHack.Common.Item

Methods

succ :: ItemKindIx -> ItemKindIx

pred :: ItemKindIx -> ItemKindIx

toEnum :: Int -> ItemKindIx

fromEnum :: ItemKindIx -> Int

enumFrom :: ItemKindIx -> [ItemKindIx]

enumFromThen :: ItemKindIx -> ItemKindIx -> [ItemKindIx]

enumFromTo :: ItemKindIx -> ItemKindIx -> [ItemKindIx]

enumFromThenTo :: ItemKindIx -> ItemKindIx -> ItemKindIx -> [ItemKindIx]

Eq ItemKindIx

Defined in Game.LambdaHack.Common.Item

Methods

(==) :: ItemKindIx -> ItemKindIx -> Bool

(/=) :: ItemKindIx -> ItemKindIx -> Bool

Ord ItemKindIx

Defined in Game.LambdaHack.Common.Item

Methods

compare :: ItemKindIx -> ItemKindIx -> Ordering

(<) :: ItemKindIx -> ItemKindIx -> Bool

(<=) :: ItemKindIx -> ItemKindIx -> Bool

(>) :: ItemKindIx -> ItemKindIx -> Bool

(>=) :: ItemKindIx -> ItemKindIx -> Bool

max :: ItemKindIx -> ItemKindIx -> ItemKindIx

min :: ItemKindIx -> ItemKindIx -> ItemKindIx

Show ItemKindIx

Defined in Game.LambdaHack.Common.Item

Methods

showsPrec :: Int -> ItemKindIx -> ShowS

show :: ItemKindIx -> String

showList :: [ItemKindIx] -> ShowS

Ix ItemKindIx

Defined in Game.LambdaHack.Common.Item

Methods

range :: (ItemKindIx, ItemKindIx) -> [ItemKindIx]

index :: (ItemKindIx, ItemKindIx) -> ItemKindIx -> Int

unsafeIndex :: (ItemKindIx, ItemKindIx) -> ItemKindIx -> Int

inRange :: (ItemKindIx, ItemKindIx) -> ItemKindIx -> Bool

rangeSize :: (ItemKindIx, ItemKindIx) -> Int

unsafeRangeSize :: (ItemKindIx, ItemKindIx) -> Int

Binary ItemKindIx

Defined in Game.LambdaHack.Common.Item

Methods

put :: ItemKindIx -> Put

get :: Get ItemKindIx

putList :: [ItemKindIx] -> Put

Hashable ItemKindIx

Defined in Game.LambdaHack.Common.Item

Methods

hashWithSalt :: Int -> ItemKindIx -> Int

hash :: ItemKindIx -> Int

data ItemDisco

The secret part of the information about an item. If a faction knows the aspect record of the item, this is the complete secret information. Items that don't need second identification (the kmConst flag is set) may be identified or not and both cases are OK (their display flavour will differ and that may be the point).

Constructors

ItemDiscoFull AspectRecord

ItemDiscoMean KindMean

Instances

Eq ItemDisco

Defined in Game.LambdaHack.Common.Item

Methods

(==) :: ItemDisco -> ItemDisco -> Bool

(/=) :: ItemDisco -> ItemDisco -> Bool

Ord ItemDisco

Defined in Game.LambdaHack.Common.Item

Methods

compare :: ItemDisco -> ItemDisco -> Ordering

(<) :: ItemDisco -> ItemDisco -> Bool

(<=) :: ItemDisco -> ItemDisco -> Bool

(>) :: ItemDisco -> ItemDisco -> Bool

(>=) :: ItemDisco -> ItemDisco -> Bool

max :: ItemDisco -> ItemDisco -> ItemDisco

min :: ItemDisco -> ItemDisco -> ItemDisco

Show ItemDisco

Defined in Game.LambdaHack.Common.Item

Methods

showsPrec :: Int -> ItemDisco -> ShowS

show :: ItemDisco -> String

showList :: [ItemDisco] -> ShowS

data ItemFull

Full information about an item.

Constructors

ItemFull

Fields

• itemBase :: Item
• itemKindId :: ContentId ItemKind
• itemKind :: ItemKind
• itemDisco :: ItemDisco
• itemSuspect :: Bool

Instances

Show ItemFull

Defined in Game.LambdaHack.Common.Item

Methods

showsPrec :: Int -> ItemFull -> ShowS

show :: ItemFull -> String

showList :: [ItemFull] -> ShowS

type ItemFullKit = (ItemFull, ItemQuant)

type DiscoveryKind = EnumMap ItemKindIx (ContentId ItemKind)

The map of item kind indexes to item kind ids. The full map, as known by the server, is 1-1. Because it's sparse and changes, we don't represent it as an (unboxed) vector, until it becomes a bottleneck (if ever, likely on JS, where only vectors are fast).

type DiscoveryAspect = EnumMap ItemId AspectRecord

The map of item ids to item aspect reocrd. The full map is known by the server.

type ItemIxMap = EnumMap ItemKindIx (EnumSet ItemId)

The map of item kind indexes to identifiers of items that have that kind. Used to update data about items when their kinds become known, e.g., AI item use benefit data.

data Benefit

The fields are, in order: 1. whether the item should be kept in equipment (not in pack nor stash) 2. the total benefit from picking the item up (to use or to put in equipment) 3. the benefit of applying the item to self 4. the (usually negative, for him) value of hitting a foe in melee with it 5. the (usually negative, for him) value of flinging the item at an opponent

Constructors

Benefit

Fields

• benInEqp :: Bool
• benPickup :: Double
• benApply :: Double
• benMelee :: Double
• benFling :: Double

Instances

Show Benefit

Defined in Game.LambdaHack.Common.Item

Methods

showsPrec :: Int -> Benefit -> ShowS

show :: Benefit -> String

showList :: [Benefit] -> ShowS

Generic Benefit

Defined in Game.LambdaHack.Common.Item

Associated Types

type Rep Benefit :: Type -> Type

Methods

from :: Benefit -> Rep Benefit x

to :: Rep Benefit x -> Benefit

Binary Benefit

Defined in Game.LambdaHack.Common.Item

Methods

put :: Benefit -> Put

get :: Get Benefit

putList :: [Benefit] -> Put

type Rep Benefit

Defined in Game.LambdaHack.Common.Item

type Rep Benefit = D1 (MetaData "Benefit" "Game.LambdaHack.Common.Item" "LambdaHack-0.9.5.0-inplace" False) (C1 (MetaCons "Benefit" PrefixI True) ((S1 (MetaSel (Just "benInEqp") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Bool) :*: S1 (MetaSel (Just "benPickup") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Double)) :*: (S1 (MetaSel (Just "benApply") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Double) :*: (S1 (MetaSel (Just "benMelee") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Double) :*: S1 (MetaSel (Just "benFling") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Double)))))

type DiscoveryBenefit = EnumMap ItemId Benefit

type ItemTimer = [Time]

type ItemQuant = (Int, ItemTimer)

Number of items in a bag, together with recharging timer, in case of items that need recharging, exists only temporarily or auto-activate at regular intervals.

type ItemBag = EnumMap ItemId ItemQuant

A bag of items, e.g., one of the stores of an actor or the items on a particular floor position or embedded in a particular map tile.

type ItemDict = EnumMap ItemId Item

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

itemToFull6 :: COps -> DiscoveryKind -> DiscoveryAspect -> ItemId -> Item -> ItemFull

aspectRecordFull :: ItemFull -> AspectRecord

strongestSlot :: DiscoveryBenefit -> EqpSlot -> [(ItemId, ItemFullKit)] -> [(Int, (ItemId, ItemFullKit))]

ncharges :: Time -> ItemFull -> ItemQuant -> Int

hasCharge :: Time -> ItemFull -> ItemQuant -> Bool

strongestMelee :: Bool -> Maybe DiscoveryBenefit -> Time -> [(ItemId, ItemFullKit)] -> [(Double, (Int, (ItemId, ItemFullKit)))]

unknownMeleeBonus :: [ItemFull] -> Bool

unknownSpeedBonus :: [ItemFull] -> Bool

conditionMeleeBonus :: [ItemFullKit] -> Int

conditionSpeedBonus :: [ItemFullKit] -> Int

armorHurtCalculation :: Bool -> Skills -> Skills -> Int

Internal operations

valueAtEqpSlot :: EqpSlot -> AspectRecord -> Int

unknownAspect :: (Aspect -> [Dice]) -> ItemFull -> Bool