CCLabelTTF Class Reference

Inherits from	CCSprite : CCNodeRGBA : CCNode : NSObject
Conforms to	CCLabelProtocol
Declared in	CCLabelTTF.h

Overview

CCLabel is a subclass of CCTextureNode that knows how to render text labels

All features from CCTextureNode are valid in CCLabel

CCLabel objects are slow. Consider using CCLabelAtlas or CCLabelBMFont instead.

Tasks

Other Methods

fontName
Font name used in the label
property
fontSize
Font size of the label
property
dimensions
Dimensions of the label in Points
property
horizontalAlignment
The alignment of the label
property
verticalAlignment
The vertical alignment of the label
property
+ labelWithString:fontName:fontSize:
creates a CCLabelTTF with a font name and font size in points
+ labelWithString:fontName:fontSize:dimensions:hAlignment:
creates a CCLabelTTF from a fontname, horizontal alignment, dimension in points, and font size in points. Supported lineBreakModes: – iOS: all UILineBreakMode supported modes – Mac: Only NSLineBreakByWordWrapping is supported.
+ labelWithString:fontName:fontSize:dimensions:hAlignment:lineBreakMode:
creates a CCLabelTTF from a fontname, horizontal alignment, dimension in points, line break mode, and font size in points. Supported lineBreakModes: – iOS: all UILineBreakMode supported modes – Mac: Only NSLineBreakByWordWrapping is supported.
+ labelWithString:fontName:fontSize:dimensions:hAlignment:vAlignment:lineBreakMode:
creates a CCLabelTTF from a fontname, horizontal alignment, vertical alignment, dimension in points, line break mode, and font size in points. Supported lineBreakModes: – iOS: all UILineBreakMode supported modes – Mac: Only NSLineBreakByWordWrapping is supported.
+ labelWithString:fontName:fontSize:dimensions:hAlignment:vAlignment:
creates a CCLabel from a fontname, alignment, dimension in points and font size in points
– initWithString:fontName:fontSize:
initializes the CCLabelTTF with a font name and font size in points
– initWithString:fontName:fontSize:dimensions:hAlignment:
initializes the CCLabelTTF with a font name, horizontal alignment, dimension in points, and font size in points. Default verticalAlignment: kCCVerticalTextAlignmentTop Default lineBreakMode: CCLineBreakModeWordWrap
– initWithString:fontName:fontSize:dimensions:hAlignment:lineBreakMode:
initializes the CCLabelTTF with a font name, horizontal alignment, dimension in points, line break mode and font size in points. Default verticalAlignment: kCCVerticalTextAlignmentTop
– initWithString:fontName:fontSize:dimensions:hAlignment:vAlignment:
initializes the CCLabelTTF with a font name, horizontal alignment, vertical alignment, dimension in points and font size in points. Default lineBreakMode: CCLineBreakModeWordWrap
– initWithString:fontName:fontSize:dimensions:hAlignment:vAlignment:lineBreakMode:
initializes the CCLabelTTF with a font name, horizontal alignment, vertical alignment, dimension in points, line break mode and font size in points. Supported lineBreakModes: – iOS: all UILineBreakMode supported modes – Mac: Only NSLineBreakByWordWrapping is supported.
– setString:
changes the string to render

Deprecated Methods

+ labelWithString:dimensions:alignment:fontName:fontSize:
+ labelWithString:dimensions:alignment:lineBreakMode:fontName:fontSize:
+ labelWithString:dimensions:hAlignment:fontName:fontSize:
+ labelWithString:dimensions:hAlignment:lineBreakMode:fontName:fontSize:
+ labelWithString:dimensions:hAlignment:vAlignment:lineBreakMode:fontName:fontSize:
+ labelWithString:dimensions:hAlignment:vAlignment:fontName:fontSize:
– initWithString:dimensions:alignment:fontName:fontSize:
– initWithString:dimensions:alignment:lineBreakMode:fontName:fontSize:

Properties

dimensions

Dimensions of the label in Points

@property (nonatomic, assign) CGSize dimensions

Declared In

CCLabelTTF.h

fontName

Font name used in the label

@property (nonatomic, retain) NSString *fontName

Declared In

CCLabelTTF.h

horizontalAlignment

The alignment of the label

@property (nonatomic, assign) CCTextAlignment horizontalAlignment

Declared In

CCLabelTTF.h

verticalAlignment

The vertical alignment of the label

@property (nonatomic, assign) CCVerticalTextAlignment verticalAlignment

Declared In

CCLabelTTF.h

Class Methods

labelWithString:dimensions:alignment:fontName:fontSize:

labelWithString:dimensions:alignment:lineBreakMode:fontName:fontSize:

labelWithString:dimensions:hAlignment:fontName:fontSize:

labelWithString:dimensions:hAlignment:lineBreakMode:fontName:fontSize:

labelWithString:dimensions:hAlignment:vAlignment:fontName:fontSize:

labelWithString:dimensions:hAlignment:vAlignment:lineBreakMode:fontName:fontSize:

labelWithString:fontName:fontSize:

creates a CCLabelTTF with a font name and font size in points

+ (id)labelWithString:(NSString *)string fontName:(NSString *)name fontSize:(CGFloat)size

Declared In

CCLabelTTF.h

labelWithString:fontName:fontSize:dimensions:hAlignment:

