Pokemon Showdown API
0.0.0-64-5fb1ac-SNAPSHOT
DocsAPI
Generated with
Pokemon Showdown API/io.github.pidoveproject.showdown

io.github.pidoveproject.showdown

package io.github.pidoveproject.showdown

Members list

Packages

package io.github.pidoveproject.showdown.battle
package io.github.pidoveproject.showdown.client
package io.github.pidoveproject.showdown.protocol
package io.github.pidoveproject.showdown.room
package io.github.pidoveproject.showdown.team
package io.github.pidoveproject.showdown.tyrian
package io.github.pidoveproject.showdown.user
package io.github.pidoveproject.showdown.util

Type members

Classlikes

object ChallStr extends RefinedTypeOps[String, FixedLength[258], ChallStr]

Attributes

Source
package.scala
Supertypes
trait RefinedTypeOps[String, FixedLength[258], ChallStr]
class Object
trait Matchable
class Any
Self type
ChallStr.type
object Count extends NumericTypeOps[Int, GreaterEqual[0], Count]

Attributes

Source
package.scala
Supertypes
trait NumericTypeOps[Int, GreaterEqual[0], Count]
trait RefinedTypeOps[Int, GreaterEqual[0], Count]
class Object
trait Matchable
class Any
Self type
Count.type
case class Format(name: FormatName, random: Boolean, searchOnly: Boolean, challengeOnly: Boolean)

Represents a battle format e.g. OU 9G format

Represents a battle format e.g. OU 9G format

Value parameters

challengeOnly

whether this format is only available when challenging a user or not

name

the name of this format e.g gen9ou

random

whether this format uses random teams or not

searchOnly

whether this format can only be searched (therefore not played) or not

Attributes

Companion
object
Source
Format.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Format

Attributes

Companion
class
Source
Format.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Format.type
case class FormatCategory(name: FormatCategoryName, column: Int, formats: List[Format])

A format category.

A format category.

Value parameters

column

the displayed column of this category (used in Showdown's format selection menu)

formats

the formats of this category

name

this category's name

Attributes

Companion
object
Source
FormatCategory.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FormatCategory

Attributes

Companion
class
Source
FormatCategory.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object FormatCategoryName extends RefinedTypeOps[String, Not[Blank], FormatCategoryName]

Attributes

Source
package.scala
Supertypes
trait RefinedTypeOps[String, Not[Blank], FormatCategoryName]
class Object
trait Matchable
class Any
Self type
object FormatName extends RefinedTypeOps[String, Not[Blank], FormatName]

Attributes

Source
package.scala
Supertypes
trait RefinedTypeOps[String, Not[Blank], FormatName]
class Object
trait Matchable
class Any
Self type
FormatName.type
case class GameSearch(searching: List[FormatName], games: Map[String, String])

Informations about the current search.

Informations about the current search.

Value parameters

games

the found games

searching

the searched formats

Attributes

Companion
object
Source
GameSearch.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GameSearch

Attributes

Companion
class
Source
GameSearch.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
GameSearch.type
object Generation extends RefinedTypeOps[Int, Positive, Generation]

Attributes

Source
package.scala
Supertypes
trait RefinedTypeOps[Int, Positive, Generation]
class Object
trait Matchable
class Any
Self type
Generation.type
case class ShowdownData(userCount: Option[Count], battleCount: Option[Count], challStr: Option[ChallStr], loggedUser: Option[LoggedUser], gameSearch: GameSearch, formatCategories: List[FormatCategory], joinedRooms: Map[RoomId, JoinedRoom], battleRooms: Map[String, BattleRoomInfo], chatRooms: Map[String, ChatRoomInfo], userDetails: Map[String, UserInfo])

The state of the Showdown connection.

The state of the Showdown connection.

Value parameters

battleCount

the number of currently-playing battles

battleRooms

the currently-playing battle rooms

challStr

the challstr of the session

chatRooms

the available chat rooms

formatCategories

the formats and categories available on the connected server

gameSearch

the current state of game matchmaking

joinedRooms

the room the logged user is currently connected to

loggedUser

the currently logged-in user

userCount

the number of online users

userDetails

the details of other users

Attributes

Companion
object
Source
ShowdownData.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ShowdownData

Attributes

Companion
class
Source
ShowdownData.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object Timestamp extends RefinedTypeOps[Long, GreaterEqual[0], Timestamp]

Attributes

Source
package.scala
Supertypes
trait RefinedTypeOps[Long, GreaterEqual[0], Timestamp]
class Object
trait Matchable
class Any
Self type
Timestamp.type
object json

Attributes

Source
json.scala
Supertypes
class Object
trait Matchable
class Any
Self type
json.type

Types

opaque type ChallStr

Attributes

Source
package.scala
opaque type Count

Attributes

Source
package.scala
opaque type FormatCategoryName

Attributes

Source
package.scala
opaque type FormatName

Attributes

Source
package.scala
opaque type Generation

Attributes

Source
package.scala
opaque type Timestamp

Attributes

Source
package.scala

Givens

Givens

Generated with