Game.Werewolf.Internal.Player

Players are quite simple in themselves. They have a name, role and state. Any complex behaviour is handled in Game.Werewolf.Command and Game.Werewolf.Engine. This module provides utility functions for searching, filtering and querying lists of players based on these 3 attributes.

Player

data Player

A player has a name, role and state. Any stateful information needed for a player's role is held on the Game itself.

N.B., player equality is defined on just the name as a player's role may change throughout the game.

Instances

Eq Player

Read Player

Show Player

name :: Lens' Player Text

role :: Lens' Player Role

state :: Lens' Player State

data State

Surprise surprise, players may be dead or alive.

Constructors

Alive

Dead

Instances

Eq State

Read State

Show State

newPlayer :: Text -> Role -> Player

Creates a new Alive player.

Searches

findByName :: Text -> [Player] -> Maybe Player

Attempts to find the first player in the list with the given name.

findByName_ :: Text -> [Player] -> Player

Finds the first player in the list with the given name.

findByName_ name = fromJust . findByName name

findByRole :: Role -> [Player] -> Maybe Player

Attempts to find the first player in the list with the given role.

findByRole_ :: Role -> [Player] -> Player

Finds the first player in the list with the given role.

findByRole_ role = fromJust . findByRole role

Filters

filterByRole :: Role -> [Player] -> [Player]

Filters players by role.

filterWerewolves :: [Player] -> [Player]

Filters players by allegiance, not role. If you're after filtering by role, try filterByRole simpleWerewolfRole.

filterWerewolves = filter isWerewolf

filterAlive :: [Player] -> [Player]

filterAlive = filter isAlive

filterDead :: [Player] -> [Player]

filterDead = filter isDead

Queries

isAngel :: Player -> Bool

isAngel player = player ^. role == angelRole

isBearTamer :: Player -> Bool

isBearTamer player = player ^. role == bearTamerRole

isDefender :: Player -> Bool

isDefender player = player ^. role == defenderRole

isScapegoat :: Player -> Bool

isScapegoat player = player ^. role == scapegoatRole

isSeer :: Player -> Bool

isSeer player = player ^. role == seerRole

isSimpleVillager :: Player -> Bool

isSimpleVillager player = player ^. role == simpleVillagerRole

isSimpleWerewolf :: Player -> Bool

isSimpleWerewolf player = player ^. role == simpleWerewolfRole

isVillageIdiot :: Player -> Bool

isVillageIdiot player = player ^. role == villageIdiotRole

isVillagerVillager :: Player -> Bool

isVillagerVillager player = player ^. role == villagerVillagerRole

isWildChild :: Player -> Bool

isWildChild player = player ^. role == wildChildRole

isWitch :: Player -> Bool

isWitch player = player ^. role == witchRole

isWolfHound :: Player -> Bool

isWolfHound player = player ^. role == wolfHoundRole

isVillager :: Player -> Bool

Queries a player's allegiance, not role. If you're after querying their role, try isSimpleVillager.

isVillager player = player ^. role . allegiance == Villagers

isWerewolf :: Player -> Bool

Queries a player's allegiance, not role. If you're after querying their role, try isSimpleWerewolf.

isWerewolf player = player ^. role . allegiance == Werewolves

isAlive :: Player -> Bool

isAlive player = player ^. state == Alive

isDead :: Player -> Bool

isDead player = player ^. state == Dead