Safe Haskell	None
Language	Haskell2010

Game.LambdaHack.Client.UI.SessionUI

Description

The client UI session state.

Synopsis

data SessionUI = SessionUI {
- sxhair :: Target
- sactorUI :: ActorDictUI
- sslots :: ItemSlots
- slastItemMove :: Maybe (CStore, CStore)
- schanF :: ChanFrontend
- sbinding :: Binding
- sUIOptions :: UIOptions
- saimMode :: Maybe AimMode
- sxhairMoused :: Bool
- sitemSel :: Maybe (ItemId, CStore, Bool)
- sselected :: EnumSet ActorId
- srunning :: Maybe RunParams
- shistory :: History
- spointer :: Point
- slastRecord :: LastRecord
- slastPlay :: [KM]
- slastLost :: EnumSet ActorId
- swaitTimes :: Int
- smarkVision :: Bool
- smarkSmell :: Bool
- smenuIxMap :: Map String Int
- sdisplayNeeded :: Bool
- shintMode :: HintMode
- sreportNull :: Bool
- sstart :: POSIXTime
- sgstart :: POSIXTime
- sallTime :: Time
- snframes :: Int
- sallNframes :: Int
}
newtype AimMode = AimMode {
- aimLevelId :: LevelId
}
data RunParams = RunParams {
- runLeader :: ActorId
- runMembers :: [ActorId]
- runInitial :: Bool
- runStopMsg :: Maybe Text
- runWaiting :: Int
}
data LastRecord = LastRecord {
- currentKeys :: [KM]
- previousKeys :: [KM]
- freeSpace :: Int
}
data HintMode
- = HintAbsent
- | HintShown
- | HintWiped
emptySessionUI :: UIOptions -> SessionUI
toggleMarkVision :: SessionUI -> SessionUI
toggleMarkSmell :: SessionUI -> SessionUI
getActorUI :: ActorId -> SessionUI -> ActorUI

Documentation

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 :: Target
the common xhair
sactorUI :: ActorDictUI
assigned actor UI presentations
sslots :: ItemSlots
map from slots to items
slastItemMove :: Maybe (CStore, CStore)
last item move stores
schanF :: ChanFrontend
connection with the frontend
sbinding :: Binding
binding of keys to commands
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
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 #
Instance details Defined in Game.LambdaHack.Client.UI.SessionUI Methods put :: SessionUI -> Put # get :: Get SessionUI # putList :: [SessionUI] -> Put #

newtype AimMode #

Current aiming mode of a client.

Constructors

AimMode
Fields aimLevelId :: LevelId

Instances

Eq AimMode #
Instance details Defined in Game.LambdaHack.Client.UI.SessionUI Methods (==) :: AimMode -> AimMode -> Bool # (/=) :: AimMode -> AimMode -> Bool #
Show AimMode #
Instance details Defined in Game.LambdaHack.Client.UI.SessionUI Methods showsPrec :: Int -> AimMode -> ShowS # show :: AimMode -> String # showList :: [AimMode] -> ShowS #
Binary AimMode #
Instance details Defined in Game.LambdaHack.Client.UI.SessionUI Methods put :: AimMode -> Put # get :: Get AimMode # putList :: [AimMode] -> Put #

data RunParams #

Parameters of the current run.

Constructors

RunParams
Fields runLeader :: ActorId the original leader from run start runMembers :: [ActorId] the list of actors that take part runInitial :: Bool initial run continuation by any run participant, including run leader runStopMsg :: Maybe Text message with the next stop reason runWaiting :: Int waiting for others to move out of the way

Instances

Show RunParams #
Instance details Defined in Game.LambdaHack.Client.UI.SessionUI Methods showsPrec :: Int -> RunParams -> ShowS # show :: RunParams -> String # showList :: [RunParams] -> ShowS #
Binary RunParams #
Instance details Defined in Game.LambdaHack.Client.UI.SessionUI Methods put :: RunParams -> Put # get :: Get RunParams # putList :: [RunParams] -> Put #

data LastRecord #

State of last recorded and currently being recorded key sequences.

Constructors

LastRecord
Fields currentKeys :: [KM] accumulated keys of the current command previousKeys :: [KM] keys of the rest of the recorded command batch freeSpace :: Int space left for commands to record in this batch

data HintMode #

Constructors

HintAbsent
HintShown
HintWiped

Instances

Bounded HintMode #
Instance details Defined in Game.LambdaHack.Client.UI.SessionUI Methods minBound :: HintMode # maxBound :: HintMode #
Enum HintMode #
Instance details Defined in Game.LambdaHack.Client.UI.SessionUI Methods succ :: HintMode -> HintMode # pred :: HintMode -> HintMode # toEnum :: Int -> HintMode # fromEnum :: HintMode -> Int # enumFrom :: HintMode -> [HintMode] # enumFromThen :: HintMode -> HintMode -> [HintMode] # enumFromTo :: HintMode -> HintMode -> [HintMode] # enumFromThenTo :: HintMode -> HintMode -> HintMode -> [HintMode] #
Eq HintMode #
Instance details Defined in Game.LambdaHack.Client.UI.SessionUI Methods (==) :: HintMode -> HintMode -> Bool # (/=) :: HintMode -> HintMode -> Bool #

emptySessionUI :: UIOptions -> SessionUI #

toggleMarkVision :: SessionUI -> SessionUI #

toggleMarkSmell :: SessionUI -> SessionUI #

getActorUI :: ActorId -> SessionUI -> ActorUI #