构造函数

new RetroFont(game, key, characterWidth, characterHeight, chars, charsPerRow, xSpacing, ySpacing, xOffset, yOffset)

复古的字体是一个类似bitmapfont,因为它使用一个纹理渲染文本。然而不同于bitmapfont每个字符在retrofont

参数

名称 类型 参数 默认值 描述
game Phaser.Game 当前游戏实例。
key string 字体设置图形设置为存储在game.cache。
characterWidth number 字体集合中的每个字符的宽度。
characterHeight number 字体集合中的每个字符的高度。
chars string 所使用的字体集,在显示顺序。你可以使用text_set常量常用字体设置安排。
charsPerRow number <optional> 字体集合中的每行字符数。如果没有给出charsperrow将图像宽度/基于字符宽度。
xSpacing number <optional> 0 如果字体中的字符设置为它们之间的水平间距,则在这里设置所需的量。
ySpacing number <optional> 0 如果字体中的字符设置为它们之间的垂直间隔,则在这里设置所需的量。
xOffset number <optional> 0 如果字体集合不在给定图像的左上方开始,在这里指定坐标偏移。
yOffset number <optional> 0 如果字体集合不在给定图像的左上方开始,在这里指定坐标偏移。

公共属性

[static] ALIGN_CENTER : string

将多行文本对齐到中心。

Source code: gameobjects/RetroFont.js (Line 196)

[static] ALIGN_LEFT : string

将多行文本对齐到左边。

Source code: gameobjects/RetroFont.js (Line 182)

[static] ALIGN_RIGHT : string

将多行文本对齐到右边。

Source code: gameobjects/RetroFont.js (Line 189)

[static] TEXT_SET1 : string

文本设置1 =!";# $ % & amp;'()* +,-,/ 0123456789:;<;= & gt;?“有[ ] ^ _ `有| ~ { }

Source code: gameobjects/RetroFont.js (Line 203)

[static] TEXT_SET2 : string

文本设置2 =!";# $ % & amp;'()* +,-,/ 0123456789:;<;= & gt;?“有

Source code: gameobjects/RetroFont.js (Line 210)

[static] TEXT_SET3 : string

文本集3 = abcdefghijklmnopqrstuvwxyz0123456789

Source code: gameobjects/RetroFont.js (Line 217)

[static] TEXT_SET4 : string

文本集4 =有0123456789

Source code: gameobjects/RetroFont.js (Line 224)

[static] TEXT_SET5 : string

文本集5 =有,/()”!?•0123456789

Source code: gameobjects/RetroFont.js (Line 231)

[static] TEXT_SET6 : string

文本集6 =有!?:0123456789、“(),”

Source code: gameobjects/RetroFont.js (Line 238)

[static] TEXT_SET7 : string

