Game.LambdaHack.Client.UI.SessionUI

The client UI session state.

Documentation

data SessionUI

The information that is used across a human player playing session, including many consecutive games in a single session, including playing different teams. Some of it is saved, some is reset when a new playing session starts. Nothing is tied to a faction/team, but instead all to UI configuration and UI input and display history. An important component is the frontend session.

Constructors

SessionUI

Fields

• sreqPending :: Maybe RequestUI

  request created by a UI query but not yet sent to the server

• sreqDelay :: ReqDelay

  server delayed sending query to client or receiving request from client

• sreqQueried :: Bool

  player is now queried for a command

• sregainControl :: Bool

  player requested to regain control from AI ASAP

• sxhair :: Maybe Target

  the common xhair

• sxhairGoTo :: Maybe Target

  xhair set for last GoTo

• sactorUI :: ActorDictUI

  assigned actor UI presentations

• sitemUI :: ItemDictUI

  assigned item first seen level

• sroles :: ItemRoles

  assignment of roles 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

• svictories :: EnumMap (ContentId ModeKind) (Map Challenge Int)

  the number of games won by the UI faction per game mode and per difficulty level

• scampings :: EnumSet (ContentId ModeKind)

  camped games

• srestarts :: EnumSet (ContentId ModeKind)

  restarted games

• spointer :: PointUI

  mouse pointer position

• sautoYes :: Bool

  whether to auto-clear prompts

• smacroFrame :: KeyMacroFrame

  the head of the key macro stack

• smacroStack :: [KeyMacroFrame]

  the tail of the key macro stack

• slastLost :: EnumSet ActorId

  actors that just got out of sight

• swaitTimes :: Int

  player just waited this many times

• swasAutomated :: Bool

  the player just exited AI automation

• smarkVision :: Int

  mark leader and party FOV

• smarkSmell :: Bool

  mark smell, if the leader can smell

• snxtScenario :: Int

  next game scenario number

• scurTutorial :: Bool

  whether current game is a tutorial

• snxtTutorial :: Bool

  whether next game is to be tutorial

• soverrideTut :: Maybe Bool

  override display of tutorial hints

• susedHints :: Set Msg

  tutorial hints already shown this game

• smuteMessages :: Bool

  whether to mute all new messages

• smenuIxMap :: Map String Int

  indices of last used menu items

• schosenLore :: ChosenLore

  last lore chosen to display

• sdisplayNeeded :: Bool

  current level needs displaying

• sturnDisplayed :: Bool

  a frame was already displayed this turn

• sreportNull :: Bool

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

• 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

• srandomUI :: SMGen

  current random generator for UI

Instances

Binary SessionUI

Defined in Game.LambdaHack.Client.UI.SessionUI

Methods

put :: SessionUI -> Put

get :: Get SessionUI

putList :: [SessionUI] -> Put

data ReqDelay

Constructors

ReqDelayNot

ReqDelayHandled

ReqDelayAlarm

Instances

Eq ReqDelay

Defined in Game.LambdaHack.Client.UI.SessionUI

Methods

(==) :: ReqDelay -> ReqDelay -> Bool

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

type ItemDictUI = EnumMap ItemId LevelId

newtype ItemRoles

A collection of item identifier sets indicating what roles (possibly many) an item has assigned.

Constructors

ItemRoles (EnumMap SLore (EnumSet ItemId))

Instances

Show ItemRoles

Defined in Game.LambdaHack.Client.UI.SessionUI

Methods

showsPrec :: Int -> ItemRoles -> ShowS

show :: ItemRoles -> String

showList :: [ItemRoles] -> ShowS

Binary ItemRoles

Defined in Game.LambdaHack.Client.UI.SessionUI

Methods

put :: ItemRoles -> Put

get :: Get ItemRoles

putList :: [ItemRoles] -> Put

data AimMode

Current aiming mode of a client.

Constructors

AimMode

Fields

• aimLevelId :: LevelId
• detailLevel :: DetailLevel

Instances

Eq AimMode

Defined in Game.LambdaHack.Client.UI.SessionUI

Methods

(==) :: AimMode -> AimMode -> Bool

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

Show AimMode

Defined in Game.LambdaHack.Client.UI.SessionUI

Methods

showsPrec :: Int -> AimMode -> ShowS

show :: AimMode -> String

