TournamentMessage

io.github.pidoveproject.showdown.protocol.server.TournamentMessage
See theTournamentMessage companion object

A message bound to a tournament

Attributes

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

Members list

Type members

Enum entries

final case class AutoDq(state: TournamentAutoDq)

An update on the auto-disqualification policy.

An update on the auto-disqualification policy.

Value parameters

state

the new policy on auto-disqualification

Attributes

Source
TournamentMessage.scala
final case class AutoStart(state: TournamentAutoStart)

An update on the auto-starting policy.

An update on the auto-starting policy.

Value parameters

state

the new policy on auto-starting

Attributes

Source
TournamentMessage.scala
final case class BattleEnd(firstUser: Username, secondUser: Username, result: BattleResult, score: BattleScore, recorded: TournamentRecord, room: RoomId)

A tournament battle ended

A tournament battle ended

Value parameters

firstUser

the first battle participant

recorded

fail if the result is a draw and the tournament does not support it, success otherwise

result

the result of the battle from firstUser perspective

room

the id of the battle room

score

the current score of both players

secondUser

the second battle participant

Attributes

Source
TournamentMessage.scala
final case class BattleStart(firstUser: Username, secondUser: Username, room: RoomId)

A tournament battle started.

A tournament battle started.

Value parameters

firstUser

the first battle participant

room

the id of the battle room

secondUser

the second battle participant

Attributes

Source
TournamentMessage.scala
final case class Create(format: FormatName, generator: TournamentGenerator, playerCap: Count)

A new tournament has been created.

A new tournament has been created.

Value parameters

format

the format of the battles of this tournament

generator

the generator of the tournament. Either elimination tree or round robin

Attributes

Source
TournamentMessage.scala
final case class Disqualify(user: Username)

A user got disqualified.

A user got disqualified.

Value parameters

user

the disqualified participant

Attributes

Source
TournamentMessage.scala
final case class End(data: TournamentEnd)

The tournament ended gracefully.

The tournament ended gracefully.

Value parameters

data

details about the tournament ending

Attributes

Source
TournamentMessage.scala
final case class Error(error: String)

A tournament-bound error occurred.

A tournament-bound error occurred.

Attributes

Source
TournamentMessage.scala
final case class ForceEnd()

The tournament was forcibly ended.

The tournament was forcibly ended.

Attributes

Source
TournamentMessage.scala
final case class Join(user: Username)

A user joined the tournament.

A user joined the tournament.

Attributes

Source
TournamentMessage.scala
final case class Leave(user: Username)

A user left the tournament.

A user left the tournament.

Attributes

Source
TournamentMessage.scala
final case class Replace(old: Username, current: Username)

A user was replaced by another.

A user was replaced by another.

Value parameters

current

the substitute user

old

the previous user

Attributes

Source
TournamentMessage.scala
final case class Scouting(setting: TournamentSetting)

Users are now either allowed or disallowed to join other tournament battles (aka scout).

Users are now either allowed or disallowed to join other tournament battles (aka scout).

Value parameters

setting

the new rule about scouting

Attributes

Source
TournamentMessage.scala
final case class Start(numPlayers: Count)

The tournament started.

The tournament started.

Value parameters

numPlayers

the number of participants

Attributes

Source
TournamentMessage.scala
final case class Update(data: TournamentUpdate)

An update on the current tournament.

An update on the current tournament.

Value parameters

data

the updated data of the tournament

Attributes

Source
TournamentMessage.scala
final case class UpdateEnd()

End of the tournament update.

End of the tournament update.

Attributes

Source
TournamentMessage.scala