Dovin.V2

V2 makes the following changes from V1:

• withLocation now only takes a Location, using the current actor for player.
• Flips argument order for validate functions to be consistent with rest of API.
• activate and trigger use the stack.
• Fork has a saner API and reports properly.
• formatter now takes a Step rather than an Int. view is re-exported since it will virtually always be required for normal formatters.

Documentation

module Dovin.Runner

module Dovin.Actions

module Dovin.Attributes

addCard :: CardName -> GameMonad ()

addAura :: CardName -> GameMonad ()

addArtifact :: CardName -> GameMonad ()

addCreature :: (Int, Int) -> CardName -> GameMonad ()

addPlaneswalker :: Int -> CardName -> GameMonad ()

addEnchantment :: CardName -> GameMonad ()

addInstant :: CardName -> GameMonad ()

addLand :: CardName -> GameMonad ()

addLands :: Int -> CardName -> GameMonad ()

addSorcery :: CardName -> GameMonad ()

as :: Player -> GameMonad () -> GameMonad ()

Perform action as the specified player.

withAttribute :: String -> GameMonad () -> GameMonad ()

Add an attribute to the created card, as identified by a string. Attributes with that special meaning to Dovin built-ins (such as flying) are defined in Dovin.Attributes.

withAttributes :: [String] -> GameMonad () -> GameMonad ()

Helper version of withAttribute for adding multiple attributes at a time.

withEffectWhen

Arguments

:: EffectMonad Bool

Effect only applies when this returns true

-> EffectMonad CardMatcher

The set of cards to apply the effect to

-> [LayeredEffectPart]

The effect to apply

-> EffectName

Human-readable description, cosmetic only.

-> GameMonad ()

-> GameMonad ()

A more flexible version of withEffect that allows customization of then the effect should apply.

withCMC :: Int -> GameMonad () -> GameMonad ()

Set the converted mana cost of the created card.

withLocation :: Location -> GameMonad () -> GameMonad ()

Place the created card into a specific location.

withOwner :: Player -> GameMonad () -> GameMonad ()

Set the owner for the created card. If not specified, defaults to the owner of the card location.

withPlusOneCounters :: Int -> GameMonad () -> GameMonad ()

Set the number of +1/+1 counters of the created card.

withMinusOneCounters :: Int -> GameMonad () -> GameMonad ()

Set the number of -1/-1 counters of the created card.

module Dovin.Formatting

module Dovin.Helpers

type Formatter = Board -> String

type GameMonad a = ExceptT String (ReaderT Env (StateT Board (WriterT [Step] Identity))) a

data Step

Constructors

Step

Fields

• _stepId :: StepIdentifier
• _stepLabel :: String
• _stepState :: Board

type StepIdentifier = (Maybe String, Int)

data Env

Constructors

Env

Fields

• _envTemplate :: Card
• _envSBAEnabled :: Bool
• _envActor :: Player
• _envOwner :: Maybe Player

data Board

Constructors

Board

Fields

• _cards :: HashMap CardName BaseCard
• _resolvedCards :: HashMap CardName Card
• _stack :: [CardName]
• _deck :: HashMap Player [CardName]
• _counters :: HashMap String Int
• _life :: HashMap Player Int
• _manaPool :: HashMap Player ManaPool
• _phase :: Phase
• _currentStep :: StepIdentifier
• _currentTime :: Timestamp

type EffectName = String

data CardMatcher

Constructors

CardMatcher String (Card -> Bool)

Instances

Show CardMatcher

Defined in Dovin.Types

Methods

showsPrec :: Int -> CardMatcher -> ShowS

show :: CardMatcher -> String

showList :: [CardMatcher] -> ShowS

Semigroup CardMatcher

Defined in Dovin.Types

Methods

(<>) :: CardMatcher -> CardMatcher -> CardMatcher

sconcat :: NonEmpty CardMatcher -> CardMatcher

stimes :: Integral b => b -> CardMatcher -> CardMatcher

Monoid CardMatcher

Defined in Dovin.Types

Methods

mempty :: CardMatcher

mappend :: CardMatcher -> CardMatcher -> CardMatcher

mconcat :: [CardMatcher] -> CardMatcher

newtype BaseCard

Constructors

BaseCard Card

Instances

Eq BaseCard

Defined in Dovin.Types

Methods

(==) :: BaseCard -> BaseCard -> Bool

(/=) :: BaseCard -> BaseCard -> Bool

Show BaseCard

Defined in Dovin.Types

Methods

showsPrec :: Int -> BaseCard -> ShowS

show :: BaseCard -> String

