Game.LambdaHack.Action

Game action monad and basic building blocks for player and monster actions. Uses liftIO of the Action monad, but does not export it. Has no direct access to the Action monad implementation.

Actions and accessors

data Action a

Actions of player-controlled characters and of any other actors.

Instances

Monad Action

Functor Action

MonadState State Action

Show (Action a)

getPerception :: Action Perception

Get the current perception.

getCOps :: Action COps

Get the content operations.

getBinding :: Action (Binding (ActionFrame ()))

Get the key binding.

getConfigUI :: Action ConfigUI

Get the config from the config file.

Actions returning frames

type ActionFrame a = Action (a, [Maybe SingleFrame])

Actions and screen frames, including delays, resulting from performing the actions.

returnNoFrame :: a -> ActionFrame a

Return the value with an empty set of screen frames.

returnFrame :: SingleFrame -> ActionFrame ()

Return the trivial value with a single frame to show.

whenFrame :: Bool -> ActionFrame () -> ActionFrame ()

As the when monad operation, but on type ActionFrame ().

inFrame :: Action () -> ActionFrame ()

Inject action into actions with screen frames.

tryWithFrame :: Action a -> ActionFrame a -> ActionFrame a

Set the current exception handler. Apart of executing it, draw and pass along a frame with the abort message, if any.

Various ways to abort action

abort :: Action a

Reset the state and resume from the last backup point, i.e., invoke the failure continuation.

abortWith :: Msg -> Action a

Abort with the given message.

abortIfWith :: Bool -> Msg -> Action a

Abort and print the given msg if the condition is true.

neverMind :: Bool -> Action a

Abort and conditionally print the fixed message.

Abort exception handlers

tryWith :: (Msg -> Action a) -> Action a -> Action a

Set the current exception handler. First argument is the handler, second is the computation the handler scopes over.

tryRepeatedlyWith :: (Msg -> Action ()) -> Action () -> Action ()

Take a handler and a computation. If the computation fails, the handler is invoked and then the computation is retried.

tryIgnore :: Action () -> Action ()

Try the given computation and silently catch failure.

Diary and report

getDiary :: Action Diary

Get the current diary.

msgAdd :: Msg -> Action ()

Add a message to the current report.

recordHistory :: Action ()

Store current report in the history and reset report.

Key input

getKeyCommand :: Maybe Bool -> Action (Key, Modifier)

Wait for a player command.

getKeyFrameCommand :: SingleFrame -> Action (Key, Modifier)

Display frame and wait for a player command.

getOverConfirm :: [SingleFrame] -> Action Bool

A series of confirmations for all overlays.

Display each frame and confirm

displayMore :: ColorMode -> Msg -> Action Bool

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

displayYesNo :: Msg -> Action 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.

displayOverAbort :: Msg -> [Overlay] -> Action ()

Print a msg and several overlays, one per page. All frames require confirmations. Raise abort if the player presses ESC.

Assorted frame operations

displayOverlays :: Msg -> Msg -> [Overlay] -> ActionFrame ()

Print a msg and several overlays, one per page. The last frame does not expect a confirmation and so does not show the invitation to press some keys.

displayChoiceUI :: Msg -> [Overlay] -> [(Key, Modifier)] -> Action (Key, Modifier)

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).

displayFramePush :: Maybe SingleFrame -> Action ()

Push a frame or a single frame's worth of delay to the frame queue.

drawPrompt :: ColorMode -> Msg -> Action SingleFrame

Draw the current level. The prompt is displayed, but not added to history. The prompt is appended to the current message and only the first screenful of the resulting overlay is displayed.

Clip init operations

startClip :: Action () -> Action ()

Initialize perception, etc., display level and run the action.

remember :: Action ()

Update heroes memory.

rememberList :: [Point] -> Action ()

Update heroes memory at the given list of locations.

Assorted primitives

saveGameBkp :: Action ()

Save the diary and a backup of the save game file, in case of crashes.

See saveGameBkp.

dumpCfg :: FilePath -> Action ()

Dumps the current game rules configuration to a file.

endOrLoop :: Action () -> Action ()

Continue or restart or exit the game.

frontendName :: String

The name of the frontend.

startFrontend :: COps -> (ConfigUI -> Binding (ActionFrame ())) -> Action () -> IO ()

Wire together content, the definitions of game commands, config and a high-level startup function to form the starting game session. Evaluate to check for errors, in particular verify content consistency. Then create the starting game config from the default config file and initialize the engine with the starting session.

debug :: Text -> Action ()

Debugging.