Islands.Client.State (Islands Client State v0.1.11) View Source

Creates a client state struct for the Game of Islands.

Inspired by the course Elixir for Programmers by Dave Thomas.

Link to this section Summary

Types

t()

Functions

new(game_name, player_id, player_name, gender, options \\ [])

Link to this section Types

t()

Specs

t() :: %Islands.Client.State{
  game_name: Islands.Game.name(),
  gender: Islands.Player.gender(),
  mode: :manual | :auto,
  move: [String.codepoint() | non_neg_integer() | String.t()],
  pause: 0..10000,
  player_id: Islands.PlayerID.t(),
  player_name: Islands.Player.name(),
  tally: Islands.Tally.t() | nil
}

Link to this section Functions

new(game_name, player_id, player_name, gender, options \\ [])

Specs

new(
  Islands.Game.name(),
  Islands.PlayerID.t(),
  Islands.Player.name(),
  atom(),
  Keyword.t()
) :: t()