Game.Werewolf.Game

Game functions are defined in Game.Werewolf.Internal.Game. This module just re-exports the functions relevant to the public interface.

Game

data Game

There are a few key pieces of information that a game always needs to hold. These are:

• the stage,
• the round number,
• the players and
• the events.

Any further fields on the game are specific to one or more roles (and their respective turns!). Some of the additional fields are reset each round (e.g., the Seer's see) while others are kept around for the whole game (e.g., the Wild-child's roleModel).

In order to advance a game's state, a Command from a user needs to be received. Afterwards the following steps should be performed:

1. apply the Command.
2. run checkStage.
3. run checkGameOver.

checkStage will perform any additional checks and manipulations to the game state before advancing the game's stage. It also runs any relevant events. checkGameOver will check to see if any of the win conditions are met and if so, advance the game's stage to GameOver.

Instances

Eq Game

Read Game

Show Game

stage :: Lens' Game Stage

round :: Lens' Game Int

players :: Lens' Game [Player]

events :: Lens' Game [Event]

passes :: Lens' Game [Text]

allowedVoters :: Lens' Game [Text]

heal :: Lens' Game Bool

healUsed :: Lens' Game Bool

poison :: Lens' Game (Maybe Text)

poisonUsed :: Lens' Game Bool

priorProtect :: Lens' Game (Maybe Text)

protect :: Lens' Game (Maybe Text)

roleModel :: Lens' Game (Maybe Text)

scapegoatBlamed :: Lens' Game Bool

see :: Lens' Game (Maybe Text)

villageIdiotRevealed :: Lens' Game Bool

votes :: Lens' Game (Map Text Text)

data Stage

Most of these are fairly self-sufficient (the turn stages). Sunrise and Sunset are provided as meaningful breaks between the day and night as, for example, a VillagesTurn may not always be available (curse that retched Scapegoat).

Once the game reaches a turn stage, it requires a Command to help push it past. Often only certain roles and commands may be performed at any given stage.

Constructors

GameOver

DefendersTurn

ScapegoatsTurn

SeersTurn

Sunrise

Sunset

UrsussGrunt

VillagesTurn

WerewolvesTurn

WildChildsTurn

WitchsTurn

WolfHoundsTurn

Instances

Eq Stage

Read Stage

Show Stage

data Event

Events occur after a stage is advanced. This is automatically handled in checkStage, while an event's specific behaviour is defined by eventAvailable and applyEvent.

For the most part events are used to allow something to happen on a stage different to when it was triggered. E.g., the devour event occurs after the village wakes up rather than when the Werewolves' vote, this gives the Witch a chance to heal the victim.

Constructors

DevourEvent Text

Werewolves

NoDevourEvent

Defender, Werewolves and Witch

PoisonEvent Text

Witch

Instances

Eq Event

Read Event

Show Event

Queries

isDefendersTurn :: Game -> Bool

isDefendersTurn game = game ^. stage == DefendersTurn

isGameOver :: Game -> Bool

isGameOver game = game ^. stage == GameOver

isScapegoatsTurn :: Game -> Bool

isScapegoatsTurn game = game ^. stage == ScapegoatsTurn

isSeersTurn :: Game -> Bool

isSeersTurn game = game ^. stage == SeersTurn

isSunrise :: Game -> Bool

isSunrise game = game ^. stage == Sunrise

isSunset :: Game -> Bool

isSunset game = game ^. stage == Sunset

isVillagesTurn :: Game -> Bool

isVillagesTurn game = game ^. stage == VillagesTurn

isWerewolvesTurn :: Game -> Bool

isWerewolvesTurn game = game ^. stage == WerewolvesTurn

isWildChildsTurn :: Game -> Bool

isWildChildsTurn game = game ^. stage == WildChildsTurn

isWitchsTurn :: Game -> Bool

isWitchsTurn game = game ^. stage == WitchsTurn

isWolfHoundsTurn :: Game -> Bool

isWolfHoundsTurn game = game ^. stage == WolfHoundsTurn

doesPlayerExist :: Text -> Game -> Bool

Queries whether the player is in the game.