Game.LambdaHack.Action

Game action monad and basic building blocks for player and monster actions.

Documentation

data Session

The constant session information, not saved to the game save file.

Constructors

Session

Fields

sfs :: FrontendSession

frontend session information

scops :: COps

game content

skeyb :: Binding (Action ())

binding of keys to commands

type ActionFun r a

Arguments

 = Session

session setup data

-> (State -> Diary -> IO r)

shutdown continuation

-> Perception

cached perception

-> (State -> Diary -> a -> IO r)

continuation

-> IO r

failure/reset continuation

-> State

current state

-> Diary

current diary

-> IO r

The type of the function inside any action. (Separated from the Action type to document each argument with haddock.)

newtype Action a

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

Constructors

Action

Fields

runAction :: forall r. ActionFun r a

Instances

Monad Action

Functor Action

MonadIO Action

MonadState State Action

Show (Action a)

returnAction :: a -> Action a

Invokes the action continuation on the provided argument.

bindAction :: Action a -> (a -> Action b) -> Action b

Distributes the session and shutdown continuation, threads the state and diary.

handlerToIO :: Session -> State -> Diary -> Action () -> IO ()

Run an action, with a given session, state and diary, in the IO monad.

rndToAction :: Rnd a -> Action a

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

session :: (Session -> Action a) -> Action a

Invoke a session command.

sessionIO :: (Session -> IO a) -> Action a

Invoke a session IO command.

displayGeneric :: ColorMode -> (Msg -> Msg) -> Action Bool

Display the current level with modified current msg.

displayAll :: Action Bool

Display the current level, with the current msg and color.

overlay :: String -> Action Bool

Display an overlay on top of the current screen.

currentDiary :: Action Diary

Get the current diary.

diaryReset :: Diary -> Action ()

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

currentMsg :: Action Msg

Get the current msg.

msgReset :: Msg -> Action ()

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

msgAdd :: Msg -> Action ()

Add to the current msg.

msgClear :: Action ()

Clear the current msg.

contentOps :: Action COps

Get the content operations.

contentf :: (COps -> a) -> Action a

Get the content operations modified by a function (usually a selector).

end :: Action ()

End the game, i.e., invoke the shutdown continuation.

abort :: Action a

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

tryWith :: Action () -> Action () -> Action ()

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

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

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

try :: Action () -> Action ()

Try the given computation and silently catch failure.

tryRepeatedly :: Action () -> Action ()

Try the given computation until it succeeds without failure.

debug :: String -> Action ()

Debugging.

abortWith :: Msg -> Action a

Print the given msg, then abort.

abortIfWith :: Bool -> Msg -> Action a

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

neverMind :: Bool -> Action a

Abort conditionally, with a fixed message.

nextCommand :: Session -> Action Key

Wait for a player keypress.

getYesNo :: Session -> Action Bool

A yes-no confirmation.

getOptionalConfirm :: (Bool -> Action a) -> (Key -> Action a) -> Session -> Action a

Waits for a SPACE or ESC. Passes along any other key, including RET, to an argument function.

getConfirm :: Session -> Action Bool

Ignore unexpected kestrokes until a SPACE or ESC is pressed.

msgMoreConfirm :: ColorMode -> Msg -> Action Bool

Print msg, await confirmation. Return value indicates if the player tried to abort/escape.

msgMore :: Msg -> Action ()

Print msg, await confirmation, ignore confirmation.

msgYesNo :: Msg -> Action Bool

Print a yes/no question and return the player's answer.

clearDisplay :: Action Bool

Clear message and overlay.

msgOverlaysConfirm :: Msg -> [String] -> Action Bool

Print a msg and several overlays, one per page, and await confirmation. The return value indicates if the player tried to abort/escape.

withPerception :: Action () -> Action ()

Update the cached perception for the given computation.

currentPerception :: Action Perception

Get the current perception.

updateAnyActor :: ActorId -> (Actor -> Actor) -> Action ()

Update actor stats. Works for actors on other levels, too.

updatePlayerBody :: (Actor -> Actor) -> Action ()

Update player-controlled actor stats.

advanceTime :: ActorId -> Action ()

Advance the move time for the given actor.

playerAdvanceTime :: Action ()

Add a turn to the player time counter.

displayHelp :: Action ()

Display command help.