cocos2d-iphone  1.0.1
Improved Cocos2D API Reference (iOS version) for Kobold2D developers
CCLabelTTF Interface Reference

#include <CCLabelTTF.h>

+ Inheritance diagram for CCLabelTTF:
+ Collaboration diagram for CCLabelTTF:

List of all members.

Public Member Functions

id initWithString:dimensions:alignment:lineBreakMode:fontName:fontSize: (NSString *str,[dimensions] CGSize dimensions,[alignment] CCTextAlignment alignment,[lineBreakMode] CCLineBreakMode lineBreakMode,[fontName] NSString *name,[fontSize] CGFloat size)
id initWithString:dimensions:alignment:fontName:fontSize: (NSString *string,[dimensions] CGSize dimensions,[alignment] CCTextAlignment alignment,[fontName] NSString *name,[fontSize] CGFloat size)
id initWithString:fontName:fontSize: (NSString *string,[fontName] NSString *name,[fontSize] CGFloat size)
void setString: (NSString *str)

Static Public Member Functions

id labelWithString:dimensions:alignment:lineBreakMode:fontName:fontSize: (NSString *string,[dimensions] CGSize dimensions,[alignment] CCTextAlignment alignment,[lineBreakMode] CCLineBreakMode lineBreakMode,[fontName] NSString *name,[fontSize] CGFloat size)
id labelWithString:dimensions:alignment:fontName:fontSize: (NSString *string,[dimensions] CGSize dimensions,[alignment] CCTextAlignment alignment,[fontName] NSString *name,[fontSize] CGFloat size)
id labelWithString:fontName:fontSize: (NSString *string,[fontName] NSString *name,[fontSize] CGFloat size)

Protected Attributes

CGSize dimensions_
CCTextAlignment alignment_
NSString * fontName_
CGFloat fontSize_
CCLineBreakMode lineBreakMode_
NSString * string_

Detailed Description

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.


Member Function Documentation

id CCLabelTTF::initWithString:dimensions:alignment:fontName:fontSize: ( NSString *  string,
[dimensions] CGSize  dimensions,
[alignment] CCTextAlignment  alignment,
[fontName] NSString *  name,
[fontSize] CGFloat  size 
) [virtual]

initializes the CCLabel with a font name, alignment, dimension in points and font size in points

id CCLabelTTF::initWithString:dimensions:alignment:lineBreakMode:fontName:fontSize: ( NSString *  str,
[dimensions] CGSize  dimensions,
[alignment] CCTextAlignment  alignment,
[lineBreakMode] CCLineBreakMode  lineBreakMode,
[fontName] NSString *  name,
[fontSize] CGFloat  size 
) [virtual]

initializes the CCLabel with a font name, alignment, dimension in points, line brea mode and font size in points. Supported lineBreakModes:

  • iOS: all UILineBreakMode supported modes
  • Mac: Only NSLineBreakByWordWrapping is supported.
    Since:
    v1.0
id CCLabelTTF::initWithString:fontName:fontSize: ( NSString *  string,
[fontName] NSString *  name,
[fontSize] CGFloat  size 
) [virtual]

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

id CCLabelTTF::labelWithString:dimensions:alignment:fontName:fontSize: ( NSString *  string,
[dimensions] CGSize  dimensions,
[alignment] CCTextAlignment  alignment,
[fontName] NSString *  name,
[fontSize] CGFloat  size 
) [static, virtual]

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

id CCLabelTTF::labelWithString:dimensions:alignment:lineBreakMode:fontName:fontSize: ( NSString *  string,
[dimensions] CGSize  dimensions,
[alignment] CCTextAlignment  alignment,
[lineBreakMode] CCLineBreakMode  lineBreakMode,
[fontName] NSString *  name,
[fontSize] CGFloat  size 
) [static, virtual]

creates a CCLabel from a fontname, alignment, dimension in points, line break mode, and font size in points. Supported lineBreakModes:

  • iOS: all UILineBreakMode supported modes
  • Mac: Only NSLineBreakByWordWrapping is supported.
    Since:
    v1.0
id CCLabelTTF::labelWithString:fontName:fontSize: ( NSString *  string,
[fontName] NSString *  name,
[fontSize] CGFloat  size 
) [static, virtual]

creates a CCLabel from a fontname and font size in points

void CCLabelTTF::setString: ( NSString *  str) [virtual]

changes the string to render

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

Reimplemented from <CCLabelProtocol>.


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