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

Creates a client state struct for the Game of Islands.

The client state struct contains the fields game_name, player_name, gender, player_id, mode, pause, move and tally representing the characteristics of a client state in the Game of Islands.

Inspired by the course Elixir for Programmers by Dave Thomas.

Summary

Types

t()

A client state struct for the Game of Islands

Functions

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

Creates a client state struct for the Game of Islands.

Types

t()

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

A client state struct for the Game of Islands

Functions

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

@spec new(
  Islands.Game.name(),
  Islands.PlayerID.t(),
  Islands.Player.name(),
  Islands.Player.gender(),
  Keyword.t()
) :: t()

Creates a client state struct for the Game of Islands.