| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Game.LambdaHack.Client.UI
Description
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.
Synopsis
- queryUI :: (MonadClient m, MonadClientUI m) => m RequestUI
- class MonadClientRead m => MonadClientUI m where
- getsSession :: (SessionUI -> a) -> m a
- modifySession :: (SessionUI -> SessionUI) -> m ()
- updateClientLeader :: ActorId -> m ()
- getCacheBfs :: ActorId -> m (Array BfsDistance)
- getCachePath :: ActorId -> Point -> m (Maybe AndPath)
- data SessionUI = SessionUI {
- sxhair :: Maybe Target
- sxhairGoTo :: Maybe Target
- sactorUI :: ActorDictUI
- sitemUI :: ItemDictUI
- sslots :: ItemSlots
- slastItemMove :: Maybe (CStore, CStore)
- schanF :: ChanFrontend
- sccui :: CCUI
- sUIOptions :: UIOptions
- saimMode :: Maybe AimMode
- sxhairMoused :: Bool
- sitemSel :: Maybe (ItemId, CStore, Bool)
- sselected :: EnumSet ActorId
- srunning :: Maybe RunParams
- shistory :: History
- spointer :: PointUI
- smacroFrame :: KeyMacroFrame
- smacroStack :: [KeyMacroFrame]
- slastLost :: EnumSet ActorId
- swaitTimes :: Int
- swasAutomated :: Bool
- smarkVision :: Bool
- smarkSmell :: Bool
- snxtScenario :: Int
- scurTutorial :: Bool
- snxtTutorial :: Bool
- soverrideTut :: Maybe Bool
- susedHints :: Set Msg
- smenuIxMap :: Map String Int
- schosenLore :: ChosenLore
- sdisplayNeeded :: Bool
- sturnDisplayed :: Bool
- sreportNull :: Bool
- sstart :: POSIXTime
- sgstart :: POSIXTime
- sallTime :: Time
- snframes :: Int
- sallNframes :: Int
- srandomUI :: SMGen
- displayRespUpdAtomicUI :: (MonadClient m, MonadClientUI m) => UpdAtomic -> m ()
- displayRespSfxAtomicUI :: (MonadClient m, MonadClientUI m) => SfxAtomic -> m ()
- data CCUI = CCUI {}
- data UIOptions
- applyUIOptions :: COps -> UIOptions -> ClientOptions -> ClientOptions
- uCmdline :: UIOptions -> [String]
- mkUIOptions :: RuleContent -> ClientOptions -> IO UIOptions
- data ChanFrontend
- chanFrontend :: MonadClientUI m => ScreenContent -> ClientOptions -> m ChanFrontend
- tryRestore :: MonadClientUI m => m (Maybe (StateClient, Maybe SessionUI))
- clientPrintUI :: MonadClientUI m => Text -> m ()
- humanCommand :: forall m. (MonadClient m, MonadClientUI m) => m ReqUI
Querying the human player
queryUI :: (MonadClient m, MonadClientUI m) => m RequestUI Source #
Handle the move of a human player.
UI monad and session type
class MonadClientRead m => MonadClientUI m where Source #
The monad that gives the client access to UI operations, but not to modifying client state.
Methods
getsSession :: (SessionUI -> a) -> m a Source #
modifySession :: (SessionUI -> SessionUI) -> m () Source #
updateClientLeader :: ActorId -> m () Source #
getCacheBfs :: ActorId -> m (Array BfsDistance) Source #
getCachePath :: ActorId -> Point -> m (Maybe AndPath) Source #
Instances
| MonadClientUI CliImplementation Source # | |
Defined in Implementation.MonadClientImplementation Methods getsSession :: (SessionUI -> a) -> CliImplementation a Source # modifySession :: (SessionUI -> SessionUI) -> CliImplementation () Source # updateClientLeader :: ActorId -> CliImplementation () Source # getCacheBfs :: ActorId -> CliImplementation (Array BfsDistance) Source # getCachePath :: ActorId -> Point -> CliImplementation (Maybe AndPath) Source # | |
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
| |
Updating UI state wrt game state changes
displayRespUpdAtomicUI :: (MonadClient m, MonadClientUI m) => UpdAtomic -> m () Source #
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. Doesn't modify client state (except a few fields), but only client session (e.g., by displaying messages). This is enforced by types.
displayRespSfxAtomicUI :: (MonadClient m, MonadClientUI m) => SfxAtomic -> m () Source #
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
Operations for all content types, gathered together.
Constructors
| CCUI | |
Fields | |
Options that affect the UI of the client, specified in the config file. More documentation is in the default config file.
Instances
applyUIOptions :: COps -> UIOptions -> ClientOptions -> ClientOptions Source #
Modify client options with UI options.
mkUIOptions :: RuleContent -> ClientOptions -> IO UIOptions Source #
Read and parse UI config file.
Operations exposed for Game.LambdaHack.Client.LoopM
data ChanFrontend Source #
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 Source #
Initialize the frontend chosen by the player via client options.
tryRestore :: MonadClientUI m => m (Maybe (StateClient, Maybe SessionUI)) Source #
Try to read saved client game state from the file system.
clientPrintUI :: MonadClientUI m => Text -> m () Source #
Internal operations
humanCommand :: forall m. (MonadClient m, MonadClientUI m) => m ReqUI Source #
Let the human player issue commands until any command takes time.