Game.LambdaHack.Client.UI.HandleHelperM

Helper functions for both inventory management and human commands.

Documentation

data FailError

Message describing the cause of failure of human command.

Instances

Eq FailError

Defined in Game.LambdaHack.Client.UI.HandleHelperM

Methods

(==) :: FailError -> FailError -> Bool

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

Show FailError

Defined in Game.LambdaHack.Client.UI.HandleHelperM

Methods

showsPrec :: Int -> FailError -> ShowS

show :: FailError -> String

showList :: [FailError] -> ShowS

showFailError :: FailError -> Text

type MError = Maybe FailError

mergeMError :: MError -> MError -> MError

type FailOrCmd a = Either FailError a

failWith :: MonadClientUI m => Text -> m (FailOrCmd a)

failSer :: MonadClientUI m => ReqFailure -> m (FailOrCmd a)

failMsg :: MonadClientUI m => Text -> m MError

weaveJust :: FailOrCmd a -> Either MError a

pointmanCycle :: MonadClientUI m => ActorId -> Bool -> Direction -> m MError

Switches current pointman to the previous in the whole dungeon, wrapping.

pointmanCycleLevel :: MonadClientUI m => ActorId -> Bool -> Direction -> m MError

Switches current pointman to the next on the level, if any, wrapping.

partyAfterLeader :: MonadClientUI m => ActorId -> m [(ActorId, Actor, ActorUI)]

pickLeader :: MonadClientUI m => Bool -> ActorId -> m Bool

Select a faction leader. False, if nothing to do.

doLook :: MonadClientUI m => m ()

Perform look around in the current position of the xhair. Does nothing outside aiming mode.

pickLeaderWithPointer :: MonadClientUI m => ActorId -> m MError

itemOverlay :: MonadClientUI m => [(ItemId, ItemQuant)] -> ItemDialogMode -> m OKX

skillsOverlay :: MonadClientUI m => ActorId -> m OKX

placesFromState :: ContentData PlaceKind -> Bool -> State -> EnumMap (ContentId PlaceKind) (EnumSet LevelId, Int, Int, Int)

Extract whole-dungeon statistics for each place kind, counting the number of occurrences of each type of PlaceEntry for the given place kind and gathering the set of levels on which any entry for that place kind can be found.

placesOverlay :: MonadClientUI m => m OKX

factionsFromState :: ItemRoles -> State -> [(FactionId, Faction)]

factionsOverlay :: MonadClientUI m => m OKX

describeMode :: MonadClientUI m => Bool -> ContentId ModeKind -> m (EnumMap DisplayFont Overlay)

modesOverlay :: MonadClientUI m => m OKX

pickNumber :: MonadClientUI m => Bool -> Int -> m (Either MError Int)

guardItemSize :: Actor -> State -> Int

lookAtItems

Arguments

:: MonadClientUI m

=> Bool

can be seen right now?

-> Point

position to describe

-> LevelId

level the position is at

-> Maybe ActorId

the actor that looks

-> Maybe (Part, Bool)

pronoun for the big actor at the position, if any, and whether the big actor is alive

-> m (Text, Maybe Person)

Produces a textual description of items at a position.

lookAtStash :: MonadClientUI m => Point -> LevelId -> m Text

lookAtPosition :: MonadClientUI m => Point -> LevelId -> m [(MsgClassShow, Text)]

Produces a textual description of everything at the requested level's position.

displayOneMenuItem :: MonadClientUI m => (MenuSlot -> m OKX) -> [KM] -> Int -> MenuSlot -> m KM

okxItemLoreInline :: MonadClientUI m => (ItemId -> ItemFull -> Int -> Text) -> Int -> ItemDialogMode -> [(ItemId, ItemQuant)] -> Int -> MenuSlot -> m OKX

okxItemLoreMsg :: MonadClientUI m => (ItemId -> ItemFull -> Int -> Text) -> Int -> ItemDialogMode -> [(ItemId, ItemQuant)] -> MenuSlot -> m OKX

itemDescOverlays :: MonadClientUI m => Bool -> Int -> ItemDialogMode -> ItemId -> ItemQuant -> ItemFull -> Int -> m (Overlay, Overlay)

cycleLore :: MonadClientUI m => [m KM] -> [m KM] -> m ()

spoilsBlurb :: Text -> Int -> Int -> Text

ppContainerWownW :: MonadClientUI m => (ActorId -> m Part) -> Bool -> Container -> m [Part]

nxtGameMode :: COps -> Int -> (ContentId ModeKind, ModeKind)

Internal operations

itemOverlayFromState :: LevelId -> [(ItemId, ItemQuant)] -> Bool -> CCUI -> FactionId -> DiscoveryBenefit -> FontSetup -> State -> OKX

lookAtTile

Arguments

:: MonadClientUI m

=> Bool

can be seen right now?

-> Point

position to describe

-> LevelId

level the position is at

-> Maybe ActorId

the actor that looks

-> Maybe Person

grammatical person of the item(s), if any

-> m (Text, Text, [(Int, Part)])

Produces a textual description of the tile at a position.

lookAtActors

Arguments

:: MonadClientUI m

=> Point

position to describe

-> LevelId

level the position is at

-> m (Text, Maybe (Part, Bool), Text)

Produces a textual description of actors at a position.

guardItemVerbs :: Actor -> State -> [Part]