Game.Antisplice.Monad.Dungeon

Provides the basic data types and monads for Antisplice.

Documentation

type DungeonM a = forall m. MonadDungeon m => m a

Matches any MonadDungeon context

type ChattyDungeonM a = forall m. (Functor m, ExtendedPrinter m, MonadScanner m, MonadExpand m, ExpanderEnv m, MonadDungeon m, MonadError SplErr m, MonadAtoms m, MonadClock m, MonadVocab m) => m a

Matches any MonadDungeon context that also implements most of the Chatty classes and some of our utility classes.

type Trigger = ChattyDungeonM ()

The common type of all event handlers.

newtype TriggerBox

A boxed Trigger to avoid ImpredicativeTypes

Constructors

TriggerBox

Fields

runTrigger :: Trigger

data StatKey

Key for item or player statistics

Constructors

STR

Strength

AGI

Agility

STA

Stamina

INT

Intelligence

SPI

Spirit

ARM

Armor

Instances

Eq StatKey

Ord StatKey

data EquipKey

Key for equipment slot

Constructors

MainHand

OffHand

Chest

Feet

Wrists

Waist

Head

Legs

Back

Hands

Neck

Finger1

Finger2

Instances

Eq EquipKey

Ord EquipKey

data RoomState

State type for RoomT

Constructors

RoomState

Fields

roomDescOf :: !Text

roomTitleOf :: !Text

roomObjectsOf :: AVL ObjectState

roomTriggerOnFirstEnterOf :: Trigger

roomTriggerOnEachEnterOf :: Trigger

roomTriggerOnLeaveOf :: Trigger

roomTriggerOnLookOf :: Trigger

roomTriggerOnAnnounceOf :: Trigger

newtype RoomT m a

The room monad. Used to create or modify room data.

Constructors

Room

Fields

runRoomT :: RoomState -> m (a, RoomState)

Instances

MonadTrans RoomT

Run RoomT

(MonadError SplErr m0, Run RoomT) => MonadError SplErr (RoomT m0)

Monad m => Monad (RoomT m)

Functor m => Functor (RoomT m)

ExpanderEnv m0 => ExpanderEnv (RoomT m0)

MonadExpand m0 => MonadExpand (RoomT m0)

ExtendedPrinter m0 => ExtendedPrinter (RoomT m0)

MonadSpawn m0 => MonadSpawn (RoomT m0)

MonadPrinter m0 => MonadPrinter (RoomT m0)

MonadScanner m0 => MonadScanner (RoomT m0)

MonadFinalizer m0 => MonadFinalizer (RoomT m0)

MonadClock m0 => MonadClock (RoomT m0)

MonadRandom m0 => MonadRandom (RoomT m0)

MonadIO m0 => MonadIO (RoomT m0)

MonadCounter m0 => MonadCounter (RoomT m0)

MonadAtoms m0 => MonadAtoms (RoomT m0)

MonadVocab m0 => MonadVocab (RoomT m0)

Monad m => MonadRoom (RoomT m)

Monad m => OnAnnounce (RoomT m)

Monad m => OnLook (RoomT m)

Monad m => OnFirstEnter (RoomT m)

Monad m => OnEnter (RoomT m)

class Monad m => MonadRoom m where

Typeclass for all room monads.

Methods

getRoomState :: m RoomState

Get the room state

putRoomState :: RoomState -> m ()

Put the room state

Instances

MonadRoom m0 => MonadRoom (CounterT m0)

MonadRoom m0 => MonadRoom (SplErrT m0)

MonadRoom m0 => MonadRoom (AtomStoreT m0)

MonadRoom m0 => MonadRoom (VocabT m0)

Monad m => MonadRoom (DungeonT m)

Monad m => MonadRoom (RoomT m)

class IsText t where

Typeclass for all types that are convertible to or from Text

Methods

toText :: t -> Text

fromText :: Text -> t

Instances

IsText String

IsText Text

data Implication

Implications a object infers for its containing room

Constructors

DescSeg (Atom String)

An additional particle for the room description (e.g. saying that XYZ is there).

data Feature

Object features.

Constructors

Damagable

May take damage.

Acquirable

May be acquired.

Equipable EquipKey

May be equipped at the given slot.

Mobile

May move around.

Instances

Eq Feature

Ord Feature

newtype ObjectId

Phantom ID type for objects.

Constructors

ObjectId Int

Instances

Eq ObjectId

Ord ObjectId

Indexable ObjectState ObjectId ObjectState

