Safe Haskell	None

Game.Antisplice.Monad.Dungeon

Contents

Context quantifiers
Utilities
Rooms
Objects
Factions
Currencies
Fight
Players
Stereotypes
Dungeons

Description

Provides the basic data types and monads for Antisplice.

Synopsis

Context quantifiers

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

Matches any MonadDungeon context

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

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

type Handler = ChattyDungeonM ()Source

The common type of all event handlers.

newtype HandlerBox Source

A boxed Handler to avoid ImpredicativeTypes

Constructors

Handler
Fields runHandler :: Handler

Instances

None HandlerBox
ToConsumer HandlerBox
ToConsumer (SkillParam -> HandlerBox)

type Prerequisite = ChattyDungeonM Bool Source

The common type of all prerequisites.

newtype PrerequisiteBox Source

A boxed Prerequisite to avoid ImpredicativeTypes

Constructors

Prerequisite
Fields runPrerequisite :: Prerequisite

Instances

Monoid PrerequisiteBox
None PrerequisiteBox
IsAction PrerequisiteBox
ToConsumer PrerequisiteBox
Gatifiable PrerequisiteBox

Utilities

class IsText t whereSource

Typeclass for all types that are convertible to or from Text

Methods

toText :: t -> Text Source

fromText :: Text -> tSource

Instances

IsText String
IsText Text

data Direction Source

10 directions to go

Constructors

North
NorthEast
East
SouthEast
South
SouthWest
West
NorthWest
Up
Down

Instances

Eq Direction
Show Direction

Rooms

data RoomState Source

State type for RoomT

Constructors

RoomState
Fields roomTitleOf :: !Text roomObjectsOf :: AVL ObjectState roomTriggerOnFirstEnterOf :: Handler roomTriggerOnEachEnterOf :: Handler roomTriggerOnLeaveOf :: Handler roomTriggerOnLookOf :: Handler roomTriggerOnAnnounceOf :: Handler

newtype RoomT m a Source

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 => MonadError SplErr (RoomT m0)
Monad m => Monad (RoomT m)
Functor m => Functor (RoomT m)
HistoryEnv m0 => HistoryEnv (RoomT m0)
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 whereSource

Typeclass for all room monads.

Methods

getRoomState :: m RoomState Source

Get the room state

putRoomState :: RoomState -> m ()Source

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)
MonadRoom m0 => MonadRoom (StereoBuilderT m0)

data PathState Source

State type for a path from one room to another

Constructors

PathState
Fields pathPrerequisiteOf :: Prerequisite pathTriggerBeforeWalkOf :: Handler pathTriggerAfterWalkOf :: Handler

Instances

None PathState
Gatifiable PathState

Objects

data StatKey Source

Key for item or player statistics

Constructors

Strength
Agility
Stamina
Intelligence
Spirit
Armor
Haste
CooldownDuration
AttackPower

Instances

Eq StatKey
Ord StatKey

data EquipKey Source

Key for equipment slot

Constructors

MainHand
OffHand
Chest
Feet
Wrists
Waist
Head
Legs
Back
Hands
Neck
Finger1
Finger2

Instances

Eq EquipKey
Ord EquipKey
Indexable EquipKey EquipKey EquipKey

data Relation Source

Relation between the player and the object.

Constructors

Near
Carried
Worn

Instances

Eq Relation
Ord Relation

data Feature Source

Object features.

Constructors

Damagable	May take damage.
Acquirable	May be acquired.
Equipable EquipKey	May be equipped at the given slot.
Redeemable Currency Int	May be redeemed for the given currency.
AutoRedeem Currency Int	Redeem automatically for a given currency.
Weighty Int	Has a known weight.
Played PlayerId	Is connected to a real player.
Mobile	May move around.
Stereo Relation (Atom PlayerStereo)	Implies an additional stereotype for the nearcarryingwearing player
Described (Atom String)	Implies an additional particle for the room description

Instances

Eq Feature
Ord Feature
Indexable Feature Feature Feature

data ObjectId Source

Phantom ID type for objects.

Constructors

ObjectId Int
FalseObject

Instances

Eq ObjectId
Ord ObjectId
None ObjectId
Indexable ObjectState ObjectId ObjectState

data ObjectState Source

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
objectRouteOf :: ![NodeId]
objectFeaturesOf :: AVL Feature
objectFactionOf :: !(Maybe (Atom Faction))
objectTriggerOnFirstSightOf :: Handler
objectTriggerOnEachSightOf :: Handler
objectTriggerOnFirstAcquireOf :: Handler
objectTriggerOnEachAcquireOf :: Handler
objectTriggerOnFirstInspectionOf :: Handler
objectTriggerOnEachInspectionOf :: Handler
objectTriggerOnLookAtOf :: Handler
objectTriggerOnLookIntoOf :: Handler
objectTriggerOnReadOf :: Handler
objectTriggerOnEnterOf :: Handler
objectTriggerOnRoomEnterOf :: Handler
objectTriggerOnRoomLeaveOf :: Handler
objectTriggerOnAnnounceOf :: Handler
objectTriggerOnDropOf :: Handler
objectTriggerOnFirstEquipOf :: Handler
objectTriggerOnEachEquipOf :: Handler
objectTriggerOnUnequipOf :: Handler
objectTriggerOnDieOf :: Handler
objectTriggerOnTakeDamageOf :: Handler

Instances

Typeable ObjectState
Indexable ObjectState ObjectId ObjectState

newtype ObjectT m a Source

The object monad. Used to create or modify objects.

Constructors

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

Instances

