Internet Chess ToolKit
v0.2.0

ictk.boardgame.chess.net.ics.event
Class ICSBoardUpdateEvent

java.lang.Object
  extended byictk.boardgame.chess.net.ics.event.ICSEvent
      extended byictk.boardgame.chess.net.ics.event.ICSBoardUpdateEvent
All Implemented Interfaces:
ICSBoardEvent

public class ICSBoardUpdateEvent
extends ICSEvent
implements ICSBoardEvent

A board representation that indicates the client should update the local representation of the board. An example of this is Sytle12.


Field Summary
static int EVENT_TYPE
           
static int EXAMINING_RELATION
          this is an isolated position the user is looking at.
static int ISO_POSITION_RELATION
          this is an isolated position the user is looking at.
static int OBSERVING_EXAMINED_RELATION
          this is an isolated position the user is looking at.
static int OBSERVING_PLAY_RELATION
          this is an isolated position the user is looking at.
static int PLAYING_MY_MOVE_RELATION
          this is an isolated position the user is looking at.
static int PLAYING_NOT_MY_MOVE_RELATION
          this is an isolated position the user is looking at.
 
Fields inherited from class ictk.boardgame.chess.net.ics.event.ICSEvent
AUTO_SALUTE_EVENT, AVAIL_INFO_EVENT, BOARD_SAY_EVENT, BOARD_UPDATE_EVENT, CHALLENGE_EVENT, CHANNEL_EVENT, DEBUG, GAME_CREATED_EVENT, GAME_NOTIFICATION_EVENT, GAME_RESULT_EVENT, HISTORY_EVENT, KIBITZ_EVENT, MATCH_REQUEST_EVENT, MOVE_LIST_EVENT, NUM_EVENTS, PLAYER_CONNECTION_EVENT, PLAYER_NOTIFICATION_EVENT, QTELL_EVENT, SAY_EVENT, SEEK_AD_EVENT, SEEK_AD_READABLE_EVENT, SEEK_CLEAR_EVENT, SEEK_REMOVE_EVENT, SEEK_REMOVE_READABLE_EVENT, SHOUT_EVENT, TAKEBACK_REQUEST_EVENT, TELL_EVENT, TOURNAMENT_CHANNEL_EVENT, UNKNOWN_EVENT, USER_DEFINED_EVENT, WHISPER_EVENT
 
Fields inherited from interface ictk.boardgame.chess.net.ics.event.ICSBoardEvent
NO_BOARD
 
Constructor Summary
ICSBoardUpdateEvent()
           
 
Method Summary
 int getBlackClock()
           
 java.lang.String getBlackClockAsString()
           
 int getBlackMaterial()
           
 java.lang.String getBlackPlayer()
           
 char[][] getBoardArray()
           
 int getBoardNumber()
           
 int getEnPassantFile()
           
 int getIncrement()
           
 int getInitialTime()
           
 int getLag()
           
 int getMoveNumber()
           
 int getMoveTime()
           
 java.lang.String getMoveTimeAsString()
           
 int getPlySinceLastIrreversableMove()
           
 java.lang.String getReadable()
          this is completely temporary and only for diagnostic purposes.
 int getRelation()
           
 java.lang.String getSAN()
           
 java.lang.String getVerboseMove()
           
 int getWhiteClock()
           
 java.lang.String getWhiteClockAsString()
           
 int getWhiteMaterial()
           
 java.lang.String getWhitePlayer()
           
 boolean isBlackCastleableKingside()
           
 boolean isBlackCastleableQueenside()
           
 boolean isBlackMove()
           
 boolean isBlackToMove()
           
 boolean isClockMoving()
           
 boolean isFlipBoard()
           
 boolean isWhiteCastleableKingside()
           
 boolean isWhiteCastleableQueenside()
           
 void setBlackCastleableKingside(boolean t)
           
 void setBlackCastleableQueenside(boolean t)
           
 void setBlackClock(int ms)
           
 void setBlackMaterial(int value)
           
 void setBlackMove(boolean t)
           
 void setBlackPlayer(java.lang.String player)
           
 void setBoardArray(char[][] b)
           
 void setBoardNumber(int board)
           
 void setClockMoving(boolean t)
           
 void setEnPassantFile(int ep)
           
 void setFlipBoard(boolean t)
           
 void setIncrement(int seconds)
           
 void setInitialTime(int seconds)
           
 void setLag(int ms)
           
 void setMoveNumber(int num)
           
 void setMoveTime(int ms)
           
 void setPlySinceLastIrreversableMove(int ply)
           
 void setRelation(int pov)
           
 void setSAN(java.lang.String san)
           
 void setVerboseMove(java.lang.String move)
           
 void setWhiteCastleableKingside(boolean t)
           
 void setWhiteCastleableQueenside(boolean t)
           
 void setWhiteClock(int ms)
           
 void setWhiteMaterial(int value)
           
 void setWhitePlayer(java.lang.String player)
           
 java.lang.String toString()
           
 
Methods inherited from class ictk.boardgame.chess.net.ics.event.ICSEvent
DEBUG_getOriginal, getEventParser, getEventType, getMessage, getServer, getTimestamp, isFake, setEventParser, setEventType, setFake, setMessage, setOriginal, setServer, setTimestamp
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

