Safe Haskell	None
Language	Haskell2010

Game.LambdaHack.Client.UI.Slideshow

Contents

Internal operations

Description

Slideshows.

Synopsis

type FontOverlayMap = EnumMap DisplayFont Overlay
maxYofFontOverlayMap :: FontOverlayMap -> Int
type KeyOrSlot = Either KM SlotChar
data ButtonWidth = ButtonWidth {
- buttonFont :: DisplayFont
- buttonWidth :: Int
}
type KYX = (KeyOrSlot, (PointUI, ButtonWidth))
xytranslateKXY :: Int -> Int -> KYX -> KYX
xtranslateKXY :: Int -> KYX -> KYX
ytranslateKXY :: Int -> KYX -> KYX
yrenumberKXY :: Int -> KYX -> KYX
type OKX = (FontOverlayMap, [KYX])
emptyOKX :: OKX
xytranslateOKX :: Int -> Int -> OKX -> OKX
sideBySideOKX :: Int -> Int -> OKX -> OKX -> OKX
labDescOKX :: DisplayFont -> DisplayFont -> [(AttrString, AttrString, KeyOrSlot)] -> OKX
data Slideshow
emptySlideshow :: Slideshow
unsnoc :: Slideshow -> Maybe (Slideshow, OKX)
toSlideshow :: FontSetup -> [OKX] -> Slideshow
attrLinesToFontMap :: [(DisplayFont, [AttrLine])] -> FontOverlayMap
menuToSlideshow :: OKX -> Slideshow
wrapOKX :: DisplayFont -> Int -> Int -> Int -> [(KM, String)] -> (Overlay, [KYX])
splitOverlay :: FontSetup -> Int -> Int -> Int -> Report -> [KM] -> OKX -> Slideshow
splitOKX :: FontSetup -> Bool -> Int -> Int -> Int -> AttrString -> [KM] -> OKX -> [OKX]
highSlideshow :: FontSetup -> Int -> Int -> ScoreTable -> Int -> Text -> TimeZone -> Slideshow
keysOKX :: DisplayFont -> Int -> Int -> Int -> [KM] -> (Overlay, [KYX])
showTable :: TimeZone -> Int -> ScoreTable -> Int -> Int -> [AttrLine]
showNearbyScores :: TimeZone -> Int -> ScoreTable -> Int -> [[AttrLine]]

Documentation

type FontOverlayMap = EnumMap DisplayFont Overlay Source #

maxYofFontOverlayMap :: FontOverlayMap -> Int Source #

type KeyOrSlot = Either KM SlotChar Source #

data ButtonWidth Source #

Width of on-screen button text, expressed in characters, and so UI (mono font) width is deduced from the used font.

Constructors

ButtonWidth
Fields buttonFont :: DisplayFont buttonWidth :: Int

Instances

Instances details

Eq ButtonWidth Source #
Instance details Defined in Game.LambdaHack.Client.UI.Slideshow Methods (==) :: ButtonWidth -> ButtonWidth -> Bool # (/=) :: ButtonWidth -> ButtonWidth -> Bool #
Show ButtonWidth Source #
Instance details Defined in Game.LambdaHack.Client.UI.Slideshow Methods showsPrec :: Int -> ButtonWidth -> ShowS # show :: ButtonWidth -> String # showList :: [ButtonWidth] -> ShowS #

type KYX = (KeyOrSlot, (PointUI, ButtonWidth)) Source #

A key or an item slot label at a given position on the screen.

xytranslateKXY :: Int -> Int -> KYX -> KYX Source #

xtranslateKXY :: Int -> KYX -> KYX Source #

ytranslateKXY :: Int -> KYX -> KYX Source #

yrenumberKXY :: Int -> KYX -> KYX Source #

type OKX = (FontOverlayMap, [KYX]) Source #

An Overlay of text with an associated list of keys or slots that activate when the specified screen position is pointed at. The list should be sorted wrt rows and then columns.

emptyOKX :: OKX Source #

xytranslateOKX :: Int -> Int -> OKX -> OKX Source #

sideBySideOKX :: Int -> Int -> OKX -> OKX -> OKX Source #

labDescOKX :: DisplayFont -> DisplayFont -> [(AttrString, AttrString, KeyOrSlot)] -> OKX Source #

data Slideshow Source #

A list of active screenfulls to be shown one after another. Each screenful has an independent numbering of rows and columns.

Instances

Instances details

Eq Slideshow Source #
Instance details Defined in Game.LambdaHack.Client.UI.Slideshow Methods (==) :: Slideshow -> Slideshow -> Bool # (/=) :: Slideshow -> Slideshow -> Bool #
Show Slideshow Source #
Instance details Defined in Game.LambdaHack.Client.UI.Slideshow Methods showsPrec :: Int -> Slideshow -> ShowS # show :: Slideshow -> String # showList :: [Slideshow] -> ShowS #

emptySlideshow :: Slideshow Source #

unsnoc :: Slideshow -> Maybe (Slideshow, OKX) Source #

toSlideshow :: FontSetup -> [OKX] -> Slideshow Source #

attrLinesToFontMap :: [(DisplayFont, [AttrLine])] -> FontOverlayMap Source #

This appends vertically a list of blurbs into a single font overlay map. Not to be used if some blurbs need to be places overlapping vertically, e.g., when the square font symbol needs to be in the same line as the start of the descritpion of the denoted item or when mono font buttons need to be after a prompt.

menuToSlideshow :: OKX -> Slideshow Source #

wrapOKX :: DisplayFont -> Int -> Int -> Int -> [(KM, String)] -> (Overlay, [KYX]) Source #

splitOverlay :: FontSetup -> Int -> Int -> Int -> Report -> [KM] -> OKX -> Slideshow Source #

splitOKX :: FontSetup -> Bool -> Int -> Int -> Int -> AttrString -> [KM] -> OKX -> [OKX] Source #

highSlideshow Source #

Arguments

:: FontSetup
-> Int	width of the display area
-> Int	height of the display area
-> ScoreTable	current score table
-> Int	position of the current score in the table
-> Text	the name of the game mode
-> TimeZone	the timezone where the game is run
-> Slideshow

Generate a slideshow with the current and previous scores.

Internal operations

keysOKX :: DisplayFont -> Int -> Int -> Int -> [KM] -> (Overlay, [KYX]) Source #

showTable :: TimeZone -> Int -> ScoreTable -> Int -> Int -> [AttrLine] Source #

Show a screenful of the high scores table. Parameter entries is the number of (3-line) scores to be shown.

showNearbyScores :: TimeZone -> Int -> ScoreTable -> Int -> [[AttrLine]] Source #

Produce a couple of renderings of the high scores table.