data ObjectState

State type for ObjectT

Constructors

ObjectState

Fields

objectIdOf :: !ObjectId

objectTitleOf :: !Text

objectDescOf :: !Text

objectNamesOf :: ![String]

objectAttributesOf :: ![String]

objectOnceSeenOf :: !Bool

objectOnceAcquiredOf :: !Bool

objectOnceInspectedOf :: !Bool

objectOnceEquippedOf :: !Bool

objectMaxHealthOf :: !Int

objectCurHealthOf :: !Int

objectStatsOf :: AVL (StatKey, Int)

objectRouteOf :: ![NodeId]

objectFeaturesOf :: AVL (Feature, ())

objectImplicationsOf :: [Implication]

objectTriggerOnFirstSightOf :: Trigger

objectTriggerOnEachSightOf :: Trigger

objectTriggerOnFirstAcquireOf :: Trigger

objectTriggerOnEachAcquireOf :: Trigger

objectTriggerOnFirstInspectionOf :: Trigger

objectTriggerOnEachInspectionOf :: Trigger

objectTriggerOnLookAtOf :: Trigger

objectTriggerOnLookIntoOf :: Trigger

objectTriggerOnReadOf :: Trigger

objectTriggerOnEnterOf :: Trigger

objectTriggerOnRoomEnterOf :: Trigger

objectTriggerOnRoomLeaveOf :: Trigger

objectTriggerOnAnnounceOf :: Trigger

objectTriggerOnDropOf :: Trigger

objectTriggerOnFirstEquipOf :: Trigger

objectTriggerOnEachEquipOf :: Trigger

objectTriggerOnUnequipOf :: Trigger

Instances

Indexable ObjectState ObjectId ObjectState

newtype ObjectT m a

The object monad. Used to create or modify objects.

Constructors

Object

Fields

runObjectT :: ObjectState -> m (a, ObjectState)

Instances

MonadTrans ObjectT

(MonadError SplErr m0, Run ObjectT) => MonadError SplErr (ObjectT m0)

Monad m => Monad (ObjectT m)

Functor m => Functor (ObjectT m)

ExpanderEnv m0 => ExpanderEnv (ObjectT m0)

MonadExpand m0 => MonadExpand (ObjectT m0)

ExtendedPrinter m0 => ExtendedPrinter (ObjectT m0)

MonadSpawn m0 => MonadSpawn (ObjectT m0)

MonadPrinter m0 => MonadPrinter (ObjectT m0)

MonadScanner m0 => MonadScanner (ObjectT m0)

MonadFinalizer m0 => MonadFinalizer (ObjectT m0)

MonadClock m0 => MonadClock (ObjectT m0)

MonadRandom m0 => MonadRandom (ObjectT m0)

MonadIO m0 => MonadIO (ObjectT m0)

MonadCounter m0 => MonadCounter (ObjectT m0)

MonadAtoms m0 => MonadAtoms (ObjectT m0)

MonadVocab m0 => MonadVocab (ObjectT m0)

Monad m => MonadObject (ObjectT m)

Monad m => OnRoomLeave (ObjectT m)

Monad m => OnRoomEnter (ObjectT m)

Monad m => OnRead (ObjectT m)

Monad m => OnFirstInspection (ObjectT m)

Monad m => OnInspection (ObjectT m)

Monad m => OnFirstAcquire (ObjectT m)

Monad m => OnAcquire (ObjectT m)

Monad m => OnFirstSight (ObjectT m)

Monad m => OnSight (ObjectT m)

Monad m => OnAnnounce (ObjectT m)

Monad m => OnLookInto (ObjectT m)

Monad m => OnLook (ObjectT m)

Monad m => OnEnter (ObjectT m)

class Monad m => MonadObject m where

Typeclass for all object monads

Methods

getObjectState :: m ObjectState

Get the object state

putObjectState :: ObjectState -> m ()

Put the object state

Instances

MonadObject m0 => MonadObject (CounterT m0)

MonadObject m0 => MonadObject (SplErrT m0)

Monad m => MonadObject (ObjectT m)

data PlayerState

State type for PlayerT

Constructors

PlayerState

Fields

playerRoomOf :: !NodeId

playerMaxHealthOf :: !Int

playerCurHealthOf :: !Int

playerInventoryOf :: AVL ObjectState

playerEquipOf :: AVL (EquipKey, ObjectState)

playerBaseStatsOf :: AVL (StatKey, Int)

newtype PlayerT m a

The player monad. Used to create or modify players.