showList :: [BaseCard] -> ShowS

data Card

Constructors

Card

Fields

• _cardName :: CardName
• _location :: (Player, Location)
• _cardOwner :: Player
• _cardDefaultAttributes :: CardAttributes
• _cardAttributes :: CardAttributes
• _cardStrength :: CardStrength
• _cardStrengthModifier :: CardStrength
• _cardDamage :: Int
• _cardLoyalty :: Int
• _cardEffects :: [CardEffect]
• _cardCmc :: Int
• _cardColors :: Colors
• _cardTargets :: [Target]
• _cardTimestamp :: Timestamp
• _cardPassiveEffects :: [LayeredEffectDefinition]
• _cardAbilityEffects :: [AbilityEffect]
• _cardPlusOneCounters :: Int
• _cardMinusOneCounters :: Int

Instances

Eq Card

Defined in Dovin.Types

Methods

(==) :: Card -> Card -> Bool

(/=) :: Card -> Card -> Bool

Show Card

Defined in Dovin.Types

Methods

showsPrec :: Int -> Card -> ShowS

show :: Card -> String

showList :: [Card] -> ShowS

data AbilityEffect

Constructors

AbilityEffect Timestamp EffectDuration [LayeredEffectPart]

data EffectDuration

Constructors

EndOfTurn

type Timestamp = Integer

data Phase

A phase or step in a turn. Phases and steps are not distinguished between because haven't seen a need to.

Constructors

Untap

Upkeep

DrawStep

FirstMain

BeginCombat

DeclareAttackers

DeclareBlockers

FirstStrikeDamage

CombatDamage

EndCombat

SecondMain

EndStep

Won Player

Instances

Eq Phase

Defined in Dovin.Types

Methods

(==) :: Phase -> Phase -> Bool

(/=) :: Phase -> Phase -> Bool

Ord Phase

Defined in Dovin.Types

Methods

compare :: Phase -> Phase -> Ordering

(<) :: Phase -> Phase -> Bool

(<=) :: Phase -> Phase -> Bool

(>) :: Phase -> Phase -> Bool

(>=) :: Phase -> Phase -> Bool

max :: Phase -> Phase -> Phase

min :: Phase -> Phase -> Phase

Show Phase

Defined in Dovin.Types

Methods

showsPrec :: Int -> Phase -> ShowS

show :: Phase -> String

showList :: [Phase] -> ShowS

data CardStrength

Constructors

CardStrength Int Int

Instances

Eq CardStrength

Defined in Dovin.Types

Methods

(==) :: CardStrength -> CardStrength -> Bool

(/=) :: CardStrength -> CardStrength -> Bool

Show CardStrength

Defined in Dovin.Types

Methods

showsPrec :: Int -> CardStrength -> ShowS

show :: CardStrength -> String

showList :: [CardStrength] -> ShowS

Semigroup CardStrength

Defined in Dovin.Types

Methods

(<>) :: CardStrength -> CardStrength -> CardStrength

sconcat :: NonEmpty CardStrength -> CardStrength

stimes :: Integral b => b -> CardStrength -> CardStrength

Monoid CardStrength

Defined in Dovin.Types

Methods

mempty :: CardStrength

mappend :: CardStrength -> CardStrength -> CardStrength

mconcat :: [CardStrength] -> CardStrength

type CardAttributes = Set CardAttribute

type CardLocation = (Player, Location)

data Target

Constructors

TargetPlayer Player

Target a player, use targetPlayer to construct.

TargetCard CardName

Target a card, use targetCard to construct.

Instances

Eq Target

Defined in Dovin.Types

Methods

(==) :: Target -> Target -> Bool

(/=) :: Target -> Target -> Bool

Show Target

Defined in Dovin.Types

Methods

showsPrec :: Int -> Target -> ShowS

show :: Target -> String

showList :: [Target] -> ShowS

data LayeredEffectDefinition

Constructors

LayeredEffectDefinition

Fields

• _leAppliesTo :: EffectMonad CardMatcher

  Filter to determine which cards are affected by this effect, if enabled.

• _leEffect :: LayeredEffect

  The actions to apply to affected cards.

• _leName :: EffectName

  A human readable description of the effect. Optional.

type LayeredEffect = [LayeredEffectPart]

data LayeredEffectPart

Constructors

LayeredEffectPart Layer (Card -> EffectMonad Card)

data Layer

Constructors

Layer1A

Copiable effects

Layer1B

Face down spells and permanents

Layer2

Control-changing effects

Layer3

Text changing effects

Layer4

Type changing effects

Layer5

Color changing effects

Layer6

Ability changing effects

