MOAITextStyle Class Reference

Inheritance diagram for MOAITextStyle:

List of all members.

Function List
	getColor
	getFont
	getScale
	getSize
	setColor
	setFont
	setScale
	setSize

---

Function Documentation

getColor

Gets the color of the style.

---

function getColor ( MOAITextStyle self )

Parameters:

self	( MOAITextStyle )

Returns:

r ( number ), g ( number ), b ( number ), a ( number )

getFont

Gets the font of the style.

---

function getFont ( MOAITextStyle self )

Parameters:

self	( MOAITextStyle )

Returns:

font ( MOAIFont )

getScale

Gets the scale of the style.

---

function getScale ( MOAITextStyle self )

Parameters:

self	( MOAITextStyle )

Returns:

scale ( number )

getSize

Gets the size of the style.

---

function getSize ( MOAITextStyle self )

Parameters:

self	( MOAITextStyle )

Returns:

size ( number )

setColor

Initialize the style's color.

---

function setColor ( MOAITextStyle self, number r, number g, number b [, number a ] )

Parameters:

self	( MOAITextStyle )
r	( number ) Default value is 0.
g	( number ) Default value is 0.
b	( number ) Default value is 0.
a	( number ) Optional. Default value is 1.

Returns:

nil

setFont

Sets or clears the style's font.

---

function setFont ( MOAITextStyle self [, MOAIFont font ] )

Parameters:

self	( MOAITextStyle )
font	( MOAIFont ) Optional. Default value is nil.

Returns:

nil

setScale

Sets the scale of the style. The scale is applied to any glyphs drawn using the style after the glyph set has been selected by size.

---

function setScale ( MOAITextStyle self [, number scale ] )

Parameters:

self	( MOAITextStyle )
scale	( number ) Optional. Default value is 1.

Returns:

nil

setSize

Sets or clears the style's size.

---

function setSize ( MOAITextStyle self, number points [, number dpi ] )

Parameters:

self	( MOAITextStyle )
points	( number ) The point size to be used by the style.
dpi	( number ) Optional. The device DPI (dots per inch of device screen). Default value is 72 (points same as pixels).

Returns:

nil