Game.LambdaHack.Client.UI

Ways for the client to use player input via UI to produce server requests, based on the client's view (visualized for the player) of the game state.

Querying the human player

queryUI :: (MonadClient m, MonadClientUI m) => m RequestUI

Handle the move of a human player.

UI monad and session type

class MonadClientRead m => MonadClientUI m where

The monad that gives the client access to UI operations, but not to modifying client state.

Methods

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

modifySession :: (SessionUI -> SessionUI) -> m ()

updateClientLeader :: ActorId -> m ()

getCacheBfs :: ActorId -> m (Array BfsDistance)

getCachePath :: ActorId -> Point -> m (Maybe AndPath)

Instances

MonadClientUI CliImplementation

Defined in Implementation.MonadClientImplementation

Methods

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

modifySession :: (SessionUI -> SessionUI) -> CliImplementation ()

updateClientLeader :: ActorId -> CliImplementation ()

getCacheBfs :: ActorId -> CliImplementation (Array BfsDistance)

getCachePath :: ActorId -> Point -> CliImplementation (Maybe AndPath)

data SessionUI

The information that is used across a client playing session, including many consecutive games in a single session. Some of it is saved, some is reset when a new playing session starts. An important component is the frontend session.

Constructors

SessionUI

Fields

• sxhair :: Maybe Target

  the common xhair

• sactorUI :: ActorDictUI

  assigned actor UI presentations

• sitemUI :: ItemDictUI

  assigned item first seen level

• sslots :: ItemSlots

  map from slots to items

• slastItemMove :: Maybe (CStore, CStore)

  last item move stores

• schanF :: ChanFrontend

  connection with the frontend

• sccui :: CCUI

  UI client content

• sUIOptions :: UIOptions

  UI options as set by the player

• saimMode :: Maybe AimMode

  aiming mode

• sxhairMoused :: Bool

  last mouse aiming not vacuus

• sitemSel :: Maybe (ItemId, CStore, Bool)

  selected item, if any, it's store and whether to override suitability check

• sselected :: EnumSet ActorId

  the set of currently selected actors

• srunning :: Maybe RunParams

  parameters of the current run, if any

• shistory :: History

  history of messages

• spointer :: Point

  mouse pointer position

• slastRecord :: LastRecord

  state of key sequence recording

• slastPlay :: [KM]

  state of key sequence playback

• slastLost :: EnumSet ActorId

  actors that just got out of sight

• swaitTimes :: Int

  player just waited this many times

• smarkVision :: Bool

  mark leader and party FOV

• smarkSmell :: Bool

  mark smell, if the leader can smell

• smenuIxMap :: Map String Int

  indices of last used menu items

• sdisplayNeeded :: Bool

  current level needs displaying

• shintMode :: HintMode

  how to show keys hints when no messages

• sreportNull :: Bool

  whether no report created last UI turn or the report wiped out from screen

• sstart :: POSIXTime

  this session start time

• sgstart :: POSIXTime

  this game start time

• sallTime :: Time

  clips from start of session to current game start

• snframes :: Int

  this game current frame count

• sallNframes :: Int

  frame count from start of session to current game start

Instances

Binary SessionUI

Defined in Game.LambdaHack.Client.UI.SessionUI

Methods

put :: SessionUI -> Put

get :: Get SessionUI

putList :: [SessionUI] -> Put

Updating UI state wrt game state changes

displayRespUpdAtomicUI :: MonadClientUI m => UpdAtomic -> m ()

Visualize atomic updates sent to the client. This is done in the global state after the command is executed and after the client state is modified by the command. Don't modify client state (except a few fields), but only client session (e.g., by displaying messages). This is enforced by types.

displayRespSfxAtomicUI :: MonadClientUI m => SfxAtomic -> m ()

Display special effects (text, animation) sent to the client. Don't modify client state (except a few fields), but only client session (e.g., by displaying messages). This is enforced by types.

Startup and initialization

data CCUI

Operations for all content types, gathered together.

Constructors

CCUI

Fields

• coinput :: InputContent
• coscreen :: ScreenContent

data UIOptions

Options that affect the UI of the client.

Instances

Show UIOptions

Defined in Game.LambdaHack.Client.UI.UIOptions

Methods

showsPrec :: Int -> UIOptions -> ShowS

show :: UIOptions -> String

showList :: [UIOptions] -> ShowS

Generic UIOptions

Defined in Game.LambdaHack.Client.UI.UIOptions

Associated Types

type Rep UIOptions :: Type -> Type

Methods

from :: UIOptions -> Rep UIOptions x

to :: Rep UIOptions x -> UIOptions

Binary UIOptions

Defined in Game.LambdaHack.Client.UI.UIOptions

Methods

put :: UIOptions -> Put

get :: Get UIOptions

putList :: [UIOptions] -> Put

NFData UIOptions

Defined in Game.LambdaHack.Client.UI.UIOptions

Methods

rnf :: UIOptions -> ()

type Rep UIOptions

Defined in Game.LambdaHack.Client.UI.UIOptions

type Rep UIOptions = D1 (MetaData "UIOptions" "Game.LambdaHack.Client.UI.UIOptions" "LambdaHack-0.9.3.0-inplace" False) (C1 (MetaCons "UIOptions" PrefixI True) (((S1 (MetaSel (Just "uCommands") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 [(KM, CmdTriple)]) :*: (S1 (MetaSel (Just "uHeroNames") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 [(Int, (Text, Text))]) :*: S1 (MetaSel (Just "uVi") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Bool))) :*: ((S1 (MetaSel (Just "uLaptop") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Bool) :*: S1 (MetaSel (Just "uGtkFontFamily") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "uSdlFontFile") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "uSdlScalableSizeAdd") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Int)))) :*: (((S1 (MetaSel (Just "uSdlBitmapSizeAdd") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "uScalableFontSize") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Int)) :*: (S1 (MetaSel (Just "uHistoryMax") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "uMaxFps") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Int))) :*: ((S1 (MetaSel (Just "uNoAnim") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Bool) :*: S1 (MetaSel (Just "uhpWarningPercent") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Int)) :*: (S1 (MetaSel (Just "uMessageColors") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 (Maybe [(MsgClass, Color)])) :*: S1 (MetaSel (Just "uCmdline") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 [String]))))))

applyUIOptions :: COps -> UIOptions -> ClientOptions -> ClientOptions

Modify client options with UI options.

uCmdline :: UIOptions -> [String]

Hardwired commandline arguments to process.

mkUIOptions :: COps -> Bool -> IO UIOptions

Read and parse UI config file.

Operations exposed for Game.LambdaHack.Client.LoopM

data ChanFrontend

Connection channel between a frontend and a client. Frontend acts as a server, serving keys, etc., when given frames to display.

chanFrontend :: MonadClientUI m => ScreenContent -> ClientOptions -> m ChanFrontend

Initialize the frontend chosen by the player via client options.

promptAdd :: MonadClientUI m => Text -> m ()

Add a prompt to the current report. Do not report if it was a duplicate.

tryRestore :: MonadClientUI m => m (Maybe (StateClient, Maybe SessionUI))

Try to read saved client game state from the file system.

Internal operations

humanCommand :: forall m. (MonadClient m, MonadClientUI m) => m ReqUI

Let the human player issue commands until any command takes time.