Layer7A

P/T from CDAs

Layer7B

P/T from setting

Layer7C

P/T adjustments (inc. counters)

Layer7D

P/T Switching

LayerOther

Other game rule affecting effects

Instances

Bounded Layer

Defined in Dovin.Types

Methods

minBound :: Layer

maxBound :: Layer

Enum Layer

Defined in Dovin.Types

Methods

succ :: Layer -> Layer

pred :: Layer -> Layer

toEnum :: Int -> Layer

fromEnum :: Layer -> Int

enumFrom :: Layer -> [Layer]

enumFromThen :: Layer -> Layer -> [Layer]

enumFromTo :: Layer -> Layer -> [Layer]

enumFromThenTo :: Layer -> Layer -> Layer -> [Layer]

Eq Layer

Defined in Dovin.Types

Methods

(==) :: Layer -> Layer -> Bool

(/=) :: Layer -> Layer -> Bool

Ord Layer

Defined in Dovin.Types

Methods

compare :: Layer -> Layer -> Ordering

(<) :: Layer -> Layer -> Bool

(<=) :: Layer -> Layer -> Bool

(>) :: Layer -> Layer -> Bool

(>=) :: Layer -> Layer -> Bool

max :: Layer -> Layer -> Layer

min :: Layer -> Layer -> Layer

Show Layer

Defined in Dovin.Types

Methods

showsPrec :: Int -> Layer -> ShowS

show :: Layer -> String

showList :: [Layer] -> ShowS

type EffectMonad a = Reader EffectMonadEnv a

type EffectMonadEnv = (Board, Card)

data CardEffect

Constructors

CardEffect

Fields

• _effectEnabled :: CardMatcher
• _effectFilter :: Card -> CardMatcher
• _effectAction :: Card -> GameMonad Card

data Location

Constructors

Hand

Graveyard

Play

Stack

Exile

Deck

Instances

Eq Location

Defined in Dovin.Types

Methods

(==) :: Location -> Location -> Bool

(/=) :: Location -> Location -> Bool

Ord Location

Defined in Dovin.Types

Methods

compare :: Location -> Location -> Ordering

(<) :: Location -> Location -> Bool

(<=) :: Location -> Location -> Bool

(>) :: Location -> Location -> Bool

(>=) :: Location -> Location -> Bool

max :: Location -> Location -> Location

min :: Location -> Location -> Location

Show Location

Defined in Dovin.Types

Methods

showsPrec :: Int -> Location -> ShowS

show :: Location -> String

showList :: [Location] -> ShowS

type ManaString = String

type ManaPool = String

data Player

Constructors

Active

Opponent

Instances

Eq Player

Defined in Dovin.Types

Methods

(==) :: Player -> Player -> Bool

(/=) :: Player -> Player -> Bool

Ord Player

Defined in Dovin.Types

Methods

compare :: Player -> Player -> Ordering

(<) :: Player -> Player -> Bool

(<=) :: Player -> Player -> Bool

(>) :: Player -> Player -> Bool

(>=) :: Player -> Player -> Bool

max :: Player -> Player -> Player

min :: Player -> Player -> Player

Show Player

Defined in Dovin.Types

Methods

showsPrec :: Int -> Player -> ShowS

show :: Player -> String

showList :: [Player] -> ShowS

Generic Player

Defined in Dovin.Types

Associated Types

type Rep Player :: Type -> Type

Methods

from :: Player -> Rep Player x

to :: Rep Player x -> Player

Hashable Player

Defined in Dovin.Types

Methods

hashWithSalt :: Int -> Player -> Int

hash :: Player -> Int

type Rep Player

Defined in Dovin.Types

