GamesByEmail
Class Piece

Object
  GamesByEmail.Piece

All Implemented Interfaces:

GamesByEmail.Piece

implements Foundation.Class

A piece class for games like chess. May be used directly or extended.

See Also:

Constructor Summary

GamesByEmail.Piece(/*Pieces*/ pieces, /*Number*/ index, /*Number*/ value, /*Number*/ valueIndex, /*Boolean*/ hidden) Creates a piece.

Field Summary
Point	boardPoint The piece's position on the board (not on the screen).
Boolean	hidden Whether the piece is visible to the current player or not.
Number	index The position of this piece in the parent pieces object.
Pieces	pieces The parent pieces object.
Number	valueIndex The position of this piece's value in the result of the pieces getValue call. Based on the position. Set to -1 to not include in getValue.

Method Summary
StringBuilder	appendHtml(/*StringBuilder*/ htmlBuilder) Adds the pieces HTML to the a string builder. #returns The string builder after appending.
void	center(/*Point*/ screenPoint, /*Boolean*/ noConstrain) Centers the piece on a point.
static	create(/*Pieces*/ pieces, /*Number*/ index, /*Number*/ value, /*Number*/ valueIndex) Returns a new piece object of the type.
	dispose()
String	elementId(/*String*/ id) Returns an ID that is unique to this piece that can be used as HTML element IDs. No other piece of any class will generate the same ID even when passed the same parameter. The same piece will always generate the same ID when passed the same parameter.
String	event(/*String*/ code, /*Boolean*/ delayed) Returns code that can be used in DOM events to invoke methods and properties of the piece.
void	getBoardValue(/*String*/ value, /*Boolean*/ noReset) Changes the pieces value (the type of piece it is).
Rectangle	getClipRect() Gets the clipping rectangle for this piece based on its color value. #returns The clipping rectangle.
Element	getElement(/*String*/ id) Returns the HTML element that is unique to this piece.
String	getImageSrc() Gets the image file source for pieces in the game. Pieces should all be in the same file, with clipping rectangles defined. #returns The full path to the image file.
Rectangle	getScreenRect(/*String*/ boardPoint) Gets the screen rectangle for this piece based on its boardPoint property.
Number	isColor() Gets the color of this piece based on its value property. #returns The color.
Boolean	isOurs() Determines if the piece color is the same as the current player's team color. #returns True if the colors are the same, else false.
void	move(/*Point*/ boardPoint, /*Boolean*/ hidden) Moves the piece to a board point. The boardPoint property is updated.
Boolean	occupiesBoardPoint(/*Point*/ boardPoint) Determines if a piece occupies a board point.
void	remove() Removes a piece.
void	reset(/*String*/ boardValueOverride, /*String*/ visibilityOverride) Resets a piece to its boardPoint position and hidden state after a call to snap, center or setVisibility.
void	setBoardValue(/*String*/ boardValue, /*Boolean*/ noReset) Changes the piece's board value (the color and type of piece it is).
void	setColor(/*Number*/ color, /*Boolean*/ noReset) Changes the piece's color.
void	setHidden(/*Boolean*/ hidden) Sets the 'permanent' visibility of a piece.
void	setValue(/*String*/ value, /*Boolean*/ noReset) Changes the piece's value (the type of piece it is).
void	setValueAndColor(/*String*/ value, /*Number*/ color, /*Boolean*/ noReset) Changes the piece's value and color.
void	setVisibility(/*Boolean*/ hidden) Sets the 'temporary' visibility of a piece.
void	snap(/*Point*/ boardPoint, /*String*/ boardValueOverride) Centers the piece on a board point. The boardPoint property is not altered.

Methods inherited from Foundation.Class

getTypePath, isInstanceOf

Constructor Detail

Piece

GamesByEmail.Piece(/*Pieces*/ pieces,
                   /*Number*/ index,
                   /*Number*/ value,
                   /*Number*/ valueIndex,
                   /*Boolean*/ hidden)

pieces - 

index - 

value - 

valueIndex - 

hidden - 

Field Detail

boardPoint

Point boardPoint

Boolean hidden

Number index

Pieces pieces

Number valueIndex

Method Detail

appendHtml

StringBuilder appendHtml(/*StringBuilder*/ htmlBuilder)

htmlBuilder - 

void center(/*Point*/ screenPoint,
            /*Boolean*/ noConstrain)

screenPoint - 

noConstrain - 

static create(/*Pieces*/ pieces,
              /*Number*/ index,
              /*Number*/ value,
              /*Number*/ valueIndex)

pieces - 

index - 

value - 

valueIndex - 

dispose()

String elementId(/*String*/ id)

id - 

String event(/*String*/ code,
             /*Boolean*/ delayed)

code - 

delayed - 

// The following div will call the reset method of the piece when clicked.
htmlBuilder.append("<div onclick=\""+this.event("reset()")+"\">click here to reset piece</div>");

void getBoardValue(/*String*/ value,
                   /*Boolean*/ noReset)

value - 

noReset - 

Rectangle getClipRect()

Element getElement(/*String*/ id)

id - 

String getImageSrc()

Rectangle getScreenRect(/*String*/ boardPoint)

boardPoint - 

Number isColor()

Boolean isOurs()

void move(/*Point*/ boardPoint,
          /*Boolean*/ hidden)

boardPoint - 

hidden - 

Boolean occupiesBoardPoint(/*Point*/ boardPoint)

boardPoint - 

void remove()

void reset(/*String*/ boardValueOverride,
           /*String*/ visibilityOverride)

boardValueOverride - 

visibilityOverride - 

void setBoardValue(/*String*/ boardValue,
                   /*Boolean*/ noReset)

boardValue - 

noReset - 

void setColor(/*Number*/ color,
              /*Boolean*/ noReset)

color - 

noReset - 

void setHidden(/*Boolean*/ hidden)

hidden - 

void setValue(/*String*/ value,
              /*Boolean*/ noReset)

value - 

noReset - 

void setValueAndColor(/*String*/ value,
                      /*Number*/ color,
                      /*Boolean*/ noReset)

value - 

color - 

noReset - 

void setVisibility(/*Boolean*/ hidden)

hidden - 

void snap(/*Point*/ boardPoint,
          /*String*/ boardValueOverride)

boardPoint - 

boardValueOverride -