jeena/pixi.js
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

docs update

Browse source
This commit is contained in:
Krzysztof Opalka 2013-05-06 23:22:53 +02:00
parent ba5a79c606
commit 8027a40e06
1 changed files with 5 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

11
src/pixi/text/BitmapText.js
View file

@ -5,17 +5,16 @@
/** /**
* A Text Object will create a line(s) of text using bitmap font * A Text Object will create a line(s) of text using bitmap font
* You can generate the fnt files using * You can generate the fnt files using
* http://www.angelcode.com/products/bmfont/ for windows of * http://www.angelcode.com/products/bmfont/ for windows or
* http://www.bmglyph.com/ for mac. * http://www.bmglyph.com/ for mac.
* @class BitmapText * @class BitmapText
* @extends DisplayObjectContainer * @extends DisplayObjectContainer
* @constructor * @constructor
* @param {String} text The copy that you would like the text to display * @param {String} text The copy that you would like the text to display
* @param {Object} [style] The style parameters * @param {Object} style The style parameters
* @param {String} [style.font] default is "20pt Arial" The size and bitmap font id (must have loaded previously) * @param {String} style.font The size (optional) and bitmap font id (required) eq "Arial" or "20px Arial" (must have loaded previously)
* @param {String} [style.align="left"] An alignment of the multiline text ("left", "center" or "right") * @param {String} [style.align="left"] An alignment of the multiline text ("left", "center" or "right")
*/ */
//* @param {Object} [style.font="bold 20pt Arial"] The style and size of the font
PIXI.BitmapText = function(text, style) PIXI.BitmapText = function(text, style)
{ {
PIXI.DisplayObjectContainer.call(this); PIXI.DisplayObjectContainer.call(this);
@ -45,8 +44,8 @@ PIXI.BitmapText.prototype.setText = function(text)
/** /**
* Set the style of the text * Set the style of the text
* @method setStyle * @method setStyle
* @param {Object} [style] The style parameters * @param {Object} style The style parameters
* @param {Object} style.font The style and size of the font. If font size is not specified, it uses default bitmap font size. Font name is required * @param {String} style.font The size (optional) and bitmap font id (required) eq "Arial" or "20px Arial" (must have loaded previously)
* @param {String} [style.align="left"] An alignment of the multiline text ("left", "center" or "right") * @param {String} [style.align="left"] An alignment of the multiline text ("left", "center" or "right")
*/ */
PIXI.BitmapText.prototype.setStyle = function(style) PIXI.BitmapText.prototype.setStyle = function(style)