Packages

islands_player

0.1.4
0.1.41 0.1.40 0.1.39 0.1.38 0.1.37 0.1.36 0.1.35 0.1.34 0.1.33 0.1.32 0.1.31 0.1.30 0.1.29 0.1.28 0.1.27 0.1.26 0.1.25 0.1.24 0.1.23 0.1.22 0.1.21 0.1.20 0.1.19 0.1.18 0.1.17 0.1.16 0.1.15 0.1.14 0.1.13 0.1.12 0.1.11 0.1.10 0.1.9 0.1.8 0.1.7 0.1.6 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1

Creates a player struct for the Game of Islands.

HexDocs

Current section

Files

Jump to
Readme
41 Versions
5 Dependencies
Dependants
Files
Activity
islands_player lib islands player.ex
Raw

lib/islands/player.ex 

# ┌────────────────────────────────────────────────────────────────────┐

# │ Based on the book "Functional Web Development" by Lance Halvorsen. │

# └────────────────────────────────────────────────────────────────────┘

defmodule Islands.Player do

  use PersistConfig



  @book_ref Application.get_env(@app, :book_ref)



  @moduledoc """

  Creates a `player` struct for the _Game of Islands_.

  \n##### #{@book_ref}

  """



  alias __MODULE__

  alias Islands.{Board, Guesses}



  @type gender :: :f | :m



  @derive {Poison.Encoder, only: [:name, :gender, :board, :guesses]}

  @derive {Jason.Encoder, only: [:name, :gender, :board, :guesses]}

  @enforce_keys [:name, :gender, :pid]

  defstruct name: "",

            gender: nil,

            pid: nil,

            board: Board.new(),

            guesses: Guesses.new()



  @type t :: %Player{

          name: String.t(),

          gender: gender,

          pid: pid | nil,

          board: Board.t(),

          guesses: Guesses.t()

        }



  @spec new(String.t(), gender, pid | nil) :: t | {:error, atom}

  def new(name, gender, pid)

      when is_binary(name) and gender in [:f, :m] and

             (is_pid(pid) or is_nil(pid)),

      do: %Player{name: name, gender: gender, pid: pid}



  def new(_name, _gender, _pid), do: {:error, :invalid_player_args}

end