Game.LambdaHack.Client.UI.Overlay

Screen overlays.

AttrString

type AttrString = [AttrCharW32]

String of colourful text. End of line characters permitted.

blankAttrString :: Int -> AttrString

textToAS :: Text -> AttrString

textFgToAS :: Color -> Text -> AttrString

stringToAS :: String -> AttrString

(<+:>) :: AttrString -> AttrString -> AttrString infixr 6

(<\:>) :: AttrString -> AttrString -> AttrString infixr 6

AttrLine

data AttrLine

Line of colourful text. End of line characters forbidden.

Instances

Eq AttrLine

Defined in Game.LambdaHack.Client.UI.Overlay

Methods

(==) :: AttrLine -> AttrLine -> Bool

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

Show AttrLine

Defined in Game.LambdaHack.Client.UI.Overlay

Methods

showsPrec :: Int -> AttrLine -> ShowS

show :: AttrLine -> String

showList :: [AttrLine] -> ShowS

attrLine :: AttrLine -> AttrString

emptyAttrLine :: AttrLine

attrStringToAL :: AttrString -> AttrLine

firstParagraph :: AttrString -> AttrLine

linesAttr :: AttrString -> [AttrLine]

textToAL :: Text -> AttrLine

textFgToAL :: Color -> Text -> AttrLine

stringToAL :: String -> AttrLine

splitAttrString :: Int -> Int -> AttrString -> [AttrLine]

Split a string into lines. Avoids breaking the line at a character other than space. Remove space characters from the starts and ends of created lines. Newlines are respected.

Note that we only split wrt White space, nothing else, and the width, in the first argument, is calculated in characters, not in UI (mono font) coordinates, so that taking and dropping characters is performed correctly.

indentSplitAttrString :: Int -> AttrString -> [AttrLine]

indentSplitAttrString2 :: Bool -> Int -> AttrString -> [AttrLine]

Overlay

type Overlay = [(PointUI, AttrLine)]

A series of screen lines with start positions at which they should be overlayed over the base frame or a blank screen, depending on context. The position point is represented as in integer that is an index into the frame character array. The lines either fit the width of the screen or are intended for truncation when displayed. The start positions of lines may fall outside the length of the screen, too, unlike in SingleFrame. Then they are simply not shown.

offsetOverlay :: [AttrLine] -> Overlay

offsetOverlayX :: [(Int, AttrLine)] -> Overlay

updateLine :: Int -> (Int -> AttrString -> AttrString) -> Overlay -> Overlay

Internal operations

splitAttrPhrase :: Int -> Int -> AttrLine -> [AttrLine]