Search all
Classes
Examples
Guides

BitmapFontTextFormat

public class
feathers.text.BitmapFontTextFormat

Inheritance
Object

Description

Customizes a bitmap font for use by a BitmapFontTextRenderer.

See also:
feathers.controls.text.BitmapFontTextRenderer

API overview

Constructor

BitmapFontTextFormat ( _font: Object , _size: Number = , _color: Number = 0xff00ff , _bold: Boolean = false , _align: String = left )
Constructor.

Attributes

Public attributes

align: String

Determines the alignment of the text, either left, center, or right

color: Number

The multiply color

font: BitmapFont

The BitmapFont instance to use

fontName: String read-only

Go back to TextFormatAlign.LEFT when LOOM-1441 is fixed

isKerningEnabled: Boolean

Determines if the kerning values defined in the BitmapFont instance will be used for layout

letterSpacing: Number

The number of extra pixels between characters

size: Number

The size at which to display the bitmap font

Functions

Public functions

Constructor

BitmapFontTextFormat ( _font: Object , _size: Number = , _color: Number = 0xff00ff , _bold: Boolean = false , _align: String = left )

Constructor.

Attributes

align: String

Determines the alignment of the text, either left, center, or right.

color: Number

The multiply color.

font: BitmapFont

The BitmapFont instance to use.

fontName: String

read-only

Go back to TextFormatAlign.LEFT when LOOM-1441 is fixed.

isKerningEnabled: Boolean

Determines if the kerning values defined in the BitmapFont instance will be used for layout.

letterSpacing: Number

The number of extra pixels between characters. May be positive or negative.

size: Number

The size at which to display the bitmap font. Set to NaN to use the default size in the BitmapFont instance.

Functions

getFullTypeName (): String
Inherited from Object

native

Gets the fully qualified type name of the Object. The fully qualified type name includes the package of the type.


Returns

String fully qualified type name of the Object.

getType (): Type
Inherited from Object

native

Gets the Type that describes the Object.


Returns

Type The Type that describes the object.

getTypeName (): String
Inherited from Object

native

Gets the type name of the Object.


Returns

String type name of the Object.

toString (): String
Inherited from Object

native

Returns a String that describes the Object. This can be overriden to provide extra details when printing objects using trace().


Returns

String String that described the Object.

: