CCLabelBMFont Class Reference

#import "CCLabelBMFont.h"

Inherits CCSpriteBatchNode, CCLabelProtocol-p, and CCRGBAProtocol-p.

Inherited by CCBitmapFontAtlas.

Collaboration diagram for CCLabelBMFont:

List of all members.

Public Member Functions
(void)	- createFontChars
(id)	- initWithString:fntFile:
Static Public Member Functions
(id)	+ bitmapFontAtlasWithString:fntFile:
(id)	+ labelWithString:fntFile:
(void)	+ purgeCachedData
Properties
ccColor3B	color
GLubyte	opacity

---

Detailed Description

CCLabelBMFont is a subclass of CCSpriteBatchNode

Features:

• Treats each character like a CCSprite. This means that each individual character can be:
  • rotated
  • scaled
  • translated
  • tinted
  • chage the opacity
• It can be used as part of a menu item.
• anchorPoint can be used to align the "label"
• Supports AngelCode text format

Limitations:

• All inner characters are using an anchorPoint of (0.5f, 0.5f) and it is not recommend to change it because it might affect the rendering

CCLabelBMFont implements the protocol CCLabelProtocol, like CCLabel and CCLabelAtlas. CCLabelBMFont has the flexibility of CCLabel, the speed of CCLabelAtlas and all the features of CCSprite. If in doubt, use CCLabelBMFont instead of CCLabelAtlas / CCLabel.

Supported editors:

• http://www.n4te.com/hiero/hiero.jnlp
• http://slick.cokeandcode.com/demos/hiero.jnlp
• http://www.angelcode.com/products/bmfont/

Since:

v0.8

---

Member Function Documentation

+ (id) bitmapFontAtlasWithString:		(NSString *)	string
fntFile:		(NSString *)	DEPRECATED_ATTRIBUTE

creates a BMFont label with an initial string and the FNT file

Deprecated:

Will be removed in 1.0.1. Use "labelWithString" instead.

- (void) createFontChars

updates the font chars based on the string to render

- (id) initWithString:		(NSString *)	string
fntFile:		(NSString *)	fntFile

init a BMFont label with an initial string and the FNT file

+ (id) labelWithString:		(NSString *)	string
fntFile:		(NSString *)	fntFile

creates a BMFont label with an initial string and the FNT file

+ (void) purgeCachedData

Purges the cached data. Removes from memory the cached configurations and the atlas name dictionary.

Since:

v0.99.3

---

Property Documentation

- (ccColor3B) color [read, write, assign]

conforms to CCRGBAProtocol protocol

- (GLubyte) opacity [read, write, assign]

conforms to CCRGBAProtocol protocol

---

The documentation for this class was generated from the following file:

• /depot/cocosdocs/cocos2d-iphone-0.99.5/cocos2d/CCLabelBMFont.h