Islands.State (Islands State v0.1.13) View Source

Implements a state machine for the Game of Islands.

Based on the book Functional Web Development by Lance Halvorsen.

Link to this section Summary

Types

game_state()

player_state()

request()

t()

Functions

check(state, arg2)

fetch(state, key)

Callback implementation for Access.fetch/2.

get_and_update(state, key, fun)

Callback implementation for Access.get_and_update/3.

new()

pop(state, key)

Callback implementation for Access.pop/2.

Link to this section Types

game_state()

Specs

game_state() ::
  :initialized | :players_set | :player1_turn | :player2_turn | :game_over

player_state()

Specs

player_state() :: :islands_not_set | :islands_set

request()

Specs

request() ::
  :add_player
  | {:position_island, Islands.PlayerID.t()}
  | {:position_all_islands, Islands.PlayerID.t()}
  | {:set_islands, Islands.PlayerID.t()}
  | {:guess_coord, Islands.PlayerID.t()}
  | {:stop, Islands.PlayerID.t()}
  | {:win_check, :no_win | :win}

t()

Specs

t() :: %Islands.State{
  game_state: game_state(),
  player1_state: player_state(),
  player2_state: player_state()
}

Link to this section Functions

check(state, arg2)

Specs

check(t(), request()) :: {:ok, t()} | :error

fetch(state, key)

Callback implementation for Access.fetch/2.

get_and_update(state, key, fun)

Callback implementation for Access.get_and_update/3.

new()

Specs

new() :: t()

pop(state, key)

Callback implementation for Access.pop/2.