Islands State v0.1.6 Islands.State View Source

Implements a state machine for the Game of Islands.

Inspired by the book Functional Web Development by Lance Halvorsen.

Link to this section Summary

Types

t()

Functions

check(state, arg2)

fetch(state, key)

Callback implementation for Access.fetch/2.

get(state, key, default)

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()

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

player_state()

player_state() :: :islands_not_set | :islands_set

request()

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

t()

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

Link to this section Functions

check(state, arg2)

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

fetch(state, key)

Callback implementation for Access.fetch/2.

get(state, key, default)

get_and_update(state, key, fun)

Callback implementation for Access.get_and_update/3.

new()

new() :: t()

pop(state, key)

Callback implementation for Access.pop/2.