yatzy v1.0.0 Yatzy.Player View Source

Module for player interactions

Link to this section Summary

t()

Creating a new player with an empty score sheet.

Rolling the dice for the player

Saving the current roll in the score sheet

Calculating a user's total score

t() :: %Yatzy.Player{
  current_roll: Yatzy.Roll.t(),
  name: String.t(),
  sheet: Yatzy.Sheet.t()
}

new(name :: String.t()) :: t()

Creating a new player with an empty score sheet.

iex> Yatzy.Player.new("Bob")
%Yatzy.Player{name: "Bob", sheet: %Yatzy.Sheet{}, current_roll: %Yatzy.Roll{}}

roll(player :: t(), opts :: Yatzy.Roll.options()) :: t()

Rolling the dice for the player

save(player :: t(), rule :: atom()) :: t()

Saving the current roll in the score sheet

score(player :: t()) :: integer()

Calculating a user's total score