OnBox Object

From BOARD18 Project WIKI
Revision as of 12:22, 29 July 2013 by Rich (talk | contribs) (Initial version of this page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
This page describes a BOARD18 JavaScript object.
This object is created using the OnBox constructor function.
Go to Object List. - Go to Design Document.

The OnBox object describes all tokens on the price box with the supplied coordinates.

Data Elements in Object
Element Type C Description
boxX int * X coordinate of box
boxY int * Y coordinate of box
tokens array * Array of MarketToken objects
tokens[i].mtindex int * index of tokens[i] in BD18.marketTokens array
noToken boolean * True if there is no token on the box
oneToken boolean * True if there is one token on the box
manyTokens boolean * True if there are many tokens on the box

An * in the "C" column indicates that the element is created by the OnBox constructor function.

This object has no methods.