Class: RetroFont

Extends

• Phaser.RenderTexture

Members

<static, constant> ALIGN_CENTER : string

Align each line of multi-line text in the center.

Type:

• string

Source:

src/gameobjects/RetroFont.js line 195

<static, constant> ALIGN_LEFT : string

Align each line of multi-line text to the left.

Type:

• string

Source:

src/gameobjects/RetroFont.js line 181

<static, constant> ALIGN_RIGHT : string

Align each line of multi-line text to the right.

Type:

• string

Source:

src/gameobjects/RetroFont.js line 188

<static, constant> TEXT_SET1 : string

Text Set 1 = !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^_`abcdefghijklmnopqrstuvwxyz{|}~

Type:

• string

Source:

src/gameobjects/RetroFont.js line 202

<static, constant> TEXT_SET2 : string

Text Set 2 = !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ

Type:

• string

Source:

src/gameobjects/RetroFont.js line 209

<static, constant> TEXT_SET3 : string

Text Set 3 = ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789

Type:

• string

Source:

src/gameobjects/RetroFont.js line 216

<static, constant> TEXT_SET4 : string

Text Set 4 = ABCDEFGHIJKLMNOPQRSTUVWXYZ 0123456789

Type:

• string

Source:

src/gameobjects/RetroFont.js line 223

<static, constant> TEXT_SET5 : string

Text Set 5 = ABCDEFGHIJKLMNOPQRSTUVWXYZ.,/() '!?-*:0123456789

Type:

• string

Source:

src/gameobjects/RetroFont.js line 230

<static, constant> TEXT_SET6 : string

Text Set 6 = ABCDEFGHIJKLMNOPQRSTUVWXYZ!?:;0123456789"(),-.'

Type:

• string

Source:

src/gameobjects/RetroFont.js line 237

<static, constant> TEXT_SET7 : string

Text Set 7 = AGMSY+:4BHNTZ!;5CIOU.?06DJPV,(17EKQW")28FLRX-'39

Type:

• string

Source:

src/gameobjects/RetroFont.js line 244

<static, constant> TEXT_SET8 : string

Text Set 8 = 0123456789 .ABCDEFGHIJKLMNOPQRSTUVWXYZ

Type:

• string

Source:

src/gameobjects/RetroFont.js line 251

<static, constant> TEXT_SET9 : string

Text Set 9 = ABCDEFGHIJKLMNOPQRSTUVWXYZ()-0123456789.:,'"?!

Type:

• string

Source:

src/gameobjects/RetroFont.js line 258

<static, constant> TEXT_SET10 : string

Text Set 10 = ABCDEFGHIJKLMNOPQRSTUVWXYZ

Type:

• string

Source:

src/gameobjects/RetroFont.js line 265

<static, constant> TEXT_SET11 : string

Text Set 11 = ABCDEFGHIJKLMNOPQRSTUVWXYZ.,"-+!?()':;0123456789

Type:

• string

Source:

src/gameobjects/RetroFont.js line 272

align : string

Alignment of the text when multiLine = true or a fixedWidth is set. Set to RetroFont.ALIGN_LEFT (default), RetroFont.ALIGN_RIGHT or RetroFont.ALIGN_CENTER.

Type:

• string

Source:

src/gameobjects/RetroFont.js line 77

autoUpperCase : boolean

Automatically convert any text to upper case. Lots of old bitmap fonts only contain upper-case characters, so the default is true.

Type:

• boolean

Default Value:

• true

Source:

src/gameobjects/RetroFont.js line 89

baseTexture : BaseTexture

The base texture object that this texture uses

Type:

• BaseTexture

Inherited From:

• Phaser.RenderTexture#baseTexture

Source:

src/gameobjects/RenderTexture.js line 66

characterHeight : number

The height of each character in the font set.

Type:

• number

Source:

src/gameobjects/RetroFont.js line 45

characterPerRow : number

The number of characters per row in the font set.

Type:

• number

Source:

src/gameobjects/RetroFont.js line 60

characterSpacingX : number

If the characters in the font set have horizontal spacing between them set the required amount here.

Type:

• number

Source:

src/gameobjects/RetroFont.js line 50

characterSpacingY : number

If the characters in the font set have vertical spacing between them set the required amount here.

Type:

• number

Source:

src/gameobjects/RetroFont.js line 55

characterWidth : number

The width of each character in the font set.

Type:

• number

Source:

src/gameobjects/RetroFont.js line 40

crop : Rectangle

This is the area of the BaseTexture image to actually copy to the Canvas / WebGL when rendering, irrespective of the actual frame size or placement (which can be influenced by trimmed texture atlases)

Type:

• Rectangle

Inherited From:

• PIXI.Texture#crop

Source:

src/pixi/textures/Texture.js line 134

customSpacingX : number

Adds horizontal spacing between each character of the font, in pixels.

Type:

• number

Source:

src/gameobjects/RetroFont.js line 95

customSpacingY : number

Adds vertical spacing between each line of multi-line text, set in pixels.

Type:

• number

Source:

src/gameobjects/RetroFont.js line 101

fixedWidth : number

If you need this RetroFont image to have a fixed width you can set the width in this value. If text is wider than the width specified it will be cropped off.

Type:

• number

Source:

src/gameobjects/RetroFont.js line 108

fontSet : Image

A reference to the image stored in the Game.Cache that contains the font.

Type:

• Image

Source:

src/gameobjects/RetroFont.js line 113

frame : Rectangle

The frame specifies the region of the base texture that this texture uses

Type:

• Rectangle

Inherited From:

• PIXI.Texture#frame

Source:

src/pixi/textures/Texture.js line 60

frameData : Phaser.FrameData

The FrameData representing this Retro Font.

Type:

• Phaser.FrameData

Source:

src/gameobjects/RetroFont.js line 130

game : Phaser.Game

A reference to the currently running game.

Type:

• Phaser.Game

Inherited From:

• Phaser.RenderTexture#game

Source:

src/gameobjects/RenderTexture.js line 34

height : Number

The height of the Texture in pixels.

Type:

• Number

Inherited From:

• PIXI.Texture#height

Source:

src/pixi/textures/Texture.js line 125

isTiling : Boolean

Is this a tiling texture? As used by the likes of a TilingSprite.

Type:

• Boolean

Inherited From:

• PIXI.Texture#isTiling

Source:

src/pixi/textures/Texture.js line 84

key : string

The key of the RenderTexture in the Cache, if stored there.

Type:

• string

Inherited From:

• Phaser.RenderTexture#key

Source:

src/gameobjects/RenderTexture.js line 39

multiLine : boolean

If set to true all carriage-returns in text will form new lines (see align). If false the font will only contain one single line of text (the default)

Type:

• boolean

Source:

src/gameobjects/RetroFont.js line 83

noFrame : Boolean

Does this Texture have any frame data assigned to it?

Type:

• Boolean

Inherited From:

• PIXI.Texture#noFrame

Source:

src/pixi/textures/Texture.js line 33

<readonly> offsetX : number

If the font set doesn't start at the top left of the given image, specify the X coordinate offset here.

Type:

• number

Source:

src/gameobjects/RetroFont.js line 66

<readonly> offsetY : number

If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here.

Type:

• number

Source:

src/gameobjects/RetroFont.js line 72

renderer : CanvasRenderer | WebGLRenderer

The renderer this RenderTexture uses. A RenderTexture can only belong to one renderer at the moment if its webGL.

Type:

• CanvasRenderer | WebGLRenderer

Inherited From:

• Phaser.RenderTexture#renderer

Source:

src/gameobjects/RenderTexture.js line 84

requiresReTint : Boolean

This will let a renderer know that a tinted parent has updated its texture.

Type:

• Boolean

Inherited From:

• PIXI.Texture#requiresReTint

Overrides:

• Phaser.RenderTexture#requiresReTint

Source:

src/pixi/textures/Texture.js line 100

requiresUpdate : Boolean

This will let a renderer know that a texture has been updated (used mainly for webGL uv updates)

Type:

• Boolean

Inherited From:

• PIXI.Texture#requiresUpdate

Source:

src/pixi/textures/Texture.js line 92

rotated : Boolean

A flag that controls if this frame is rotated or not. Rotation allows you to use rotated frames in texture atlas packing, it has nothing to do with Sprite rotation.

Type:

• Boolean

Inherited From:

• PIXI.Texture#rotated

Source:

src/pixi/textures/Texture.js line 144

smoothed : boolean

Sets if the stamp is smoothed or not.

Type:

• boolean

Source:

src/gameobjects/RetroFont.js line 577

<readonly> stamp : Phaser.Image

The image that is stamped to the RenderTexture for each character in the font.

Type:

• Phaser.Image

Source:

src/gameobjects/RetroFont.js line 163

text : string

Set this value to update the text in this sprite. Carriage returns are automatically stripped out if multiLine is false. Text is converted to upper case if autoUpperCase is true.

Type:

• string

Source:

src/gameobjects/RetroFont.js line 541

trim : Rectangle

The texture trim data.

Type:

• Rectangle

Inherited From:

• PIXI.Texture#trim

Source:

src/pixi/textures/Texture.js line 68

type : number

Base Phaser object type.

Type:

• number

Overrides:

• Phaser.RenderTexture#type

Source:

src/gameobjects/RetroFont.js line 170

valid : Boolean

Type:

• Boolean

Inherited From:

• Phaser.RenderTexture#valid

Source:

src/gameobjects/RenderTexture.js line 107

width : Number

The width of the Texture in pixels.

Type:

• Number

Inherited From:

• PIXI.Texture#width

Source:

src/pixi/textures/Texture.js line 117

Methods

buildRetroFontText()

Updates the texture with the new text.

Source:

src/gameobjects/RetroFont.js line 325

clear()

Clears the RenderTexture.

Inherited From:

• Phaser.RenderTexture#clear

Source:

src/gameobjects/RenderTexture.js line 253

destroy(destroyBase)

Destroys this texture

Parameters:

Name	Type	Description
destroyBase	Boolean	Whether to destroy the base texture as well

Inherited From:

• PIXI.Texture#destroy

Source:

src/pixi/textures/Texture.js line 173

fromCanvas(canvas, scaleMode)

Helper function that creates a new a Texture based on the given canvas element.

Parameters:

Name	Type	Description
canvas	Canvas	The canvas element source of the texture
scaleMode	Number	See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values

Inherited From:

• PIXI.Texture#fromCanvas

Source:

src/pixi/textures/Texture.js line 283

Returns:

Type

Texture

getBase64( [type] [, encoderOptions])

Returns a base64 encoded string of this texture. It works by calling RenderTexture.getCanvas and then running toDataURL on that.

Parameters:

Name	Type	Argument	Description
type	string	<optional>	Image format.
encoderOptions	number	<optional>	Image quality, for lossy formats.

Inherited From:

• Phaser.RenderTexture#getBase64

Source:

src/gameobjects/RenderTexture.js line 407

See:

• https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toDataURL

Returns:

A base64 encoded string of the texture.

Type

String

getCanvas()

Creates a Canvas element, renders this RenderTexture to it and then returns it.

Inherited From:

• Phaser.RenderTexture#getCanvas

Source:

src/gameobjects/RenderTexture.js line 422

Returns:

A Canvas element with the texture rendered on.

Type

HTMLCanvasElement

getImage( [type] [, encoderOptions] [, onLoadCallback] [, onErrorCallback])

Returns an HTML Image of the texture

The image is loaded asynchronously, not right away. Use the callbacks if you need to wait for the loaded image.

Parameters:

Name	Type	Argument	Description
type	string	<optional>	Image format.
encoderOptions	number	<optional>	Image quality, for lossy formats.
onLoadCallback	function	<optional>	A function to call when the image loads.
onErrorCallback	function	<optional>	A function to call when the image fails to load.

Inherited From:

• Phaser.RenderTexture#getImage

Source:

src/gameobjects/RenderTexture.js line 380

See:

• https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toDataURL

Returns:

Type

Image

getLongestLine()

Works out the longest line of text in _text and returns its length

Source:

src/gameobjects/RetroFont.js line 455

Returns:

The length of the longest line of text.

Type

number

pasteLine(line, x, y, customSpacingX)

Internal function that takes a single line of text (2nd parameter) and pastes it into the BitmapData at the given coordinates. Used by getLine and getMultiLine

Parameters:

Name	Type	Description
line	string	The single line of text to paste.
x	number	The x coordinate.
y	number	The y coordinate.
customSpacingX	number	Custom X spacing.

Source:

src/gameobjects/RetroFont.js line 416

<protected> removeUnsupportedCharacters( [stripCR])

Internal helper function that removes all unsupported characters from the _text String, leaving only characters contained in the font set.

Parameters:

Name	Type	Argument	Default	Description
stripCR	boolean	<optional>	true	Should it strip carriage returns as well?

Source:

src/gameobjects/RetroFont.js line 482

Returns:

A clean version of the string.

Type

string

render(displayObject [, matrix] [, clear])

This function will draw the display object to the RenderTexture.

In versions of Phaser prior to 2.4.0 the second parameter was a Phaser.Point object. This is now a Matrix allowing you much more control over how the Display Object is rendered. If you need to replicate the earlier behavior please use Phaser.RenderTexture.renderXY instead.

If you wish for the displayObject to be rendered taking its current scale, rotation and translation into account then either pass null, leave it undefined or pass displayObject.worldTransform as the matrix value.

Parameters:

Name	Type	Argument	Default	Description
displayObject	Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Group			The display object to render to this texture.
matrix	Phaser.Matrix	<optional>		Optional matrix to apply to the display object before rendering. If null or undefined it will use the worldTransform matrix of the given display object.
clear	boolean	<optional>	false	If true the texture will be cleared before the display object is drawn.

Inherited From:

• Phaser.RenderTexture#render

Source:

src/gameobjects/RenderTexture.js line 175

renderRawXY(displayObject, x, y [, clear])

This function will draw the display object to the RenderTexture at the given coordinates.

When the display object is drawn it doesn't take into account scale, rotation or translation.

If you need those then use RenderTexture.renderXY instead.

Parameters:

Name	Type	Argument	Default	Description
displayObject	Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Group			The display object to render to this texture.
x	number			The x position to render the object at.
y	number			The y position to render the object at.
clear	boolean	<optional>	false	If true the texture will be cleared before the display object is drawn.

Inherited From:

• Phaser.RenderTexture#renderRawXY

Source:

src/gameobjects/RenderTexture.js line 148

renderXY(displayObject, x, y [, clear])

This function will draw the display object to the RenderTexture at the given coordinates.

When the display object is drawn it takes into account scale and rotation.

If you don't want those then use RenderTexture.renderRawXY instead.

Parameters:

Name	Type	Argument	Default	Description
displayObject	Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Group			The display object to render to this texture.
x	number			The x position to render the object at.
y	number			The y position to render the object at.
clear	boolean	<optional>	false	If true the texture will be cleared before the display object is drawn.

Inherited From:

• Phaser.RenderTexture#renderXY

Source:

src/gameobjects/RenderTexture.js line 117

resize(width, height, updateBase)

Resizes the RenderTexture.

Parameters:

Name	Type	Description
width	number	The width to resize to.
height	number	The height to resize to.
updateBase	boolean	Should the baseTexture.width and height values be resized as well?

Inherited From:

• Phaser.RenderTexture#resize

Source:

src/gameobjects/RenderTexture.js line 211

setFixedWidth(width [, lineAlignment])

If you need this RetroFont to have a fixed width and custom alignment you can set the width here. If text is wider than the width specified it will be cropped off.

Parameters:

Name	Type	Argument	Default	Description
width	number			Width in pixels of this RetroFont. Set to zero to disable and re-enable automatic resizing.
lineAlignment	string	<optional>	'left'	Align the text within this width. Set to RetroFont.ALIGN_LEFT (default), RetroFont.ALIGN_RIGHT or RetroFont.ALIGN_CENTER.

Source:

src/gameobjects/RetroFont.js line 274

setFrame(frame)

Specifies the region of the baseTexture that this texture will use.

Parameters:

Name	Type	Description
frame	Rectangle	The frame of the texture to set it to

Inherited From:

• PIXI.Texture#setFrame

Source:

src/pixi/textures/Texture.js line 186

setText(content [, multiLine] [, characterSpacing] [, lineSpacing] [, lineAlignment] [, allowLowerCase])

A helper function that quickly sets lots of variables at once, and then updates the text.

Parameters:

Name	Type	Argument	Default	Description
content	string			The text of this sprite.
multiLine	boolean	<optional>	false	Set to true if you want to support carriage-returns in the text and create a multi-line sprite instead of a single line.
characterSpacing	number	<optional>	0	To add horizontal spacing between each character specify the amount in pixels.
lineSpacing	number	<optional>	0	To add vertical spacing between each line of text, set the amount in pixels.
lineAlignment	string	<optional>	'left'	Align each line of multi-line text. Set to RetroFont.ALIGN_LEFT, RetroFont.ALIGN_RIGHT or RetroFont.ALIGN_CENTER.
allowLowerCase	boolean	<optional>	false	Lots of bitmap font sets only include upper-case characters, if yours needs to support lower case then set this to true.

Source:

src/gameobjects/RetroFont.js line 291

updateOffset( [xOffset] [, yOffset])

Updates the x and/or y offset that the font is rendered from. This updates all of the texture frames, so be careful how often it is called. Note that the values given for the x and y properties are either ADDED to or SUBTRACTED from (if negative) the existing offsetX/Y values of the characters. So if the current offsetY is 8 and you want it to start rendering from y16 you would call updateOffset(0, 8) to add 8 to the current y offset.

Parameters:

Name	Type	Argument	Default	Description
xOffset	number	<optional>	0	If the font set doesn't start at the top left of the given image, specify the X coordinate offset here.
yOffset	number	<optional>	0	If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here.

Source:

src/gameobjects/RetroFont.js line 509