Documentation

Spots that can be attacked from a spot. Spot as argument is in one player part while spots returned are in the other player part. The order in the result matters, the first element is the first spot attacked, then the second element is attacked if the first spot is empty or if the creature can attack multiple spots for some reasons.

All possible targets

An animation that makes sense at the Game level. If you consider extending this variant, consider whether it would be be better in Board.T 'UI

board id pSpot target holds iff player at pSpot can play card id on target

The order in which cards attack

The cards to draw, the Boolean indicates whether to bound by the stack's length or not

Spots that can be attacked by a creature. Spot as argument is in one player part while spots returned are in the other player part. The order in the result matters, the first element is the first spot attacked, then the second element is attacked if the first spot is empty or if the creature can attack multiple spots for some reasons.

The index of the card with this ID, in the hand of the player at the given spot

The reason for drawing a card

Translates an Event into an animation displayed in the middle of the Board.

Type to handle various custom skills when resolving attacks

If you add an event that triggers automatically, you should likely extend mkEvents

'keepEffectfull board es' returns the elements of es that have an effect. Elements of es are played in sequence.

Try to play an event. If the event cannot be played or a hard error occurs (MonadError Text _ in other functions of this API), simply return Nothing.

To allow callers to hide the implementation of Playable, to avoid fields names conflicts.

nextAttackSpot b pSpot cSpot returns the spots to attack after cSpot. If cSpot is Nothing, the first spot in the order is considered; if cSpot is Just _, then spots after cSpot are considered.

If pre End Turn events are changed in Move, this function may have to be adapted to play the events beforehand. This should be discovered automatically, as this property is checked with a PBT.

Placing events. These events are the ones that the AI generates (as opposed to the more general Event type).

The input type to most play* functions

The result of playing game events. If you add a field, extend the Eq instance below. TODO @smelc find a better name.

Play a single Event on the given Board. Monad version is playM below. If the event cannot be played, the input board is returned as is. Use tryPlayM for the version distinguishing the error and success cases.

A variant of play and playE that is only in the error monad. This function returns the input board if the event is unapplicable. That is why this function doesn't have Impossible in its return type.

Play a list of events, playing newly produced events as they are being produced. That is why, contrary to play, this function doesn't return events: it consumes them all eagerly. See playAllM for the monad version

Like playAll, but in the error monad. This function skips unapplicable events. That is why its return type doesn't have Impossible.

The Player in a Place, i.e. the player playing an event

A change in stats of a creature. Using Nat for now because it suffices for the use cases. But really it could be a Int, it just makes apply harder.

On what a card can be applied

To which part to apply a card. Beneficial card apply to Playing while cards giving maluses, curses, etc. apply to Opponent.

Whether a card makes sense on the playing player or the opponent. We could even try both, but we don't do that for now