LambdaHack- A roguelike game engine in early and active development

Safe HaskellNone



Game messages displayed on top of the screen for the player to read.



makePhrase :: [Part] -> TextSource

Re-exported English phrase creation functions, applied to default irregular word sets.

makeSentence :: [Part] -> TextSource

Re-exported English phrase creation functions, applied to default irregular word sets.

type Msg = TextSource

The type of a single message.

(<>) :: Text -> Text -> Text

Identical to append.

(<+>) :: Text -> Text -> Text

Separated by space unless one of them is empty (in which case just the non-empty one).

showT :: Show a => a -> TextSource

moreMsg :: MsgSource

The "press something to see more" mark.

yesnoMsg :: MsgSource

The confirmation request message.

truncateMsg :: X -> Text -> TextSource

Add a space at the message end, for display overlayed over the level map. Also trims (does not wrap!) too long lines. In case of newlines, displays only the first line, but marks the message as partial.

data Report Source

The type of a set of messages to show at the screen at once.


emptyReport :: ReportSource

Empty set of messages.

nullReport :: Report -> BoolSource

Test if the set of messages is empty.

singletonReport :: Msg -> ReportSource

Construct a singleton set of messages.

addMsg :: Report -> Msg -> ReportSource

Add message to the end of report.

splitReport :: Report -> [Text]Source

Split a messages into chunks that fit in one line. We assume the width of the messages line is the same as of level map.

renderReport :: Report -> TextSource

Render a report as a (possibly very long) string.

data History Source

The history of reports.

emptyHistory :: HistorySource

Empty history of reports.

singletonHistory :: Report -> HistorySource

Construct a singleton history of reports.

addReport :: Report -> History -> HistorySource

Add a report to history, handling repetitions.

renderHistory :: History -> OverlaySource

Render history as many lines of text, wrapping if necessary.

takeHistory :: Int -> History -> HistorySource

Take the given prefix of reports from a history.

type Overlay = [Text]Source

A series of screen lines that may or may not fit the width nor height of the screen. An overlay may be transformed by adding the first line and/or by splitting into a slideshow of smaller overlays.

stringByLocation :: X -> Y -> Overlay -> (Text, PointXY -> Maybe Char, Maybe Text)Source

Returns a function that looks up the characters in the string by position. Takes the width and height of the display plus the string. Returns also the message to print at the top and bottom.

data Slideshow Source

A few overlays, displayed one by one upon keypress. When displayed, they are trimmed, not wrapped and any lines below the lower screen edge are not visible.

splitOverlay :: Y -> Overlay -> Overlay -> SlideshowSource

Split an overlay into a slideshow in which each overlay, prefixed by msg and postfixed by moreMsg except for the last one, fits on the screen wrt height (but lines may still be too wide).

toSlideshow :: [Overlay] -> SlideshowSource

Declare the list of overlays to be fit for display on the screen. In particular, current Report is eiter empty or unimportant or contained in the overlays and if any vertical or horizontal trimming of the overlays happens, this is intended.