Safe Haskell	None
Language	Haskell2010

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. SomeDungeon m => m a Source

Matches any SomeDungeon context

type ChattyDungeonM a = forall m. SomeChattyDungeon m => m a Source

Matches any SomeChattyDungeon context

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 Source
ToConsumer HandlerBox Source

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

None PrerequisiteBox Source
IsAction PrerequisiteBox Source
Gatifiable PrerequisiteBox Source
PredMask (x -> PrerequisiteBox, String) x Source

type Predicate = ChattyDungeonM (Maybe ReError) Source

The common type for all predicates.

newtype PredicateBox Source

A boxed Predicate to avoid ImpredicativeTypes

Constructors

Predicate
Fields runPredicate :: ChattyDungeonM (Maybe ReError)

Instances

None PredicateBox Source
IsAction PredicateBox Source
ToConsumer PredicateBox Source

Utilities

class IsText t where Source

Typeclass for all types that are convertible to or from Text

Methods

toText :: t -> Text Source

fromText :: Text -> t Source

Instances

IsText String Source
IsText Text Source

data Direction Source

10 directions to go

Constructors

North
NorthEast
East
SouthEast
South
SouthWest
West
NorthWest
Up
Down

Instances

Eq Direction Source
Show Direction Source
Tuplify Direction Direction Source

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

Instances

Tuplify RoomState RoomState Source

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 Source
Monad m => Monad (RoomT m) Source
Functor m => Functor (RoomT m) Source
(Functor m, Monad m) => Applicative (RoomT m) Source
Monad m => MonadRoom (RoomT m) Source
Monad m => OnAnnounce (RoomT m) Source
Monad m => OnLook (RoomT m) Source
Monad m => OnFirstEnter (RoomT m) Source
Monad m => OnEnter (RoomT m) Source

class Monad m => MonadRoom m where Source

Typeclass for all room monads.

Methods

getRoomState :: m RoomState Source

Get the room state

putRoomState :: RoomState -> m () Source

Put the room state

Instances

Monad m => MonadRoom (DungeonT m) Source
Monad m => MonadRoom (RoomT m) Source
MonadRoom m0 => MonadRoom (StereoBuilderT m) Source

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 Source
Gatifiable PathState Source

Objects

data StatKey Source

Key for item or player statistics

Constructors

Strength
Agility
Stamina
Intelligence
Spirit
Armor
Haste
CooldownDuration
AttackPower

Instances

Eq StatKey Source
Ord StatKey Source
Tuplify StatKey StatKey Source

data EquipKey Source

Key for equipment slot

Constructors

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

Instances

Eq EquipKey Source
Ord EquipKey Source
Tuplify EquipKey EquipKey Source
Indexable EquipKey EquipKey EquipKey Source

data Relation Source

Relation between the player and the object.

Constructors

Near
Carried
Worn

Instances

Eq Relation Source
Ord Relation Source
Tuplify Relation Relation Source

data Feature Source

Object features.

Constructors

Damagable	May take damage.
Acquirable	May be acquired.
Usable	May be used.
Drinkable	May be drunk.
Eatable	May be eaten.
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 Source
Ord Feature Source
Tuplify Feature Feature Source
Indexable Feature Feature Feature Source
PredMask Feature (Titled ObjectState) Source

data ObjectId Source

Phantom ID type for objects.

Constructors

ObjectId Int
FalseObject

Instances

Eq ObjectId Source
Ord ObjectId Source
None ObjectId Source
Tuplify ObjectId ObjectId Source
Indexable ObjectState ObjectId ObjectState Source

data KindId Source

Phantom ID type for object kinds.

Constructors

KindId Int
FalseKind

Instances

Eq KindId Source
Ord KindId Source
None KindId Source
Tuplify KindId KindId Source

data ObjectState Source

State type for ObjectT

Constructors

ObjectState

Fields

objectIdOf :: !ObjectId
objectKindOf :: !KindId
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
objectTriggerOnUseOf :: Handler
objectTriggerOnEatOf :: Handler
objectTriggerOnDrinkOf :: Handler

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 Source
Monad m => Monad (ObjectT m) Source
Functor m => Functor (ObjectT m) Source
(Functor m, Monad m) => Applicative (ObjectT m) Source
Monad m => MonadObject (ObjectT m) Source
Monad m => OnUse (ObjectT m) Source
Monad m => OnEat (ObjectT m) Source
Monad m => OnDrink (ObjectT m) Source
Monad m => OnDie (ObjectT m) Source
Monad m => OnTakeDamage (ObjectT m) Source
Monad m => OnRoomLeave (ObjectT m) Source
Monad m => OnRoomEnter (ObjectT m) Source
Monad m => OnRead (ObjectT m) Source
Monad m => OnFirstInspection (ObjectT m) Source
Monad m => OnInspection (ObjectT m) Source
Monad m => OnFirstAcquire (ObjectT m) Source
Monad m => OnAcquire (ObjectT m) Source
Monad m => OnFirstSight (ObjectT m) Source
Monad m => OnSight (ObjectT m) Source
Monad m => OnAnnounce (ObjectT m) Source
Monad m => OnLookInto (ObjectT m) Source
Monad m => OnLook (ObjectT m) Source
Monad m => OnEnter (ObjectT m) Source

