Game.LambdaHack.Client.UI.Frame

Screen frames.

Documentation

type FrameST s = Mutable Vector s Word32 -> ST s ()

newtype FrameForall

Efficiently composable representation of an operation on a frame, that is, on a mutable vector. When the composite operation is eventually performed, the vector is frozen to become a SingleFrame.

Constructors

FrameForall

Fields

• unFrameForall :: forall s. FrameST s

writeLine :: Int -> AttrLine -> FrameForall

Representation of an operation of overwriting a frame with a single line at the given row.

newtype SingleFrame

An overlay that fits on the screen (or is meant to be truncated on display) and is padded to fill the whole screen and is displayed as a single game screen frame.

Note that we don't provide a list of color-highlighed positions separately, because overlays need to obscure not only map, but the highlights as well.

Constructors

SingleFrame

Fields

• singleFrame :: Array AttrCharW32

Instances

Eq SingleFrame

Defined in Game.LambdaHack.Client.UI.Frame

Methods

(==) :: SingleFrame -> SingleFrame -> Bool

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

Show SingleFrame

Defined in Game.LambdaHack.Client.UI.Frame

Methods

showsPrec :: Int -> SingleFrame -> ShowS

show :: SingleFrame -> String

showList :: [SingleFrame] -> ShowS

type Frames = [Maybe FrameForall]

Sequences of screen frames, including delays.

blankSingleFrame :: SingleFrame

overlayFrame :: IntOverlay -> FrameForall -> FrameForall

Overlays either the game map only or the whole empty screen frame. We assume the lines of the overlay are not too long nor too many.

overlayFrameWithLines :: Bool -> Overlay -> FrameForall -> FrameForall

Internal operations

truncateAttrLine :: X -> AttrLine -> X -> AttrLine

Add a space at the message end, for display overlayed over the level map. Also trim (do not wrap!) too long lines.