Islands Text Client v0.2.20 Islands.Text.Client View Source
Text client for the Game of Islands.
Link to this section Summary
Link to this section Functions
Link to this function
join(game_name, player2_name, gender, options \\ [])
View Source
join(game_name, player2_name, gender, options \\ [])
View Source
join(String.t(), String.t(), Islands.Player.gender(), Keyword.t()) ::
no_return()
join(String.t(), String.t(), Islands.Player.gender(), Keyword.t()) :: no_return()
Lets player2 join a game.
Player2 runs in a node with any short name (here client2
)...
cd islands_text_client
iex --sname client2 -S mix
Player2 (Eve
) joins game Eden
from her node like so:
Islands.Text.Client.join("Eden", "Eve", :f)
Parameters
game_name
- game name (string)player2_name
- player2 name (string)gender
- gender as either :f or :m (atom)options
- up to 2 options (keyword)
Options
:mode
- (:manual
or:auto
) specifies whether player2 will play in manual or auto mode; defaults to:manual
.:pause
- (nonnegative integer) specifies the duration in milliseconds of the pause between moves in auto mode (should be between 0 and 10,000); defaults to 0 milliseconds.
Link to this function
start(game_name, player1_name, gender, options \\ [])
View Source
start(game_name, player1_name, gender, options \\ [])
View Source
start(String.t(), String.t(), Islands.Player.gender(), Keyword.t()) ::
no_return()
start(String.t(), String.t(), Islands.Player.gender(), Keyword.t()) :: no_return()
Lets player1 start a game.
App islands_engine
must run in node with short name islands
...
cd islands_engine
iex --sname islands -S mix
:observer.start # optional to observe the game(s) being played
Player1 runs in a node with any short name (here client1
)...
cd islands_text_client
iex --sname client1 -S mix
Player1 (Adam
) starts a game (Eden
) from his node like so:
Islands.Text.Client.start("Eden", "Adam", :m)
Parameters
game_name
- game name (string)player1_name
- player1 name (string)gender
- gender as either :f or :m (atom)options
- up to 2 options (keyword)
Options
:mode
- (:manual
or:auto
) specifies whether player1 will play in manual or auto mode; defaults to:manual
.:pause
- (nonnegative integer) specifies the duration in milliseconds of the pause between moves in auto mode (should be between 0 and 10,000); defaults to 0 milliseconds.