Namespace GamesByEmail

Object
  GamesByEmail

GamesByEmail

Namespace for all of GamesByEmail.com's classes.

Interface Summary
static Interface	Hex An interface for games with a hexagonal board. Has precedent methods to for converting to and from screen points, and board point to value indices, path and looping. A class should also implement either GamesByEmail.HexH or GamesByEmail.HexV.

Class Summary
static Class	Game Base class for all games.
static Class	GameNotify The notification flag structure of GamesByEmail.Game.notify. Set appropriate flags for events in the game and players who have suscribed to those events will get notified.
static Class	GameStatus The status structure of GamesByEmail.Game.status.
static Class	HexH A background class for games with a hexagonal board having a horizontal axis, such as Triversi. The behind-the-scenes methods support the GamesByEmail.Hex class.
static Class	HexV A background class for games with a hexagonal board having a vertical axis, such as McCooey Hex Chess. The behind-the-scenes methods support the GamesByEmail.Hex class.
static Class	Info A generic repository for key value pairs. Used to save state data in the game and team, and preferences for the player.
static Class	LogSettings Log settings...
static Class	Move Information about the last move.
static Class	Piece A piece class for games like chess. May be used directly or extended.
static Class	Pieces A collection of pieces in a game, like chess. May be used directly or extended. Implemented as an Array.
static Class	Player Information about a player.
static Class	Players A collection of GamesByEmail.Player objects. Implemented as an Array.
static Class	Team Information about a team.
static Class	TeamNotify The notification flag structure of GamesByEmail.Team.notify. Set appropriate flags for events in the game and players who have suscribed to those events will get notified.
static Class	TeamStatus The status structure of GamesByEmail.Game.status.
static Class	Teams A collection of GamesByEmail.Team objects. Implemented as an Array.
static Class	Territories A collection of territories in a game, like Gambit. May be used directly or extended. Implemented as an Array.
static Class	Territory A territory class for games like Gambit. May be used directly or extended.

Enum Summary
static Number	ARROW_KEY_CODE Arrow key codes for use against event.keyCode.
static String	CURSOR Cross browser hand cursor value for element.style.cursor.
static Number	GAME_TYPE Type of game, set in the GamesByEmail.Game.type field.

Function Summary
static String	clippedImageHtml(/*String*/ src, /*Rectangle*/ clipRect, /*String*/ styles, /*String*/ attibutes) Generates the HTML necessary to show an inline clipped image.
static Boolean	debug(/*String*/ value) Writes a message to the first game on the page's message area.
static Object	deepCopy(/*Object*/ object) Makes a simple classless copy of an object. Each sub object is copied as well.
static Array	diceRolls(/*Number*/ num) Returns an array of pseudo-random integers from 1 to 6 inclusive.
static Number	dieRoll() Returns a pseudo-random integer from 1 to 6 inclusive.
static	elementHasIdInHierarchy(element, id)
static Point	elementPageOffset(/*Element*/ element) Gets the top left offset of an element from its layout parent.
static Rectangle	elementPageRectangle(/*Element*/ element) Gets the rectangle of an element from its layout parent.
static String	elementTitleAttributes(/*String*/ title) Generates HTML element attributes necessary to have an HTML hover title on an element.
static String	expandingTextareaHtml(/*String*/ id, /*String*/ width, /*Number*/ lineHeight, /*Number*/ maxLines, /*String*/ additionalStyle, /*String*/ additionalAttributes) Generates the HTML necessary for a textarea that displays as a single line, but grows (overlaying elements above it) as the user types. Used to generate the game message chat areas.
static Game	findFirstGame() Finds the first game in the page.
static String	getBestBwContrast(/*String*/ color) Gets the best black or white contrast for a color.
static Boolean	getBestBwContrast(/*Number*/ red, /*Number*/ blue, /*Number*/ green) Tests for best black or white contrast for an r-g-b color triplet.
static String	getHexString(/*Number*/ value, /*Number*/ minLength) Converts a numeric value to a 0 padded hex string.
static String	imgSetClip(/*Element*/ Image, /*Number*/ positionX, /*Number*/ positionY, /*Number*/ clipX, /*Number*/ clipY, /*Number*/ clipWidth, /*Number*/ clipHeight) Clips and positions an image element and/or returns the style properties necessary to clip an element. Low level, you should probably be using positionImage.
static Boolean	isLeftButtonEvent(/*Event*/ event, /*Boolean*/ allowKeyboardModifier) Cross-browser detection whether a mouse event is a left button event. Always pass true for allowKeyboardModifier.
static Boolean	isMiddleButtonEvent(/*Event*/ event) Cross-browser detection whether a mouse event is a middle button event.
static Boolean	isRightButtonEvent(/*Event*/ event, /*Boolean*/ allowKeyboardModifier) Cross-browser detection whether a mouse event is a right button event. Always pass true for allowKeyboardModifier.
static String	positionImage(/*Element*/ element, /*Point|Rectangle*/ position, /*Rectangle*/ clipRect) Clips and positions an image element and/or returns the style properties necessary to clip an element.
static Number	random(/*Number*/ high, /*Number*/ low) Returns a pseudo-random integer between a low and a high, inclusive.
static Object	shallowCopy(/*Object*/ object) Makes a simple classless copy of an object. Sub object are not copied, but are shared between the instances.