文本集7 = agmsy +:4bhntz!;5ciou。?06djpv,(17ekqw ";)28flrx -在

Source code: gameobjects/RetroFont.js (Line 245)

[static] TEXT_SET8 : string

文本集8 =有0123456789。

Source code: gameobjects/RetroFont.js (Line 252)

[static] TEXT_SET9 : string

文本集9 = abcdefghijklmnopqrstuvwxyz() 0123456789。:,“";?!

Source code: gameobjects/RetroFont.js (Line 259)

[static] TEXT_SET10 : string

文本集10 =有

Source code: gameobjects/RetroFont.js (Line 266)

[static] TEXT_SET11 : string

文本集11 =有,";+!():0123456789

Source code: gameobjects/RetroFont.js (Line 273)

align : string

对齐的文本时,多行=真实或fixedwidth设置。设置retrofont.align_left(默认),retrofont.align_right或retrofont.align_center。

Source code: gameobjects/RetroFont.js (Line 77)

autoUpperCase : boolean

自动转换任何文本到大写。很多旧的位图字体只包含大写字符,所以默认情况下是真的。

Source code: gameobjects/RetroFont.js (Line 89)

baseTexture : PIXI.BaseTexture

这种纹理使用的基础纹理对象

Source code: pixi/textures/RenderTexture.js (Line 78)

characterHeight : number

字体集合中的每个字符的高度。

Source code: gameobjects/RetroFont.js (Line 45)

characterPerRow : number

字体集合中的每行字符数。

Source code: gameobjects/RetroFont.js (Line 60)

characterSpacingX : number

如果字体中的字符设置为它们之间的水平间距,则在这里设置所需的量。

Source code: gameobjects/RetroFont.js (Line 50)

characterSpacingY : number

如果字体中的字符设置为它们之间的垂直间隔,则在这里设置所需的量。

Source code: gameobjects/RetroFont.js (Line 55)

characterWidth : number

字体集合中的每个字符的宽度。

Source code: gameobjects/RetroFont.js (Line 40)

crop :Rectangle

这是真正的basetexture图像复制到画布上/ WebGL渲染时的地区,

Source code: pixi/textures/RenderTexture.js (Line 69)

customSpacingX : number

增加字体的每个字符之间的水平间距。

Source code: gameobjects/RetroFont.js (Line 95)

customSpacingY : number

增加多行文本的每行之间的垂直间隔,设置像素。

Source code: gameobjects/RetroFont.js (Line 101)

fixedWidth : number

如果你需要这retrofont形象有一个固定的宽度可以在这个值设置宽度。

Source code: gameobjects/RetroFont.js (Line 108)

fontSet :Image

存储在游戏中的图像的参考,包含字体的缓存。

Source code: gameobjects/RetroFont.js (Line 113)

frame :Rectangle

渲染纹理的帧矩形

Source code: pixi/textures/RenderTexture.js (Line 61)

frameData : Phaser.FrameData

代表的复古字体framedata。

Source code: gameobjects/RetroFont.js (Line 130)

game : Phaser.Game

一个参考目前正在运行的游戏。

Source code: gameobjects/RenderTexture.js (Line 31)

height : number

渲染纹理的高度

Source code: pixi/textures/RenderTexture.js (Line 45)

isTiling : boolean

这是一个平铺纹理?由一个tilingsprite喜欢使用。

Source code: pixi/textures/Texture.js (Line 84)

key : string

在缓存RenderTexture的关键,如果存储在。

Source code: gameobjects/RenderTexture.js (Line 36)

multiLine : boolean

如果设置为真实的所有回车符文本将构成新的行(见对齐)。如果假字体将只包含一行文本(默认)

Source code: gameobjects/RetroFont.js (Line 83)

noFrame : boolean

这个纹理是否有分配给它的帧数据?

Source code: pixi/textures/Texture.js (Line 33)

[readonly] offsetX : number

如果字体集合不在给定图像的左上方开始,在这里指定坐标偏移。

Source code: gameobjects/RetroFont.js (Line 66)

[readonly] offsetY : number

如果字体集合不在给定图像的左上方开始,在这里指定坐标偏移。

Source code: gameobjects/RetroFont.js (Line 72)

renderer : PIXI.CanvasRenderer | PIXI.WebGLRenderer

渲染这个RenderTexture使用。一个RenderTexture只能属于一个渲染此刻如果WebGL。

Source code: pixi/textures/RenderTexture.js (Line 99)

requiresReTint : boolean

这会让渲染器知道父已更新其纹理着色。

Source code: pixi/textures/Texture.js (Line 100)

requiresUpdate : boolean

这会让渲染器知道纹理已经更新(主要用于WebGL UV更新)

Source code: pixi/textures/Texture.js (Line 92)

resolution : number

纹理的分辨率。

Source code: pixi/textures/RenderTexture.js (Line 53)

smoothed : boolean

集如果该邮票是平滑或不。

Source code: gameobjects/RetroFont.js (Line 585)

[readonly] stamp : Phaser.Image

是印到RenderTexture字体中的每个字符图像。

Source code: gameobjects/RetroFont.js (Line 163)

text : string

设置此值来更新该精灵中的文本。回车自动剥离出来,如果多是假的。文本转换为大写如果autouppercase是真实的。

Source code: gameobjects/RetroFont.js (Line 547)

trim :Rectangle

纹理修剪数据。

Source code: pixi/textures/Texture.js (Line 68)

type : number

基准相位的对象类型。

Source code: gameobjects/RetroFont.js (Line 170)

valid : boolean

渲染纹理的

Source code: pixi/textures/RenderTexture.js (Line 125)

公共方法

buildRetroFontText()

用新文本更新纹理。

Source code: gameobjects/RetroFont.js (Line 328)


clear()

清除RenderTexture。

Source code: pixi/textures/RenderTexture.js (Line 175)


destroy(destroyBase)

破坏这种纹理

参数

名称 类型 参数 默认值 描述
destroyBase Boolean <是否破坏基纹理,以及< / <

Source code: pixi/textures/Texture.js (Line 170)


getBase64() → {String}

将返回一个Base64编码的字符串的纹理。它通过调用rendertexture.getcanvas然后运行todataurl上。

Source code: pixi/textures/RenderTexture.js (Line 309)


getCanvas() → {HTMLCanvasElement}

创建一个画布元素,使得RenderTexture再返回。

Source code: pixi/textures/RenderTexture.js (Line 320)


getImage() → {Image}

将返回一个HTML图像的纹理

Source code: pixi/textures/RenderTexture.js (Line 296)


getLongestLine() → {number}

作品中文字的_text线路最长并返回它的长度

Source code: gameobjects/RetroFont.js (Line 459)


pasteLine(line, x, y, customSpacingX)

内部功能,以单行文本(第二参数)粘贴到位图数据在给定的坐标。

参数

名称 类型 参数 默认值 描述
line string <单行文本为“粘贴”。
x number < * * *坐标。
y number < [或>的坐标。
customSpacingX number “自定义×间距。”

Source code: gameobjects/RetroFont.js (Line 420)


<internal> removeUnsupportedCharacters(stripCR) → {string}

内部辅助功能,删除所有不支持的字符从_text字符串,只留下文字所包含的字体设置。

参数

名称 类型 参数 默认值 描述
stripCR boolean <optional>
true 还应该是条运输车的回报吗?< /对

Source code: gameobjects/RetroFont.js (Line 486)


render(displayObject, matrix, clear)

该函数将显示对象到RenderTexture。

参数

名称 类型 参数 默认值 描述
displayObject Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Group “显示对象要呈现此纹理。”
matrix Phaser.Matrix <optional>
在呈现对象之前,要使用“可选的矩阵”来应用于显示对象。如果为空或未定义它将给出使用显示对象的worldtransform矩阵。

clear boolean <optional>
false 如果在显示对象被绘制对象之前,该纹理将被清除。

Source code: gameobjects/RenderTexture.js (Line 118)


renderRawXY(displayObject, x, y, clear)

该函数将显示对象到RenderTexture在给定的坐标。

参数

名称 类型 参数 默认值 描述
displayObject Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Group “显示对象要呈现此纹理。”
x number < >的位置,以使对象在。
y number < < >的位置,以使对象在。
clear boolean <optional>
false 如果在显示对象被绘制对象之前,该纹理将被清除。

Source code: gameobjects/RenderTexture.js (Line 90)


renderXY(displayObject, x, y, clear)

该函数将显示对象到RenderTexture在给定的坐标。

参数

名称 类型 参数 默认值 描述
displayObject Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Group “显示对象要呈现此纹理。”
x number < >的位置,以使对象在。
y number < < >的位置,以使对象在。
clear boolean <optional>
false 如果在显示对象被绘制对象之前,该纹理将被清除。

Source code: gameobjects/RenderTexture.js (Line 58)


resize(width, height, updateBase)

调整RenderTexture。

参数

名称 类型 参数 默认值 描述
width Number <该宽度可调整为。
height Number < >的高度来调整大小。
updateBase Boolean

应该basetexture.width和高度值被调整吗?< /对

Source code: pixi/textures/RenderTexture.js (Line 139)


setFixedWidth(width, lineAlignment)

如果你需要这retrofont有固定的宽度和自定义对齐可以设置宽度在这里。

参数

名称 类型 参数 默认值 描述
width number
在这retrofont像素宽度。设置为禁用和重新启用自动调整大小。

lineAlignment string <optional>
'left' 在这个宽度范围内调整文本。设置retrofont.align_left(默认),retrofont.align_right或retrofont。align_center。

Source code: gameobjects/RetroFont.js (Line 275)


setFrame(frame)

指定的basetexture,纹理将使用区域。

参数

名称 类型 参数 默认值 描述
frame Rectangle “纹理的帧设置为< /”

Source code: pixi/textures/Texture.js (Line 183)


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

一个辅助函数,快速地在一次设置大量的变量,然后更新文本。

参数

名称 类型 参数 默认值 描述
content string “这个精灵的文本”。
multiLine boolean <optional>
false 如果你想支持文本中的回车符,并创建一个多行的精灵,而不是一行。
characterSpacing number <optional>
0 在每个字符之间添加一个水平间隔,指定像素的量。
lineSpacing number <optional>
0 在文本的每行之间添加垂直间隔,设置像素的量。
lineAlignment string <optional>
'left' <对多行文本对齐每行。设置retrofont.align_left,retrofont.align_right或retrofont。align_center。

allowLowerCase boolean <optional>
false 如果您需要支持较低的情况,则将此设置为真。

Source code: gameobjects/RetroFont.js (Line 293)


updateOffset(xOffset, yOffset)

更新的或/或偏移的字体是从。这更新所有的纹理帧,所以要小心,它被称为。

参数

名称 类型 参数 默认值 描述
xOffset number <optional>
0 如果在给定图像的左上方的字体设置并没有开始,在这里指定坐标偏移量。
yOffset number <optional>
0 如果在给定图像的左上方的字体设置并没有开始,在这里指定坐标偏移量。

Source code: gameobjects/RetroFont.js (Line 514)