showList :: [AimMode] -> ShowS

Generic AimMode

Defined in Game.LambdaHack.Client.UI.SessionUI

Associated Types

type Rep AimMode :: Type -> Type

Methods

from :: AimMode -> Rep AimMode x

to :: Rep AimMode x -> AimMode

Binary AimMode

Defined in Game.LambdaHack.Client.UI.SessionUI

Methods

put :: AimMode -> Put

get :: Get AimMode

putList :: [AimMode] -> Put

type Rep AimMode

Defined in Game.LambdaHack.Client.UI.SessionUI

type Rep AimMode = D1 ('MetaData "AimMode" "Game.LambdaHack.Client.UI.SessionUI" "LambdaHack-0.11.0.0-inplace" 'False) (C1 ('MetaCons "AimMode" 'PrefixI 'True) (S1 ('MetaSel ('Just "aimLevelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LevelId) :*: S1 ('MetaSel ('Just "detailLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DetailLevel)))

newtype KeyMacro

In-game macros. We record menu navigation keystrokes and keystrokes bound to commands with one exception --- we exclude keys that invoke the Record command, to avoid surprises. Keys are kept in the same order in which they're meant to be replayed, i.e. the first element of the list is replayed also as the first one.

Constructors

KeyMacro

Fields

• unKeyMacro :: [KM]

Instances

Eq KeyMacro

Defined in Game.LambdaHack.Client.UI.SessionUI

Methods

(==) :: KeyMacro -> KeyMacro -> Bool

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

Show KeyMacro

Defined in Game.LambdaHack.Client.UI.SessionUI

Methods

showsPrec :: Int -> KeyMacro -> ShowS

show :: KeyMacro -> String

showList :: [KeyMacro] -> ShowS

Semigroup KeyMacro

Defined in Game.LambdaHack.Client.UI.SessionUI

Methods

(<>) :: KeyMacro -> KeyMacro -> KeyMacro

sconcat :: NonEmpty KeyMacro -> KeyMacro

stimes :: Integral b => b -> KeyMacro -> KeyMacro

Monoid KeyMacro

Defined in Game.LambdaHack.Client.UI.SessionUI

Methods

mempty :: KeyMacro

mappend :: KeyMacro -> KeyMacro -> KeyMacro

mconcat :: [KeyMacro] -> KeyMacro

Binary KeyMacro

Defined in Game.LambdaHack.Client.UI.SessionUI

Methods

put :: KeyMacro -> Put

get :: Get KeyMacro

putList :: [KeyMacro] -> Put

data KeyMacroFrame

Local macro buffer frame. Predefined macros have their own in-game macro buffer, allowing them to record in-game macro, queue actions and repeat the last macro's action. Running predefined macro pushes new KeyMacroFrame onto the stack. We pop buffers from the stack if locally there are no actions pending to be handled.

Constructors

KeyMacroFrame

Fields

• keyMacroBuffer :: Either [KM] KeyMacro

  record keystrokes in Left; repeat from Right

• keyPending :: KeyMacro

  actions pending to be handled

• keyLast :: Maybe KM

  last pressed key

Instances

Show KeyMacroFrame

Defined in Game.LambdaHack.Client.UI.SessionUI

Methods

showsPrec :: Int -> KeyMacroFrame -> ShowS

show :: KeyMacroFrame -> String

showList :: [KeyMacroFrame] -> ShowS

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

Defined in Game.LambdaHack.Client.UI.SessionUI

Methods

showsPrec :: Int -> RunParams -> ShowS

show :: RunParams -> String

showList :: [RunParams] -> ShowS

Binary RunParams

Defined in Game.LambdaHack.Client.UI.SessionUI

Methods

put :: RunParams -> Put

get :: Get RunParams

putList :: [RunParams] -> Put

data ChosenLore

Last lore being aimed at.

Constructors

ChosenLore [(ActorId, Actor)] [(ItemId, ItemQuant)]

ChosenNothing

emptySessionUI :: UIOptions -> SessionUI

emptyMacroFrame :: KeyMacroFrame

cycleMarkVision :: Int -> SessionUI -> SessionUI

toggleMarkSmell :: SessionUI -> SessionUI

cycleOverrideTut :: Int -> SessionUI -> SessionUI

getActorUI :: ActorId -> SessionUI -> ActorUI