Game.LambdaHack.Client.Action

Game action monads and basic building blocks for human and computer player actions. Has no access to the the main action type. Does not export the liftIO operation nor a few other implementation details.

Action monads

class MonadActionRO m => MonadClient m where

Methods

getClient :: m StateClient

getsClient :: (StateClient -> a) -> m a

modifyClient :: (StateClient -> StateClient) -> m ()

putClient :: StateClient -> m ()

saveClient :: m ()

Instances

MonadClient (ActionCli c d)

class MonadClient m => MonadClientUI m

Instances

MonadClientUI (ActionCli c d)

class MonadClient m => MonadClientReadServer c m | m -> c where

Methods

readServer :: m c

Instances

MonadClientReadServer c (ActionCli c d)

class MonadClient m => MonadClientWriteServer d m | m -> d where

Methods

writeServer :: d -> m ()

Instances

MonadClientWriteServer d (ActionCli c d)

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. Auxiliary AI and computer player clients have no sfs nor sbinding.

Constructors

SessionUI

Fields

sfconn :: !ConnFrontend

connection with the frontend

sbinding :: !Binding

binding of keys to commands

data ConnFrontend

Connection method between a client and a frontend.

Constructors

ConnFrontend

Fields

readConnFrontend :: MonadClientUI m => m KM

read a keystroke received from the frontend

writeConnFrontend :: MonadClientUI m => FrontReq -> m ()

write a UI request to the frontend

connFrontend :: FactionId -> ChanFrontend -> ConnFrontend

Executing actions

mkConfigUI :: Ops RuleKind -> IO ConfigUI

Read and parse UI config file.

Accessors to the game session Reader and the Perception Reader(-like)

askBinding :: MonadClientUI m => m Binding

Get the key binding.

getPerFid :: MonadClient m => LevelId -> m Perception

Get the current perception of a client.

History and report

msgAdd :: MonadClientUI m => Msg -> m ()

Add a message to the current report.

msgReset :: MonadClient m => Msg -> m ()

Wipe out and set a new value for the current report.

recordHistory :: MonadClient m => m ()

Store current report in the history and reset report.

Key input

getKeyOverlayCommand :: MonadClientUI m => 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.

stopPlayBack :: MonadClientUI m => m ()

stopRunning :: MonadClientUI m => m ()

Display and key input

displayFrames :: MonadClientUI m => Frames -> m ()

Push frames or delays to the frame queue.

displayMore :: MonadClientUI m => ColorMode -> Msg -> m Bool

Display a msg with a more prompt. Return value indicates if the player tried to cancel/escape.

displayYesNo :: MonadClientUI m => ColorMode -> Msg -> m Bool

Print a yes/no question and return the player's answer. Use black and white colours to turn player's attention to the choice.

displayChoiceUI :: MonadClientUI m => Msg -> Overlay -> [KM] -> m (Either Slideshow KM)

Print a prompt and an overlay and wait for a player keypress. If many overlays, scroll screenfuls with SPACE. Do not wrap screenfuls (in some menus ? cycles views, so the user can restart from the top).

Generate slideshows

promptToSlideshow :: MonadClientUI m => Msg -> m Slideshow

The prompt is shown after the current message, but not added to history. This is useful, e.g., in targeting mode, not to spam history.

overlayToSlideshow :: MonadClientUI m => Msg -> Overlay -> m Slideshow

The prompt is shown after the current message at the top of each slide. Together they may take more than one line. The prompt is not added to history. The portions of overlay that fit on the the rest of the screen are displayed below. As many slides as needed are shown.

overlayToBlankSlideshow :: MonadClientUI m => Msg -> Overlay -> m Slideshow

Draw frames

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

Draw the current level with the overlay on top.

animate :: MonadClientUI m => LevelId -> Animation -> m Frames

Render animations on top of the current screen frame.

Assorted primitives

restoreGame :: MonadClient m => m (Maybe (State, StateClient))

removeServerSave :: MonadClient m => m ()

Assuming the client runs on the same machine and for the same user as the server, move the server savegame out of the way.

displayPush :: MonadClientUI m => m ()

Push the frame depicting the current level to the frame queue. Only one screenful of the report is shown, the rest is ignored.

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

rndToAction :: MonadClient m => Rnd a -> m a

Invoke pseudo-random computation with the generator kept in the state.

getArenaUI :: MonadClientUI m => m LevelId

getLeaderUI :: MonadClientUI m => m ActorId

targetDescLeader :: MonadClientUI m => ActorId -> m Text

viewedLevel :: MonadClientUI m => m LevelId

aidTgtToPos :: MonadClient m => ActorId -> LevelId -> Maybe Target -> m (Maybe Point)

Calculate the position of an actor's target.

aidTgtAims :: MonadClient m => ActorId -> LevelId -> Maybe Target -> m (Maybe Text)

Check whether one is permitted to aim at a target (this is only checked for actors; positions let player shoot at obstacles, e.g., to destroy them). This assumes aidTgtToPos does not return Nothing.

Note: Perception is not enough for the check, because the target actor can be obscured by a glass wall or be out of sight range, but in weapon range.

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

leaderTgtAims :: MonadClientUI m => m (Maybe Text)

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

partAidLeader :: MonadClient m => ActorId -> m Part

The part of speech describing the actor (designated by actor id and present in the dungeon) or a special name if a leader of the observer's faction.

partActorLeader :: MonadClient m => ActorId -> Actor -> m Part

The part of speech describing the actor or a special name if a leader of the observer's faction. The actor may not be present in the dungeon.

unexploredDepth :: MonadClient m => m (Int -> LevelId -> Bool)

getCacheBfsAndPath :: forall m. MonadClient m => ActorId -> Point -> m (Array BfsDistance, Maybe [Point])

Get cached BFS data and path or, if not stored, generate, store and return. Due to laziness, they are not calculated until needed.

getCacheBfs :: MonadClient m => ActorId -> m (Array BfsDistance)

accessCacheBfs :: MonadClient m => ActorId -> Point -> m (Maybe Int)

actorAimsPos :: MonadClient m => ActorId -> Point -> m Bool

closestUnknown :: MonadClient m => ActorId -> m (Maybe Point)

Closest reachable unknown tile position, if any.

closestSmell :: MonadClient m => ActorId -> m [(Int, (Point, SmellTime))]

Finds smells closest to the actor, except under the actor.

furthestKnown :: MonadClient m => ActorId -> m (Maybe Point)

Furthest (wrt paths) known position, except under the actor.

closestTriggers :: MonadClient m => Maybe Bool -> Bool -> ActorId -> m [Point]

Closest (wrt paths) triggerable open tiles. The second argument can ever be true only if there's no escape from the dungeon.

closestItems :: MonadClient m => ActorId -> m [(Int, (Point, ItemBag))]

Closest (wrt paths) items.

closestFoes :: MonadClient m => ActorId -> m [(Int, (ActorId, Actor))]

Closest (wrt paths) enemy actors.

actorAbilities :: MonadClient m => ActorId -> Maybe ActorId -> m [Ability]

debugPrint :: MonadClient m => Text -> m ()