scala-showdown-api
API
Generated with
scala-showdown-api/io.github.pidoveproject.showdown/io.github.pidoveproject.showdown.client/ShowdownClient

ShowdownClient

io.github.pidoveproject.showdown.client.ShowdownClient
trait ShowdownClient[Frame, Task[_, _], Stream[_], Resource[_]]

A client to communicate with a Pokemon Showdown server. This is the main entry point of the API.

Type parameters

Frame

the type of web socket frame

Task

the type of a task

Attributes

Returns

the authentication response sent by the server

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Members list

Value members

Abstract methods

def login(challStr: ChallStr)(name: Username, password: String): Task[ProtocolError, LoginResponse]

Login to a registered account.

Login to a registered account.

Value parameters

challStr

the token used for authentication

name

the name of the account

password

the password of the account

Attributes

Returns

the authentication response sent by the server

def loginGuest(challStr: ChallStr)(name: Username): Task[ProtocolError, Assertion]

Login as guest.

Login as guest.

Value parameters

challStr

the token used for authentication

name

the name to take in game

Attributes

Returns

the guest's name if the authentication succeeds

def openConnection(serverUrl: URL): Resource[ShowdownConnection[Frame, Task, Stream]]

Open a connection to the pokemon showdown server.

Open a connection to the pokemon showdown server.

Attributes

Generated with