ShowdownData

io.github.pidoveproject.showdown.ShowdownData

See theShowdownData companion object

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.

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

Companion: object
Source: ShowdownData.scala
Graph
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Get the room information from an id.

Returns: the room with the given id or an empty instance if it does not exist
Source: ShowdownData.scala

Get the details of a user.

Check if the client is logged with the given name.

Update this data according to the passed server event/message.

In this article

Generated with