Constructors

Player

Fields

runPlayerT :: PlayerState -> m (a, PlayerState)

Instances

MonadTrans PlayerT

(MonadError SplErr m0, Run PlayerT) => MonadError SplErr (PlayerT m0)

Monad m => Monad (PlayerT m)

Functor m => Functor (PlayerT m)

ExpanderEnv m0 => ExpanderEnv (PlayerT m0)

MonadExpand m0 => MonadExpand (PlayerT m0)

ExtendedPrinter m0 => ExtendedPrinter (PlayerT m0)

MonadSpawn m0 => MonadSpawn (PlayerT m0)

MonadPrinter m0 => MonadPrinter (PlayerT m0)

MonadScanner m0 => MonadScanner (PlayerT m0)

MonadFinalizer m0 => MonadFinalizer (PlayerT m0)

MonadClock m0 => MonadClock (PlayerT m0)

MonadRandom m0 => MonadRandom (PlayerT m0)

MonadIO m0 => MonadIO (PlayerT m0)

MonadCounter m0 => MonadCounter (PlayerT m0)

MonadAtoms m0 => MonadAtoms (PlayerT m0)

MonadVocab m0 => MonadVocab (PlayerT m0)

Monad m => MonadPlayer (PlayerT m)

class Monad m => MonadPlayer m where

Typeclass for all player monads.

Methods

getPlayerState :: m PlayerState

Get the player state.

putPlayerState :: PlayerState -> m ()

Put the player state.

Instances

MonadPlayer m0 => MonadPlayer (CounterT m0)

MonadPlayer m0 => MonadPlayer (SplErrT m0)

MonadPlayer m0 => MonadPlayer (AtomStoreT m0)

MonadPlayer m0 => MonadPlayer (VocabT m0)

Monad m => MonadPlayer (DungeonT m)

Monad m => MonadPlayer (PlayerT m)

data Direction

10 directions to go

Constructors

North

NorthEast

East

SouthEast

South

SouthWest

West

NorthWest

Up

Down

Instances

Eq Direction

Show Direction

data DungeonState

State type for DungeonT

Constructors

DungeonState

Fields

roomsOf :: Graph RoomState Direction

playerOf :: Maybe PlayerState

timeTriggersOf :: AVL (NominalDiffTime, TriggerBox)

currentRoomOf :: DungeonState -> Maybe NodeId

For compatibility. Earlier versions of DungeonT had a field for that.

newtype DungeonT m a

The dungeon monad. Everything runs inside this.

Constructors

Dungeon

Fields

runDungeonT :: DungeonState -> m (a, DungeonState)

Instances

MonadTrans DungeonT

Run DungeonT

(MonadError SplErr m0, Run DungeonT) => MonadError SplErr (DungeonT m0)

Monad m => Monad (DungeonT m)

Functor m => Functor (DungeonT m)

ExpanderEnv m0 => ExpanderEnv (DungeonT m0)

MonadExpand m0 => MonadExpand (DungeonT m0)

ExtendedPrinter m0 => ExtendedPrinter (DungeonT m0)

MonadSpawn m0 => MonadSpawn (DungeonT m0)

MonadPrinter m0 => MonadPrinter (DungeonT m0)

MonadScanner m0 => MonadScanner (DungeonT m0)

MonadFinalizer m0 => MonadFinalizer (DungeonT m0)

MonadClock m0 => MonadClock (DungeonT m0)

MonadRandom m0 => MonadRandom (DungeonT m0)

MonadIO m0 => MonadIO (DungeonT m0)

MonadCounter m0 => MonadCounter (DungeonT m0)

MonadAtoms m0 => MonadAtoms (DungeonT m0)

MonadVocab m0 => MonadVocab (DungeonT m0)

Monad m => MonadDungeon (DungeonT m)

Monad m => MonadPlayer (DungeonT m)

Monad m => MonadRoom (DungeonT m)

class (MonadRoom m, MonadPlayer m) => MonadDungeon m where

Typeclass for all dungeon monads.

Methods

getDungeonState :: m DungeonState

Get the dungeon state.

putDungeonState :: DungeonState -> m ()

Put the dungeon state.

Instances

MonadDungeon m0 => MonadDungeon (CounterT m0)

MonadDungeon m0 => MonadDungeon (SplErrT m0)

MonadDungeon m0 => MonadDungeon (AtomStoreT m0)

MonadDungeon m0 => MonadDungeon (VocabT m0)

Monad m => MonadDungeon (DungeonT m)