EVENT_TYPE

public static final int EVENT_TYPE
See Also:
Constant Field Values

ISO_POSITION_RELATION

public static final int ISO_POSITION_RELATION
this is an isolated position the user is looking at. This arrises as a result of "ref 3" or the "sposition" command

See Also:
Constant Field Values

OBSERVING_EXAMINED_RELATION

public static final int OBSERVING_EXAMINED_RELATION
this is an isolated position the user is looking at. This arrises as a result of "ref 3" or the "sposition" command

See Also:
Constant Field Values

EXAMINING_RELATION

public static final int EXAMINING_RELATION
this is an isolated position the user is looking at. This arrises as a result of "ref 3" or the "sposition" command

See Also:
Constant Field Values

PLAYING_NOT_MY_MOVE_RELATION

public static final int PLAYING_NOT_MY_MOVE_RELATION
this is an isolated position the user is looking at. This arrises as a result of "ref 3" or the "sposition" command

See Also:
Constant Field Values

PLAYING_MY_MOVE_RELATION

public static final int PLAYING_MY_MOVE_RELATION
this is an isolated position the user is looking at. This arrises as a result of "ref 3" or the "sposition" command

See Also:
Constant Field Values

OBSERVING_PLAY_RELATION

public static final int OBSERVING_PLAY_RELATION
this is an isolated position the user is looking at. This arrises as a result of "ref 3" or the "sposition" command

See Also:
Constant Field Values
Constructor Detail

ICSBoardUpdateEvent

public ICSBoardUpdateEvent()
Method Detail

getBoardArray

public char[][] getBoardArray()

isBlackToMove

public boolean isBlackToMove()

getWhitePlayer

public java.lang.String getWhitePlayer()

getBlackPlayer

public java.lang.String getBlackPlayer()

getMoveNumber

public int getMoveNumber()

getEnPassantFile

public int getEnPassantFile()

getPlySinceLastIrreversableMove

public int getPlySinceLastIrreversableMove()

getBoardNumber

public int getBoardNumber()
Specified by:
getBoardNumber in interface ICSBoardEvent

getRelation

public int getRelation()

getInitialTime

public int getInitialTime()

getIncrement

public int getIncrement()

getWhiteMaterial

public int getWhiteMaterial()

getBlackMaterial

public int getBlackMaterial()

getWhiteClock

public int getWhiteClock()

getBlackClock

public int getBlackClock()

getLag

public int getLag()

getSAN

public java.lang.String getSAN()

isBlackMove

public boolean isBlackMove()

isWhiteCastleableKingside

public boolean isWhiteCastleableKingside()

isWhiteCastleableQueenside

public boolean isWhiteCastleableQueenside()

isBlackCastleableKingside

public boolean isBlackCastleableKingside()

isBlackCastleableQueenside

public boolean isBlackCastleableQueenside()

getMoveTime

public int getMoveTime()

getVerboseMove

public java.lang.String getVerboseMove()

isFlipBoard

public boolean isFlipBoard()

isClockMoving

public boolean isClockMoving()

getMoveTimeAsString

public java.lang.String getMoveTimeAsString()

getBlackClockAsString

public java.lang.String getBlackClockAsString()

getWhiteClockAsString

public java.lang.String getWhiteClockAsString()

setBoardArray

public void setBoardArray(char[][] b)

setBoardNumber

public void setBoardNumber(int board)
Specified by:
setBoardNumber in interface ICSBoardEvent

setBlackMove

public void setBlackMove(boolean t)

setWhitePlayer

public void setWhitePlayer(java.lang.String player)

setBlackPlayer

public void setBlackPlayer(java.lang.String player)

setMoveNumber

public void setMoveNumber(int num)

setEnPassantFile

public void setEnPassantFile(int ep)

setPlySinceLastIrreversableMove

public void setPlySinceLastIrreversableMove(int ply)

setRelation

public void setRelation(int pov)

setInitialTime

public void setInitialTime(int seconds)

setIncrement

public void setIncrement(int seconds)

setWhiteMaterial

public void setWhiteMaterial(int value)

setBlackMaterial

public void setBlackMaterial(int value)

setWhiteClock

public void setWhiteClock(int ms)

setBlackClock

public void setBlackClock(int ms)

setLag

public void setLag(int ms)

setSAN

public void setSAN(java.lang.String san)

setWhiteCastleableKingside

public void setWhiteCastleableKingside(boolean t)

setWhiteCastleableQueenside

public void setWhiteCastleableQueenside(boolean t)

setBlackCastleableKingside

public void setBlackCastleableKingside(boolean t)

setBlackCastleableQueenside

public void setBlackCastleableQueenside(boolean t)

setVerboseMove

public void setVerboseMove(java.lang.String move)

setFlipBoard

public void setFlipBoard(boolean t)

setClockMoving

public void setClockMoving(boolean t)

setMoveTime

public void setMoveTime(int ms)

getReadable

public java.lang.String getReadable()
this is completely temporary and only for diagnostic purposes.

Specified by:
getReadable in class ICSEvent

toString

public java.lang.String toString()
Overrides:
toString in class ICSEvent

Submit a bug or feature
Visit the Website
Internet Chess ToolKit is licensed under the GPL v2 .