creates a CCLabelTTF from a fontname, horizontal alignment, dimension in points, and font size in points. Supported lineBreakModes: – iOS: all UILineBreakMode supported modes – Mac: Only NSLineBreakByWordWrapping is supported.

+ (id)labelWithString:(NSString *)string fontName:(NSString *)name fontSize:(CGFloat)size dimensions:(CGSize)dimensions hAlignment:(CCTextAlignment)alignment

Availability

Declared In

CCLabelTTF.h

labelWithString:fontName:fontSize:dimensions:hAlignment:lineBreakMode:

creates a CCLabelTTF from a fontname, horizontal alignment, dimension in points, line break mode, and font size in points. Supported lineBreakModes: – iOS: all UILineBreakMode supported modes – Mac: Only NSLineBreakByWordWrapping is supported.

+ (id)labelWithString:(NSString *)string fontName:(NSString *)name fontSize:(CGFloat)size dimensions:(CGSize)dimensions hAlignment:(CCTextAlignment)alignment lineBreakMode:(CCLineBreakMode)lineBreakMode

Availability

Declared In

CCLabelTTF.h

labelWithString:fontName:fontSize:dimensions:hAlignment:vAlignment:

creates a CCLabel from a fontname, alignment, dimension in points and font size in points

+ (id)labelWithString:(NSString *)string fontName:(NSString *)name fontSize:(CGFloat)size dimensions:(CGSize)dimensions hAlignment:(CCTextAlignment)alignment vAlignment:(CCVerticalTextAlignment)vertAlignment

Declared In

CCLabelTTF.h

labelWithString:fontName:fontSize:dimensions:hAlignment:vAlignment:lineBreakMode:

creates a CCLabelTTF from a fontname, horizontal alignment, vertical alignment, dimension in points, line break mode, and font size in points. Supported lineBreakModes: – iOS: all UILineBreakMode supported modes – Mac: Only NSLineBreakByWordWrapping is supported.

+ (id)labelWithString:(NSString *)string fontName:(NSString *)name fontSize:(CGFloat)size dimensions:(CGSize)dimensions hAlignment:(CCTextAlignment)alignment vAlignment:(CCVerticalTextAlignment)vertAlignment lineBreakMode:(CCLineBreakMode)lineBreakMode

Availability

Declared In

CCLabelTTF.h

Instance Methods

initWithString:dimensions:alignment:fontName:fontSize:

initWithString:dimensions:alignment:lineBreakMode:fontName:fontSize:

initWithString:fontName:fontSize:

initializes the CCLabelTTF with a font name and font size in points

- (id)initWithString:(NSString *)string fontName:(NSString *)name fontSize:(CGFloat)size

Declared In

CCLabelTTF.h

initWithString:fontName:fontSize:dimensions:hAlignment:

initializes the CCLabelTTF with a font name, horizontal alignment, dimension in points, and font size in points. Default verticalAlignment: kCCVerticalTextAlignmentTop Default lineBreakMode: CCLineBreakModeWordWrap

- (id)initWithString:(NSString *)string fontName:(NSString *)name fontSize:(CGFloat)size dimensions:(CGSize)dimensions hAlignment:(CCTextAlignment)alignment

Availability

Declared In

CCLabelTTF.h

initWithString:fontName:fontSize:dimensions:hAlignment:lineBreakMode:

initializes the CCLabelTTF with a font name, horizontal alignment, dimension in points, line break mode and font size in points. Default verticalAlignment: kCCVerticalTextAlignmentTop

- (id)initWithString:(NSString *)str fontName:(NSString *)name fontSize:(CGFloat)size dimensions:(CGSize)dimensions hAlignment:(CCTextAlignment)alignment lineBreakMode:(CCLineBreakMode)lineBreakMode

Availability

Discussion

Supported lineBreakModes: – iOS: all UILineBreakMode supported modes – Mac: Only NSLineBreakByWordWrapping is supported.

Declared In

CCLabelTTF.h

initWithString:fontName:fontSize:dimensions:hAlignment:vAlignment:

initializes the CCLabelTTF with a font name, horizontal alignment, vertical alignment, dimension in points and font size in points. Default lineBreakMode: CCLineBreakModeWordWrap

- (id)initWithString:(NSString *)string fontName:(NSString *)name fontSize:(CGFloat)size dimensions:(CGSize)dimensions hAlignment:(CCTextAlignment)alignment vAlignment:(CCVerticalTextAlignment)vertAlignment

Declared In

CCLabelTTF.h

initWithString:fontName:fontSize:dimensions:hAlignment:vAlignment:lineBreakMode:

initializes the CCLabelTTF with a font name, horizontal alignment, vertical alignment, dimension in points, line break mode and font size in points. Supported lineBreakModes: – iOS: all UILineBreakMode supported modes – Mac: Only NSLineBreakByWordWrapping is supported.

- (id)initWithString:(NSString *)str fontName:(NSString *)name fontSize:(CGFloat)size dimensions:(CGSize)dimensions hAlignment:(CCTextAlignment)alignment vAlignment:(CCVerticalTextAlignment)vAlignment lineBreakMode:(CCLineBreakMode)lineBreakMode

Availability

Declared In

CCLabelTTF.h

setString:

changes the string to render

- (void)setString:(NSString *)str

Discussion

Warning: Changing the string is as expensive as creating a new CCLabelTTF. To obtain better performance use CCLabelAtlas or CCLabelBMFont.

Declared In

CCLabelTTF.h