Enum Detail

ARROW_KEY_CODE

static Number ARROW_KEY_CODE

LEFT - 

RIGHT - 

UP - 

DOWN - 

static String CURSOR

HAND - 

static Number GAME_TYPE

CHESS - 

BACKGAMMON - 

CHECKERS - 

REVERSI - 

LINK_4 - 

ATAXX - 

TWIXT - 

XIANGQI - 

DARK_CHESS - 

OMEGA_CHESS - 

DARK_OMEGA_CHESS - 

CHINESE_CHECKERS - 

TRIVERSI - 

DEADGAMMON - 

HYPERGAMMON - 

NACKGAMMON - 

GAMBIT - 

DARK_GAMBIT - 

BLIND_GAMBIT - 

SPY_GAMBIT - 

GIPF - 

ZERTZ - 

DVONN - 

DARK_XIANGQI - 

TIC_TAC_TOE - 

REFLEKTIT - 

BLIND_TRIVERSI - 

MCCOOEY_HEX_CHESS - 

DARK_MCCOOEY_HEX_CHESS - 

GO - 

GO_13X13 - 

GO_9X9 - 

POLITICS - 

WW2 - 

YINSH - 

BLITZ_YINSH - 

BYTE_8X8 - 

BYTE_10X10 - 

SNAG - 

ELUDE - 

DARK_ELUDE - 

PLOT - 

DARK_PLOT - 

BLIND_PLOT - 

MERGERS - 

FIVES - 

DARK_ATAXX - 

NINE_MENS_MORRIS - 

TANBO - 

DIPOLE - 

CEPHALOPOD - 

ATOLL - 

RUSH - 

CROSSWAY - 

CROSSWAY_PIED - 

SCRIBE - 

SUPERGLYPH_SCRIBE - 

DIFFUSION - 

COPOLYMER - 

OUST_SQUARE_OLD - 

BEGIRD - 

BEGIRD_PIED - 

PALISADE - 

IMPASSE - 

QUADRATURE - 

MECHA - 

EMPIRES - 

LARIAT - 

LARIAT_PIED - 

VIKTORY2 - 

ATOLL_PIED - 

LOOPHOLE_2D - 

GOMOKU - 

PLATEAU - 

CAPTURE_THE_FLAG - 

BATTLE_BOATS - 

CAGE - 

OUST_SQUARE - 

OUST_HEX - 

FLUME_SQUARE - 

FLUME_SQUARE_PIED - 

FLUME_HEX - 

