Класс: Phaser.RetroFont

Конструктор

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

Параметры

Исходный код: gameobjects/RetroFont.js (Строка 25)

Расширяет

• Phaser.RenderTexture

Общественные свойства

[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

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

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

[static] TEXT_SET2 : string

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

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

[static] TEXT_SET3 : string

Text Set 3 = ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789

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

[static] TEXT_SET4 : string

Text Set 4 = ABCDEFGHIJKLMNOPQRSTUVWXYZ 0123456789

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

[static] TEXT_SET5 : string

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

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

[static] TEXT_SET6 : string

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

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

[static] TEXT_SET7 : string

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

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

[static] TEXT_SET8 : string

Text Set 8 = 0123456789 .ABCDEFGHIJKLMNOPQRSTUVWXYZ

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

[static] TEXT_SET9 : string

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

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

[static] TEXT_SET10 : string

Text Set 10 = ABCDEFGHIJKLMNOPQRSTUVWXYZ

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

[static] TEXT_SET11 : string

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

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

align : string

Выравнивание текста, когда multiLine = true или установлен fixedWidth. Установлено в RetroFont.ALIGN_LEFT (по умолчанию), RetroFont.ALIGN_RIGHT или RetroFont.ALIGN_CENTER.

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

autoUpperCase : boolean

Автоматически преобразовывать любой текст в верхний регистр. Многие старые растровые шрифты содержат только заглавные буквы, поэтому значение по умолчанию — true.

Default Value

• true

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

baseTexture : PIXI.BaseTexture

Объект базовой текстуры, используемый этой текстурой

Inherited From

• PIXI.RenderTexture#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, которая фактически копируется в Canvas/WebGL при отрисовке,
независимо от фактического размера или расположения фрейма (что может влиять на отсечённые текстуры атласа)

Inherited From

• PIXI.RenderTexture#crop

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

Ссылка на изображение, хранящееся в кэше Game, содержащее шрифт.

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

frame :Rectangle

Кадровая прямоугольная область рендеринг-текстуры

Inherited From

• PIXI.RenderTexture#frame

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

frameData : Phaser.FrameData

FrameData, представляющий этот Retro Шрифт.

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

game : Phaser.Game

Ссылка на текущую игру.

Inherited From

• Phaser.RenderTexture#game

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

height : number

Высота рендеринг-текстуры

Inherited From

• PIXI.RenderTexture#height

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

isTiling : boolean

Это текстура-плитка? Как используется в TilingSprite.

Inherited From

• PIXI.Texture#isTiling

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

key : string

Ключ RenderTexture в кэше, если он там хранится.

Inherited From

• Phaser.RenderTexture#key

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

multiLine : boolean

Если установлено в true, все символы возврата каретки в тексте будут образовывать новые строки (см. выравнивание). Если false, шрифт будет содержать только одну строку текста (по умолчанию)

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

noFrame : boolean

У этой Texture есть какие-либо данные фрейма?

Inherited From

• PIXI.Texture#noFrame

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

[readonly] offsetX : number

Если набор шрифтов не начинается с верхнего левого угла заданного изображения, укажите здесь координату смещения по оси X.

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

[readonly] offsetY : number

Если набор шрифтов не начинается с верхнего левого угла заданного изображения, укажите здесь координату смещения по оси Y.

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

renderer : PIXI.CanvasRenderer | PIXI.WebGLRenderer

Рендерер, используемый этим RenderTexture. В данный момент RenderTexture может принадлежать только одному рендереру, если это webGL.

Type

• PIXI.CanvasRenderer | PIXI.WebGLRenderer

Inherited From

• PIXI.RenderTexture#renderer

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

requiresReTint : boolean

Это позволит рендереру знать, что родитель с оттенком обновил свою текстуру.

Inherited From

• PIXI.Texture#requiresReTint

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

requiresUpdate : boolean

Это позволит рендереру знать, что текстура была обновлена (в основном для обновлений uv webGL)

Inherited From

• PIXI.Texture#requiresUpdate

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

resolution : number

Разрешение текстуры.

Inherited From

• PIXI.RenderTexture#resolution

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

Установите это значение, чтобы обновить текст в этом спрайте. Возвраты каретки автоматически удаляются, если multiLine равен false. Текст преобразуется в верхний регистр, если autoUpperCase равен true.

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

trim :Rectangle

Данные обрезки текстуры.

Inherited From

• PIXI.Texture#trim

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

type : number

Основной тип объекта Phaser.

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

valid : boolean

Inherited From

• PIXI.RenderTexture#valid

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

width : number

Ширина render-текстуры.

Inherited From

• PIXI.RenderTexture#width

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

Public Methods

buildRetroFontText()

Обновляет текстуру новым текстом.

Исходный код: gameobjects/RetroFont.js (Строка 328)

clear()

Очищает RenderTexture.

Унаследовано от

• PIXI.RenderTexture#clear

Исходный код: pixi/textures/RenderTexture.js (Строка 175)

destroy(destroyBase)

Уничтожает эту текстуру

Параметры

Имя	Тип	Описание
destroyBase	Boolean	Уничтожить базу текстуры также

Унаследовано от

• PIXI.Texture#destroy

Исходный код: pixi/textures/Texture.js (Строка 165)

getBase64() → {String}

Возвращает строку, закодированную в base64, этой текстуры. Она работает, вызывая RenderTexture.getCanvas, а затем выполняя toDataURL на нём.

Возвращает

String -

Строка, закодированная в base64, текстуры.

Унаследовано от

• PIXI.RenderTexture#getBase64

Исходный код: pixi/textures/RenderTexture.js (Строка 309)

getCanvas() → {HTMLCanvasElement}

Создаёт элемент Canvas, отрисовывает этот RenderTexture на нём и возвращает его.

Возвращает

HTMLCanvasElement -

Элемент Canvas с отрисованной текстурой.

Унаследовано от

• PIXI.RenderTexture#getCanvas

Исходный код: pixi/textures/RenderTexture.js (Строка 320)

getImage() → {Image}

Возвращает HTML Image текстуры

Возвращает

Image -

Унаследовано от

• PIXI.RenderTexture#getImage

Исходный код: pixi/textures/RenderTexture.js (Строка 296)

getLongestLine() → {number}

Определяет самую длинную строку текста в _text и возвращает её длину

Возвращает

number -

Длина самой длинной строки текста.

Исходный код: gameobjects/RetroFont.js (Строка 459)

pasteLine(line, x, y, customSpacingX)

Внутренняя функция, которая принимает одну строку текста (второй параметр) и вставляет её в BitmapData по заданным координатам.
Используется функциями getLine и getMultiLine

Параметры

Имя	Тип	Описание
line	string	Одна строка текста для вставки.
x	number	Координата x.
y	number	Координата y.
customSpacingX	number	Настройка интервала по оси X.

Исходный код: gameobjects/RetroFont.js (Строка 420)

<internal> removeUnsupportedCharacters(stripCR) → {string}

Внутренняя вспомогательная функция, которая удаляет все неподдерживаемые символы из строки _text, оставляя только символы, содержащиеся в наборе шрифтов.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
stripCR	boolean	<optional>	true	Удалить возвраты каретки?

Возвращает

string -

Очищенная версия строки.

Внутренняя:

• Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.

Исходный код: gameobjects/RetroFont.js (Строка 486)

render(displayObject, matrix, clear)

Эта функция нарисует элемент displayObject на RenderTexture.

В версиях Phaser до 2.4.0 второй параметр был объектом Phaser.Point.
Теперь это матрица, позволяющая вам гораздо больше управлять тем, как отображается элемент Display Object.
Если вам нужно воссоздать предыдущее поведение, используйте Phaser.RenderTexture.renderXY.

Если вы хотите, чтобы элемент displayObject был нарисован с учётом его текущего масштаба, поворота и перевода, то либо
передайте null, оставьте его неопределённым или передайте displayObject.worldTransform в качестве значения матрицы.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
displayObject	Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Group			Элемент display object для отрисовки на этой текстуре.
matrix	Phaser.Matrix	<optional>		Необязательная матрица для применения к элементу display object перед отрисовкой. Если null или undefined, будет использована матрица worldTransform заданного элемента display object.
clear	boolean	<optional>	false	Если true, текстура будет очищена перед отрисовкой элемента display object.

Унаследовано от

• Phaser.RenderTexture#render

Исходный код: gameobjects/RenderTexture.js (Строка 117)

renderRawXY(displayObject, x, y, clear)

Эта функция отобразит объект отображения на RenderTexture в заданных координатах.

При отрисовке объекта отображения не учитываются масштаб, поворот или смещение.

Если вам нужны эти параметры, используйте RenderTexture.renderXY вместо этого.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
displayObject	Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Group			Объект отображения, который необходимо отобразить на этой текстуре.
x	число			Позиция x для отрисовки объекта.
y	число			Позиция y для отрисовки объекта.
clear	логическое	<необязательно>	false	Если true, текстура будет очищена перед отрисовкой объекта отображения.

Унаследовано от

• Phaser.RenderTexture#renderRawXY

Исходный код: gameobjects/RenderTexture.js (Строка 89)

renderXY(displayObject, x, y, clear)

Эта функция отобразит объект отображения на RenderTexture в заданных координатах.

При отрисовке объекта отображения учитываются масштаб и поворот.

Если эти параметры не нужны, используйте RenderTexture.renderRawXY вместо этого.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
displayObject	Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Group			Объект отображения, который необходимо отобразить на этой текстуре.
x	число			Позиция x для отрисовки объекта.
y	число			Позиция y для отрисовки объекта.
clear	логическое	<необязательно>	false	Если true, текстура будет очищена перед отрисовкой объекта отображения.

Унаследовано от

• Phaser.RenderTexture#renderXY

Исходный код: gameobjects/RenderTexture.js (Строка 57)

resize(width, height, updateBase)

Изменяет размер RenderTexture.

Параметры

Имя	Тип	Описание
width	Число	Ширина, на которую необходимо изменить размер.
height	Число	Высота, на которую необходимо изменить размер.
updateBase	Логическое	Нужно ли также изменить значения baseTexture.width и height?

Унаследовано от

• PIXI.RenderTexture#resize

Исходный код: pixi/textures/RenderTexture.js (Строка 139)

setFixedWidth(width, lineAlignment)

Если нужно, чтобы этот RetroFont имел фиксированную ширину и пользовательское выравнивание, вы можете установить ширину здесь.
Если текст шире, чем указанная ширина, он будет усечен.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
width	число			Ширина этого RetroFont в пикселях. Установите в ноль, чтобы отключить и снова включить автоматическое изменение размера.
lineAlignment	строка	<необязательно>	'left'	Выровнять текст в этой ширине. Установите RetroFont.ALIGN_LEFT (по умолчанию), RetroFont.ALIGN_RIGHT или RetroFont.ALIGN_CENTER.

Исходный код: gameobjects/RetroFont.js (Строка 275)

setFrame(frame)

Указывает область baseTexture, которую будет использовать эта текстура.

Параметры

Имя	Тип	Описание
frame	Прямоугольник	Кадр текстуры, на который необходимо установить ее.

Унаследовано от

• PIXI.Texture#setFrame

Исходный код: pixi/textures/Texture.js (Строка 178)

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

Вспомогательная функция, которая быстро устанавливает множество переменных и затем обновляет текст.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
content	строка			Текст этого спрайта.
multiLine	логическое	<необязательно>	false	Установите в значение true, если вы хотите поддерживать символы возврата каретки в тексте и создавать многострочный спрайт вместо однострочного.
characterSpacing	число	<необязательно>	0	Чтобы добавить горизонтальное расстояние между каждым символом, укажите значение в пикселях.
lineSpacing	число	<необязательно>	0	Чтобы добавить вертикальное расстояние между каждой строкой текста, установите значение в пикселях.
lineAlignment	строка	<необязательно>	'left'	Выровнять каждую строку многострочного текста. Установите RetroFont.ALIGN_LEFT, RetroFont.ALIGN_RIGHT или RetroFont.ALIGN_CENTER.
allowLowerCase	логическое	<необязательно>	false	Многие наборы шрифтов bitmap содержат только символы верхнего регистра. Если ваш шрифт должен поддерживать символы нижнего регистра, установите это значение в true.

Исходный код: gameobjects/RetroFont.js (Строка 293)

updateOffset(xOffset, yOffset)

Обновляет смещение по оси X и/или Y, с которого отрисовывается шрифт. Это обновляет все текстурные кадры, поэтому будьте осторожны, как часто вы это делаете.
Обратите внимание, что значения, заданные для свойств x и y, либо добавляются к, либо вычитаются из (если отрицательные) существующих смещений offsetX/Y символов.
Таким образом, если текущее смещение по оси Y равно 8, и вы хотите начать отрисовку с y16, вы должны вызвать updateOffset(0, 8), чтобы добавить 8 к текущему смещению по оси Y.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
xOffset	число	<необязательно>	0	Если набор шрифтов не начинается в верхнем левом углу заданного изображения, укажите здесь смещение по координате X.
yOffset	число	<необязательно>	0	Если набор шрифтов не начинается в верхнем левом углу заданного изображения, укажите здесь смещение по координате Y.

Исходный код: gameobjects/RetroFont.js (Строка 514)