Game.LambdaHack.Client.UI.MonadClientUI

Client monad for interacting with a human through UI.

Client UI monad

class MonadClient m => MonadClientUI m where

The monad that gives the client access to UI operations.

Methods

getsSession :: (SessionUI -> a) -> m a

liftIO :: IO a -> m a

Instances

MonadClientUI (CliImplementation resp req)

data SessionUI

The information that is constant across a client playing session, including many consecutive games in a single session, but is completely disregarded and reset when a new playing session starts. This includes a frontend session and keybinding info.

Constructors

SessionUI

Fields

schanF :: !ChanFrontend

connection with the frontend

sbinding :: !Binding

binding of keys to commands

sescMVar :: !(Maybe (MVar ()))

sconfig :: !Config

Display and key input

data ColorMode

Color mode for the display.

Constructors

ColorFull

normal, with full colours

ColorBW

black+white only

promptGetKey :: MonadClientUI m => [KM] -> SingleFrame -> m KM

getKeyOverlayCommand :: MonadClientUI m => Maybe Bool -> Overlay -> m KM

Display an overlay and wait for a human player command.

getInitConfirms :: MonadClientUI m => ColorMode -> [KM] -> Slideshow -> m Bool

Display a slideshow, awaiting confirmation for each slide except the last.

displayFrame :: MonadClientUI m => Maybe SingleFrame -> m ()

displayDelay :: MonadClientUI m => m ()

displayActorStart :: MonadClientUI m => Actor -> Frames -> m ()

Push frames or delays to the frame queue. Additionally set sdisplayed. because animations not always happen after SfxActorStart on the leader's level (e.g., death can lead to leader change to another level mid-turn, and there could be melee and animations on that level at the same moment). Insert delays, so that the animations don't look rushed.

drawOverlay :: MonadClientUI m => Bool -> ColorMode -> Overlay -> m SingleFrame

Draw the current level with the overlay on top.

Assorted primitives

stopPlayBack :: MonadClientUI m => m ()

askConfig :: MonadClientUI m => m Config

askBinding :: MonadClientUI m => m Binding

Get the key binding.

syncFrames :: MonadClientUI m => m ()

Sync frames display with the frontend.

setFrontAutoYes :: MonadClientUI m => Bool -> m ()

tryTakeMVarSescMVar :: MonadClientUI m => m Bool

scoreToSlideshow :: MonadClientUI m => Int -> Status -> m Slideshow

getLeaderUI :: MonadClientUI m => m ActorId

getArenaUI :: MonadClientUI m => m LevelId

viewedLevel :: MonadClientUI m => m LevelId

targetDescLeader :: MonadClientUI m => ActorId -> m (Text, Maybe Text)

targetDescCursor :: MonadClientUI m => m (Text, Maybe Text)

leaderTgtToPos :: MonadClientUI m => m (Maybe Point)

leaderTgtAims :: MonadClientUI m => m (Either Text Int)

cursorToPos :: MonadClientUI m => m (Maybe Point)