FLUME_HEX_PIED - 

FRACTAL - 

X - 

RIVE - 

PHALANX - 

Function Detail

clippedImageHtml

static String clippedImageHtml(/*String*/ src,
                               /*Rectangle*/ clipRect,
                               /*String*/ styles,
                               /*String*/ attibutes)

src - 

clipRect - 

styles - 

attibutes - 

static Boolean debug(/*String*/ value)

value - 

static Object deepCopy(/*Object*/ object)

object - 

static Array diceRolls(/*Number*/ num)

num - 

static Number dieRoll()

static elementHasIdInHierarchy(element,
                               id)

element - 

id - 

static Point elementPageOffset(/*Element*/ element)

element - 

static Rectangle elementPageRectangle(/*Element*/ element)

element - 

static String elementTitleAttributes(/*String*/ title)

title - 

var title="<H1>Big bold hover title!</H1>";
html+="<div "+GamesByEmail.elementTitleAttributes(title)+">Hover here to see big text.</div>";

static String expandingTextareaHtml(/*String*/ id,
                                    /*String*/ width,
                                    /*Number*/ lineHeight,
                                    /*Number*/ maxLines,
                                    /*String*/ additionalStyle,
                                    /*String*/ additionalAttributes)

id - 

width - 

lineHeight - 

maxLines - 

additionalStyle - 

additionalAttributes - 

static Game findFirstGame()

static String getBestBwContrast(/*String*/ color)

color - 

static Boolean getBestBwContrast(/*Number*/ red,
                                 /*Number*/ blue,
                                 /*Number*/ green)

red - 

blue - 

green - 

static String getHexString(/*Number*/ value,
                           /*Number*/ minLength)

value - 

minLength - 

static String imgSetClip(/*Element*/ Image,
                         /*Number*/ positionX,
                         /*Number*/ positionY,
                         /*Number*/ clipX,
                         /*Number*/ clipY,
                         /*Number*/ clipWidth,
                         /*Number*/ clipHeight)

Image - 

positionX - 

positionY - 

clipX - 

clipY - 

clipWidth - 

clipHeight - 

// Both examples will position an image left/top at 20,30 clipped to show only the
//  part of the image from 5,12 to 7,18 (clipped width of 3, height of 7).
 
//To clip an existing image element:
var myImage=game.getElement("myImage");
GamesByEmail.imgSetClip(myImage,20,30,5,12,3,7);
 
//To build HTML for a new image element. Note null passed for first parameter.
html+="<IMG src=\"myImage.gif\" style=\""+GamesByEmail.imgSetClip(null,20,30,5,12,3,7)+"\">";

static Boolean isLeftButtonEvent(/*Event*/ event,
                                 /*Boolean*/ allowKeyboardModifier)

event - 

allowKeyboardModifier - 

static Boolean isMiddleButtonEvent(/*Event*/ event)

event - 

static Boolean isRightButtonEvent(/*Event*/ event,
                                  /*Boolean*/ allowKeyboardModifier)

event - 

allowKeyboardModifier - 

static String positionImage(/*Element*/ element,
                            /*Point|Rectangle*/ position,
                            /*Rectangle*/ clipRect)

element - 

position - 

clipRect - 

// Both examples will position an image *centered* at 20,30 clipped to show only the
//  part of the image from 5,12 to 7,18 (clipped width of 3, height of 7).
var center=new Foundation.Point(20,30);
var clip=new Foundation.Rectangle(5,12,3,7);
 
//To clip an existing image element:
var myImage=game.getElement("myImage");
GamesByEmail.positionImage(myImage,center,clip);
 
//To build HTML for a new image element. Note null passed for first parameter.
html+="<IMG src=\"myImage.gif\" style=\""+GamesByEmail.positionImage(null,center,clip)+"\">";

static Number random(/*Number*/ high,
                     /*Number*/ low)

high - 

low - 

static Object shallowCopy(/*Object*/ object)

object -