LambdaHack-0.2.6: A roguelike game engine in early and active development

Safe Haskell	None

Game.LambdaHack.Msg

Description

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

Synopsis

Documentation

type Msg = String Source

The type of a single message.

moreMsg :: Msg Source

The "press something to see more" mark.

yesnoMsg :: Msg Source

The confirmation request message.

padMsg :: X -> String -> String Source

Add spaces at the message end, for display overlayed over the level map. Also trims (does not wrap!) too long lines.

data Report Source

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

Instances

Show Report
Binary Report

emptyReport :: Report Source

Empty set of messages.

nullReport :: Report -> Bool Source

Test if the set of messages is empty.

singletonReport :: Msg -> Report Source

Construct a singleton set of messages.

addMsg :: Report -> Msg -> Report Source

Add message to the end of report.

splitReport :: Report -> [String]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 -> String Source

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

data History Source

The history of reports.

Instances

Show History
Binary History

emptyHistory :: History Source

Empty history of reports.

singletonHistory :: Report -> History Source

Construct a singleton history of reports.

addReport :: Report -> History -> History Source

Add a report to history, handling repetitions.

renderHistory :: History -> Overlay Source

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

takeHistory :: Int -> History -> History Source

Take the given prefix of reports from a history.

type Overlay = [String]Source

A screenful of text lines. When displayed, they are trimmed, not wrapped and any lines below the lower screen edge are not visible.

splitOverlay :: Y -> Overlay -> [Overlay]Source

Split an overlay into overlays that fit on the screen.

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

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