class Monad m => MonadObject m where Source

Typeclass for all object monads

Methods

getObjectState :: m ObjectState Source

Get the object state

putObjectState :: ObjectState -> m () Source

Put the object state

Instances

Monad m => MonadObject (ObjectT m) Source
MonadObject m0 => MonadObject (StereoBuilderT m) Source

Factions

data Faction Source

A faction

Constructors

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

Instances

Tuplify Faction Faction Source

data Attitude Source

Constructors

Hostile
Friendly
Exalted

Instances

Eq Attitude Source
Ord Attitude Source
Tuplify Attitude Attitude Source

Currencies

data Currency Source

Currency descriptor (description and expander name)

Constructors

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

Instances

Eq Currency Source
Ord Currency Source
Indexable Currency CurrencyId Currency Source

data CurrencyId Source

Phantom ID type for currencies

Constructors

Health
CurrencyId Int

Instances

Eq CurrencyId Source
Ord CurrencyId Source
Indexable Currency CurrencyId Currency Source

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

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
playerActiveQuestsOf :: AVL (Atom Quest, QuestRel)
playerAlcoholOf :: Int
playerSoberingActiveOf :: Bool

Instances

HasStats PlayerState Source
Indexable PlayerState PlayerId PlayerState Source

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 Source
Monad m => Monad (PlayerT m) Source
Functor m => Functor (PlayerT m) Source
(Functor m, Monad m) => Applicative (PlayerT m) Source
Monad m => MonadPlayer (PlayerT m) Source
Monad m => HasStatsM (PlayerT m) Source

class Monad m => MonadPlayer m where Source

Typeclass for all player monads.

Minimal complete definition

getPlayerState, putPlayerState

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

Monad m => MonadPlayer (DungeonT m) Source
Monad m => MonadPlayer (PlayerT m) Source
MonadPlayer m0 => MonadPlayer (StereoBuilderT m) Source

Stereotypes

data PlayerStereo Source

A player stereotype

Constructors

PlayerStereo
Fields stereoCalcStatBonus :: (StatKey -> Int) -> StatKey -> Int stereoSkillBonus :: String -> Maybe Invokable stereoRecipeBonus :: String -> Maybe (RecipeMethod -> Invokable)

data CooldownId Source

Phantom ID type for cooldowns

Constructors

GlobalCooldown
CooldownId Int

Instances

Eq CooldownId Source
Ord CooldownId Source
Indexable CooldownId CooldownId CooldownId Source

data GetterResponse Source

Response of an object getter

Constructors

Found ObjectState
TooMany
NoneFound

Instances

None GetterResponse Source

type Invokable = [String] -> HandlerBox Source

Some handler that may be invoked by the user

type InvokableP = [String] -> PredicateBox Source

Some prerequisite that may be invoked by the user

data RecipeMethod Source

Method of using recipes

Constructors

RecipeMethod Int

Instances

Eq RecipeMethod Source
Ord RecipeMethod Source

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 Source

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 Source
Monad m => Monad (DungeonT m) Source
Functor m => Functor (DungeonT m) Source
(Functor m, Monad m) => Applicative (DungeonT m) Source
Monad m => MonadDungeon (DungeonT m) Source
Monad m => MonadPlayer (DungeonT m) Source
Monad m => MonadRoom (DungeonT m) Source

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

Typeclass for all dungeon monads.

Minimal complete definition

getDungeonState, putDungeonState

Methods

getDungeonState :: m DungeonState Source

Get the dungeon state.

putDungeonState :: DungeonState -> m () Source

Put the dungeon state.

lowerDungeon :: DungeonT m a -> m a Source

Lower a given DungeonT function

Instances

Monad m => MonadDungeon (DungeonT m) Source
MonadDungeon m0 => MonadDungeon (StereoBuilderT m) Source

Eq PlayerId Source
Ord PlayerId Source
Tuplify PlayerId PlayerId Source
Indexable PlayerState PlayerId PlayerState Source
(MonadDungeon m0, ChChannelPrinter PlayerId m0) => ChBroadcaster PlayerId (StereoBuilderT m)
ChChannelPrinter PlayerId m0 => ChChannelPrinter PlayerId (StereoBuilderT m)

Tuplify ObjectState ObjectState Source
Indexable ObjectState ObjectId ObjectState Source
PredMask Feature (Titled ObjectState) Source
CallMask CatchObj (Cons (Titled ObjectState) Nil) Source