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

memberCycle :: (MonadClient m, MonadClientUI m) => Bool -> Direction -> m MError

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

memberCycleLevel :: (MonadClient m, MonadClientUI m) => Bool -> Direction -> m MError

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

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

pickLeader :: (MonadClient m, MonadClientUI m) => Bool -> ActorId -> m Bool

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

pickLeaderWithPointer :: (MonadClient m, MonadClientUI m) => m MError

itemOverlay :: MonadClientUI m => SingleItemSlots -> LevelId -> ItemBag -> Bool -> m OKX

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

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

placesOverlay :: MonadClientUI m => m OKX

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

modesOverlay :: MonadClientUI m => m OKX

pickNumber :: (MonadClient m, 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

-> 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 => LevelId -> Point -> m Text

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

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

displayItemLore :: (MonadClient m, MonadClientUI m) => ItemBag -> Int -> (ItemId -> ItemFull -> Int -> Text) -> Int -> SingleItemSlots -> m Bool

displayItemLorePointedAt :: (MonadClient m, MonadClientUI m) => ItemBag -> Int -> (ItemId -> ItemFull -> Int -> Text) -> Int -> SingleItemSlots -> Bool -> m KM

viewLoreItems :: (MonadClient m, MonadClientUI m) => String -> SingleItemSlots -> ItemBag -> Text -> (Int -> SingleItemSlots -> m Bool) -> Bool -> m KM

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

lookAtTile

Arguments

:: MonadClientUI m

=> Bool

can be seen right now?

-> Point

position to describe

-> ActorId

the actor that looks

-> LevelId

level the position is at

-> 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]