type Rep Player = D1 ('MetaData "Player" "Dovin.Types" "dovin-3.0.1-IFqEYjMDOrX6yiKW5Gzbyz" 'False) (C1 ('MetaCons "Active" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Opponent" 'PrefixI 'False) (U1 :: Type -> Type))

type CardAttribute = String

type CardName = String

type Colors = Set Color

data Color

Constructors

Red

Green

Blue

Black

White

Instances

Eq Color

Defined in Dovin.Types

Methods

(==) :: Color -> Color -> Bool

(/=) :: Color -> Color -> Bool

Ord Color

Defined in Dovin.Types

Methods

compare :: Color -> Color -> Ordering

(<) :: Color -> Color -> Bool

(<=) :: Color -> Color -> Bool

(>) :: Color -> Color -> Bool

(>=) :: Color -> Color -> Bool

max :: Color -> Color -> Color

min :: Color -> Color -> Color

Show Color

Defined in Dovin.Types

Methods

showsPrec :: Int -> Color -> ShowS

show :: Color -> String

showList :: [Color] -> ShowS

allLayers :: [Layer]

mkEffect :: CardMatcher -> (Card -> CardMatcher) -> (Card -> Identity Card) -> CardEffect

mkLayeredEffectPart :: EffectMonad CardMatcher -> LayeredEffect -> EffectName -> LayeredEffectDefinition

targetPlayer :: Player -> Target

targetCard :: CardName -> Target

incrementStep :: StepIdentifier -> StepIdentifier

counters :: Lens' Board (HashMap String Int)

currentTime :: Lens' Board Timestamp

cardAbilityEffects :: Lens' Card [AbilityEffect]

cardAttributes :: Lens' Card CardAttributes

cardCmc :: Lens' Card Int

cardColors :: Lens' Card Colors

cardDamage :: Lens' Card Int

cardDefaultAttributes :: Lens' Card CardAttributes

cardEffects :: Lens' Card [CardEffect]

cardLoyalty :: Lens' Card Int

cardMinusOneCounters :: Lens' Card Int

cardName :: Lens' Card CardName

cardOwner :: Lens' Card Player

cardPassiveEffects :: Lens' Card [LayeredEffectDefinition]

cardPlusOneCounters :: Lens' Card Int

cardStrength :: Lens' Card CardStrength

cardStrengthModifier :: Lens' Card CardStrength

cardTargets :: Lens' Card [Target]

cardTimestamp :: Lens' Card Timestamp

location :: Lens' Card (Player, Location)

effectAction :: Lens' CardEffect (Card -> GameMonad Card)

effectEnabled :: Lens' CardEffect CardMatcher

effectFilter :: Lens' CardEffect (Card -> CardMatcher)

envActor :: Lens' Env Player

envOwner :: Lens' Env (Maybe Player)

envSBAEnabled :: Lens' Env Bool

envTemplate :: Lens' Env Card

stepId :: Lens' Step StepIdentifier

stepLabel :: Lens' Step String

stepState :: Lens' Step Board

leAppliesTo :: Lens' LayeredEffectDefinition (EffectMonad CardMatcher)

leEffect :: Lens' LayeredEffectDefinition LayeredEffect

leName :: Lens' LayeredEffectDefinition EffectName

stepFork :: Lens' Step (Maybe String)

stepNumber :: Lens' Step Int

mkStep :: StepIdentifier -> String -> Board -> Step

cardLocation :: Lens' Card (Player, Location)

cardPower :: Lens' Card Int

cardToughness :: Lens' Card Int

cardController :: Lens' Card Player

manaPoolFor :: Functor f => Player -> ([Char] -> f [Char]) -> Board -> f Board

_manaPoolForTyping :: Board -> ManaPool

emptyEnv :: Env

mkStrength :: (Int, Int) -> CardStrength

emptyCard :: Card

mkCard :: CardName -> (Player, Location) -> Card

opposing :: Player -> Player

emptyBoard :: Board

module Dovin.Matchers

view :: MonadReader s m => Getting a s a -> m a

View the value pointed to by a Getter, Iso or Lens or the result of folding over all the results of a Fold or Traversal that points at a monoidal value.

view . to ≡ id

>>> view (to f) a
f a

>>> view _2 (1,"hello")
"hello"

>>> view (to succ) 5
6

>>> view (_2._1) ("hello",("world","!!!"))
"world"

As view is commonly used to access the target of a Getter or obtain a monoidal summary of the targets of a Fold, It may be useful to think of it as having one of these more restricted signatures:

view ::             Getter s a     -> s -> a
view :: Monoid m => Fold s m       -> s -> m
view ::             Iso' s a       -> s -> a
view ::             Lens' s a      -> s -> a
view :: Monoid m => Traversal' s m -> s -> m

In a more general setting, such as when working with a Monad transformer stack you can use:

view :: MonadReader s m             => Getter s a     -> m a
view :: (MonadReader s m, Monoid a) => Fold s a       -> m a
view :: MonadReader s m             => Iso' s a       -> m a
view :: MonadReader s m             => Lens' s a      -> m a
view :: (MonadReader s m, Monoid a) => Traversal' s a -> m a

withEffect

Arguments

:: CardMatcher

A matcher that must apply to this card for this affect to apply. matchInPlay is a typical value.

-> (Card -> CardMatcher)

Given the current card, return a matcher that matches cards that this affect applies to.

-> (Card -> Identity Card)

Apply an effect to the given card.

-> GameMonad ()

-> GameMonad ()

Add an effect to the created card.