Game.LambdaHack.Client.UI.Frame

Screen frames.

Note that PointArray.Array here represents a screen frame and so screen positions are denoted by Point, contrary to the convention that Point refers to game map coordinates, as outlined in description of PointSquare that should normally be used in that role.

Documentation

data ColorMode

Color mode for the display.

Constructors

ColorFull

normal, with full colours

ColorBW

black and white only

Instances

Eq ColorMode

Defined in Game.LambdaHack.Client.UI.Frame

Methods

(==) :: ColorMode -> ColorMode -> Bool

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

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

newtype FrameBase

Action that results in a base frame, to be modified further.

Constructors

FrameBase

Fields

• unFrameBase :: forall s. ST s (Mutable Vector s Word32)

type Frame = ((FrameBase, FrameForall), (OverlaySpace, OverlaySpace, OverlaySpace))

A frame, that is, a base frame and all its modifications.

type PreFrame3 = (PreFrame, (OverlaySpace, OverlaySpace, OverlaySpace))

Components of a frame, before it's decided if the first can be overwritten in-place or needs to be copied.

type PreFrames3 = [Maybe PreFrame3]

Sequence of screen frames, including delays. Potentially based on a single base frame.

type PreFrame = (Vector Word32, FrameForall)

A simpler variant of PreFrame3.

type PreFrames = [Maybe PreFrame]

A simpler variant of PreFrames3.

data SingleFrame

A frame that is padded to fill the whole screen with optional overlays to display in proportional, square and monospace fonts.

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

See the description of PointSquare for explanation of why screen coordinates in singleArray are Point even though they should be PointSquare.

Constructors

SingleFrame

Fields

• singleArray :: Array AttrCharW32
• singlePropOverlay :: OverlaySpace
• singleSquareOverlay :: OverlaySpace
• singleMonoOverlay :: OverlaySpace

Instances

Show SingleFrame

Defined in Game.LambdaHack.Client.UI.Frame

Methods

showsPrec :: Int -> SingleFrame -> ShowS

show :: SingleFrame -> String

showList :: [SingleFrame] -> ShowS

Eq SingleFrame

Defined in Game.LambdaHack.Client.UI.Frame

Methods

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

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

type OverlaySpace = [(PointUI, AttrString)]

blankSingleFrame :: ScreenContent -> SingleFrame

truncateOverlay :: Bool -> Int -> Int -> Bool -> Int -> Bool -> Overlay -> OverlaySpace

Truncate the overlay: for each line, if it's too long, it's truncated and if there are too many lines, excess is dropped and warning is appended. The width, in the second argument, is calculated in characters, not in UI (mono font) coordinates, so that taking and dropping characters is performed correctly.

overlayFrame :: Int -> OverlaySpace -> PreFrame -> PreFrame

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.

Internal operations

truncateAttrLine :: Bool -> Int -> Int -> AttrLine -> AttrString

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