yatzy v1.0.0 Yatzy.Game View Source

Game module responsible for :

starting a new game
delegating player interactions based on game's turn
finishing a game

Link to this section Summary

Types

t()

Functions

Finish the game and calculate the results

new(player_names, options \\ [])

Create a new game with a list of players

roll(game, player_name, opts \\ [])

(Re)Rolling the dice for a given player

save(game, player_name, rule)

Saving a player's current roll and ending that player's turn.

Link to this section Types

options()

options() :: [initial_player :: String.t()]

t()

t() :: %Yatzy.Game{
  current_player: String.t() | nil,
  players: %{required(String.t()) => Yatzy.Player.t()} | nil,
  result: :pending | Yatzy.Result.t()
}

Link to this section Functions

finish(game)

finish(game :: t()) :: t()

Finish the game and calculate the results

new(player_names, options \\ [])

new(player_names :: [String.t()], options :: options()) :: t()

Create a new game with a list of players

roll(game, player_name, opts \\ [])

roll(game :: t(), player_name :: String.t(), opts :: Yatzy.Roll.options()) ::
  t()

(Re)Rolling the dice for a given player

save(game, player_name, rule)

save(game :: t(), player_name :: String.t(), rule :: atom()) :: t()

Saving a player's current roll and ending that player's turn.