Game.LambdaHack.Client.UI.Overlay

Screen overlays.

DisplayFont

data DisplayFont

Three types of fonts used in the UI. Overlays (layers, more or less) in proportional font are overwritten by layers in square font, which are overwritten by layers in mono font. All overlays overwrite the rendering of the game map, which is the underlying basic UI frame, comprised of square font glyps.

This type needs to be kept abstract to ensure that frontend-enforced or user config-enforced font assignments in FontSetup (e.g., stating that the supposedly proportional font is overriden to be the square font) can't be ignored. Otherwise a programmer could use arbirary DisplayFont, instead of the one taken from FontSetup, and so, e.g., calculating the width of an overlay so constructed in order to decide where another overlay can start would be inconsistent what what font is really eventually used when rendering.

Note that the order of constructors has limited effect, but it illustrates how overwriting is explicitly implemented in frontends that support all fonts.

Instances

Enum DisplayFont

Defined in Game.LambdaHack.Client.UI.Overlay

Methods

succ :: DisplayFont -> DisplayFont

pred :: DisplayFont -> DisplayFont

toEnum :: Int -> DisplayFont

fromEnum :: DisplayFont -> Int

enumFrom :: DisplayFont -> [DisplayFont]

enumFromThen :: DisplayFont -> DisplayFont -> [DisplayFont]

enumFromTo :: DisplayFont -> DisplayFont -> [DisplayFont]

enumFromThenTo :: DisplayFont -> DisplayFont -> DisplayFont -> [DisplayFont]

Show DisplayFont

Defined in Game.LambdaHack.Client.UI.Overlay

Methods

showsPrec :: Int -> DisplayFont -> ShowS

show :: DisplayFont -> String

showList :: [DisplayFont] -> ShowS

Eq DisplayFont

Defined in Game.LambdaHack.Client.UI.Overlay

Methods

(==) :: DisplayFont -> DisplayFont -> Bool

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

isPropFont :: DisplayFont -> Bool

isSquareFont :: DisplayFont -> Bool

isMonoFont :: DisplayFont -> Bool

textSize :: DisplayFont -> [a] -> Int

FontSetup

data FontSetup

Constructors

FontSetup

Fields

• squareFont :: DisplayFont
• monoFont :: DisplayFont
• propFont :: DisplayFont

Instances

Show FontSetup

Defined in Game.LambdaHack.Client.UI.Overlay

Methods

showsPrec :: Int -> FontSetup -> ShowS

show :: FontSetup -> String

showList :: [FontSetup] -> ShowS

Eq FontSetup

Defined in Game.LambdaHack.Client.UI.Overlay

Methods

(==) :: FontSetup -> FontSetup -> Bool

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

multiFontSetup :: FontSetup

singleFontSetup :: FontSetup

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

attrStringToString :: AttrString -> String

Transform AttrString type to String.

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

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

AttrLine

data AttrLine

Line of colourful text. End of line characters forbidden. Trailing White space forbidden.

Instances

Show AttrLine

Defined in Game.LambdaHack.Client.UI.Overlay

Methods

showsPrec :: Int -> AttrLine -> ShowS

show :: AttrLine -> String

showList :: [AttrLine] -> ShowS

Eq AttrLine

Defined in Game.LambdaHack.Client.UI.Overlay

Methods

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

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

attrLine :: AttrLine -> AttrString

emptyAttrLine :: AttrLine

attrStringToAL :: AttrString -> AttrLine

firstParagraph :: AttrString -> AttrLine

textToAL :: Text -> AttrLine

textFgToAL :: Color -> Text -> AttrLine

stringToAL :: String -> AttrLine

linesAttr :: AttrString -> [AttrLine]

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

Split a string into lines. Avoid breaking the line at a character other than space. Remove the spaces on which lines are broken, keep other spaces. In expensive assertions mode (dev debug mode) fail at trailing spaces, but keep leading spaces, e.g., to make distance from a text in another font. 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 :: DisplayFont -> 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.

xytranslateOverlay :: Int -> Int -> Overlay -> Overlay

xtranslateOverlay :: Int -> Overlay -> Overlay

ytranslateOverlay :: Int -> Overlay -> Overlay

offsetOverlay :: [AttrLine] -> Overlay

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

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

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

rectangleOfSpaces :: Int -> Int -> Overlay

maxYofOverlay :: Overlay -> Int

labDescOverlay :: DisplayFont -> Int -> AttrString -> (Overlay, Overlay)

Internal operations

nonbreakableRev :: [String]

isPrefixOfNonbreakable :: AttrString -> Bool

breakAtSpace :: AttrString -> (AttrString, AttrString)

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