MonadTrans ObjectT
MonadError SplErr m0 => MonadError SplErr (ObjectT m0)
Monad m => Monad (ObjectT m)
Functor m => Functor (ObjectT m)
HistoryEnv m0 => HistoryEnv (ObjectT m0)
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 whereSource

Typeclass for all object monads

Methods

getObjectState :: m ObjectState Source

Get the object state

putObjectState :: ObjectState -> m ()Source

Put the object state

Instances

MonadObject m0 => MonadObject (CounterT m0)
MonadObject m0 => MonadObject (SplErrT m0)
Monad m => MonadObject (ObjectT m)
MonadObject m0 => MonadObject (StereoBuilderT m0)

Factions

data Faction Source

A faction

Constructors

Faction
Fields factionName :: !Text factionTriggerOnHostileOf :: Handler factionTriggerOnFriendlyOf :: Handler factionTriggerOnExaltedOf :: Handler

data Attitude Source

Constructors

Hostile
Friendly
Exalted

Instances

Eq Attitude
Ord Attitude

Currencies

data Currency Source

Currency descriptor (description and expander name)

Constructors

Currency
Fields currencyIdOf :: CurrencyId currencyDescOf :: String currencyNameOf :: String

Instances

Eq Currency
Ord Currency
Indexable Currency CurrencyId Currency

data CurrencyId Source

Phantom ID type for currencies

Constructors

Health
CurrencyId Int

Instances

Eq CurrencyId
Ord CurrencyId
Indexable Currency CurrencyId Currency

Fight

data DamageTarget Source

Target for attacks. May be a player or an object.

Constructors

TargetPlayer PlayerId
TargetObject ObjectId

Players

newtype PlayerId Source

Phantom ID type for players

Constructors

PlayerId Int

Instances

Eq PlayerId
Ord PlayerId
Indexable PlayerState PlayerId PlayerState

data PlayerState Source

State type for PlayerT

Constructors

PlayerState

Fields

playerIdOf :: !PlayerId
playerRoomOf :: !NodeId
playerMaxHealthOf :: !Int
playerInventoryOf :: AVL ObjectState
playerEquipOf :: AVL (EquipKey, ObjectState)
playerBaseStatsOf :: AVL (StatKey, Int)
playerStereosOf :: [Atom PlayerStereo]
playerReputationOf :: AVL (Atom Faction, Int)
playerCurrenciesOf :: AVL (CurrencyId, Int)
playerCooldownsOf :: AVL CooldownId
playerOpponentOf :: !ObjectId

Instances

HasStats PlayerState
Indexable PlayerState PlayerId PlayerState

newtype PlayerT m a Source

The player monad. Used to create or modify players.

Constructors

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

Instances

MonadTrans PlayerT
MonadError SplErr m0 => MonadError SplErr (PlayerT m0)
Monad m => Monad (PlayerT m)
Functor m => Functor (PlayerT m)
HistoryEnv m0 => HistoryEnv (PlayerT m0)
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)
Monad m => HasStatsM (PlayerT m)

class Monad m => MonadPlayer m whereSource

Typeclass for all player monads.

Methods

getPlayerState :: m PlayerState Source

Get the player state.

putPlayerState :: PlayerState -> m ()Source

Put the player state.

modifyPlayerState :: (PlayerState -> PlayerState) -> m ()Source

Modify 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)
MonadPlayer m0 => MonadPlayer (StereoBuilderT m0)

Stereotypes

data PlayerStereo Source

A player stereotype

Constructors

PlayerStereo
Fields stereoCalcStatBonus :: (StatKey -> Int) -> StatKey -> Int stereoSkillBonus :: String -> Maybe (SkillParam -> HandlerBox)

Instances

Typeable PlayerStereo
Monoid PlayerStereo
None PlayerStereo

data CooldownId Source

Phantom ID type for cooldowns

Constructors

GlobalCooldown
CooldownId Int

Instances

Eq CooldownId
Ord CooldownId
Indexable CooldownId CooldownId CooldownId

data SkillParam Source

Parameter for skill invocation

Constructors

SkillParam
Fields paramDirectOf :: Maybe ObjectState paramAtOf :: Maybe ObjectState paramOnOf :: Maybe ObjectState

Instances

None SkillParam
ToConsumer (SkillParam -> HandlerBox)

Dungeons

data DungeonState Source

State type for DungeonT

Constructors

DungeonState
Fields roomsOf :: Graph RoomState Direction PathState playersOf :: Focus PlayerState timeTriggersOf :: AVL (NominalDiffTime, HandlerBox) currenciesOf :: AVL Currency

Instances

None DungeonState

currentRoomOf :: DungeonState -> Maybe NodeId Source

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

playerOf :: DungeonState -> Maybe PlayerState Source

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

newtype DungeonT m a Source

The dungeon monad. Everything runs inside this.

Constructors

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

Instances

MonadTrans DungeonT
Run DungeonT
MonadError SplErr m0 => MonadError SplErr (DungeonT m0)
Monad m => Monad (DungeonT m)
Functor m => Functor (DungeonT m)
HistoryEnv m0 => HistoryEnv (DungeonT m0)
ExpanderEnv m0 => ExpanderEnv (DungeonT m0)
MonadExpand m => MonadExpand (DungeonT m)
ExtendedPrinter m0 => ExtendedPrinter (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 whereSource

Typeclass for all dungeon monads.

Methods

getDungeonState :: m DungeonState Source

Get the dungeon state.

putDungeonState :: DungeonState -> m ()Source

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)
MonadDungeon m0 => MonadDungeon (StereoBuilderT m0)