Package net.royalur.rules.state

Class ResignedGameState

java.lang.Object

net.royalur.rules.state.GameState

net.royalur.rules.state.ControlGameState

net.royalur.rules.state.ResignedGameState

public class ResignedGameState
extends ControlGameState

A game state that represents a player resigning from a game.

Constructor Summary

Constructors

Constructor	Description
ResignedGameState(Board board, PlayerState lightPlayer, PlayerState darkPlayer, long timeSinceGameStartMs, PlayerType player)	Instantiates a game state representing a player resigning from a game.

Method Summary

Modifier and Type	Method	Description
String	describe()	Generates an English text description of the state of the game.
boolean	equals(Object obj)

Methods inherited from class net.royalur.rules.state.ControlGameState

getPlayer, getSubject, hasPlayer, isFinished, isPlayable

Methods inherited from class net.royalur.rules.state.GameState

addMetadata, addMetadata, clearMetadata, getBoard, getDarkPlayer, getLightPlayer, getMetadata, getMetadata, getPlayerState, getTimeSinceGameStartMs, hasMetadata, removeMetadata

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ResignedGameState

public ResignedGameState(Board board,
 PlayerState lightPlayer,
 PlayerState darkPlayer,
 long timeSinceGameStartMs,
 PlayerType player)

Instantiates a game state representing a player resigning from a game.

Parameters:

board - The state of the pieces on the board.

lightPlayer - The state of the light player.

darkPlayer - The state of the dark player.

timeSinceGameStartMs - The time this state was created.

player - The player who resigned the game.

Method Details

describe

public String describe()

Description copied from class: GameState

Generates an English text description of the state of the game.

Specified by:

describe in class GameState

Returns:

An English text description of the state of the game.

equals

public boolean equals(Object obj)

Overrides:

equals in class ControlGameState