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

A state struct and functions for the Game of Islands.

The state struct contains the fields game_state, player1_state and player2_state for implementing a state machine in the Game of Islands.

Based on the book Functional Web Development by Lance Halvorsen.

Summary

Types

event()

State machine event

game_state()

Game state

player_state()

Player state

t()

A state struct for the Game of Islands

Functions

check(state, event)

Decides whether to permit the state/event combination. Also decides whether to transition to a new state. Returns {:ok, new_state} if the combination is permissible. Returns :error if it is not.

fetch(state, key)

Callback implementation for Access.fetch/2.

get_and_update(state, key, fun)

Callback implementation for Access.get_and_update/3.

new()

Creates a new state struct.

pop(state, key)

Callback implementation for Access.pop/2.

Types

event()

@type event() ::
  :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}

State machine event

game_state()

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

Game state

player_state()

@type player_state() :: :islands_not_set | :islands_set

Player state

t()

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

A state struct for the Game of Islands

Functions

check(state, event)

@spec check(t(), event()) :: {:ok, t()} | :error

Decides whether to permit the state/event combination. Also decides whether to transition to a new state. Returns {:ok, new_state} if the combination is permissible. Returns :error if it is not.

fetch(state, key)

Callback implementation for Access.fetch/2.

get_and_update(state, key, fun)

Callback implementation for Access.get_and_update/3.

new()

@spec new() :: t()

Creates a new state struct.

Examples

iex> Islands.State.new()
%Islands.State{
  game_state: :initialized,
  player1_state: :islands_not_set,
  player2_state: :islands_not_set
}

pop(state, key)

Callback implementation for Access.pop/2.