Packages

class Player extends AnyRef

Holds player information and is backed by an ELO rating engine to update the player's rating. Also contains tournament and game history.

Players can play games against other players, here is an example following the example from wikipedia https://en.wikipedia.org/wiki/Elo_rating_system#Mathematical_details

val playerA = new Player(rating = 1613)
val opponent1 = new Player(rating = 1609)
val opponent2 = new Player(rating = 1477)
val opponent3 = new Player(rating = 1388)
val opponent4 = new Player(rating = 1586)
val opponent5 = new Player(rating = 1720)

playerA loses opponent1
playerA draws opponent2
playerA wins opponent3
playerA wins opponent4
playerA loses opponent5

playerA.updateRating(KFactor.USCF) // If not specified the Simple K-Factor is used
playerA.rating // playerA now has a rating of 1601

The class can be extended as shown:

// An example class that requires a name, rating, and player's always start at 0 games.
class NamedPlayer(val name: String, rating: Int) extends Player(rating, 0) {

  // Some possible methods that can be added.
  def isPro: Boolean = if (rating > 2400) true else false
  def isNew: Boolean = if (gamesPlayed < 30) true else false

  // Change the default KFactor to USCF.
  def updateRating(): Unit = super.updateRating(KFactor.USCF)

  // Or create a custom KFactor
  def updateRating(): Unit = {
    val customerFactor = if (isPro) 10 else 400 / gamesPlayed
    super.updateRating(customerFactor)
  }
}

val myPlayer = new NamedPlayer("My Player Name", 1613)
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Player
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Player(rating: Int = 1400, startingGameCount: Int = 0)

    rating

    Player's starting rating, defaulted to 1400

    startingGameCount

    How many games the player has already played, defaulted to 0

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. def draws(opponent: Player): Unit

    Adds draw to the player history and draw to opponent's

    Adds draw to the player history and draw to opponent's

    opponent

    Opposing player

    Example: 

    1. players draws opponent
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def gameHistory: List[Game]

    returns

    Games history

  11. def gamesPlayed: Int

    returns

    Total games played

  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hasAlreadyPlayed(opponent: Player): Boolean

    opponent

    Player to check against

    returns

    Returns true if the player has played the opponent

  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def loses(opponent: Player): Unit

    Adds loss to the player history and win to opponent's

    Adds loss to the player history and win to opponent's

    opponent

    Opposing player

    Example: 

    1. players loses opponent
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. def plays(opponent: Player): Matchup

    opponent

    Opposing player

    returns

    Returns a matchup between player and opponent

    Example: 

    1. val matchup = players plays opponent
  21. var rating: Int
  22. val startingGameCount: Int
  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. def tournamentHistory: List[Game]

    returns

    Active tournament history

  26. def updateRating(kFactor: Double): Unit

    Updates the player's rating and clears tournament history

    Updates the player's rating and clears tournament history

    kFactor

    Custom K-Factor value or function

  27. def updateRating(kFactorType: KFactor = KFactor.SIMPLE): Unit

    Updates player's rating and clears tournament history

    Updates player's rating and clears tournament history

    kFactorType

    What K-Factor formula to use when calculating the rating

  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  31. def wins(opponent: Player): Unit

    Adds win to the player history and loss to opponent's

    Adds win to the player history and loss to opponent's

    opponent

    Opposing player

    Example: 

    1. players wins opponent

Inherited from AnyRef

Inherited from Any

Ungrouped