Класс: Phaser.GameObjectCreator

Конструктор

new GameObjectCreator(game)

Параметры

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

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

<internal> game : Phaser.Game

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

Внутреннее:

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

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

<internal> world : Phaser.World

Ссылка на игровой мир.

Внутреннее:

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

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

Общедоступные методы

audio(key, volume, loop, connect) → {Phaser.Sound}

Создаёт новый объект Sound.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	string			Ключ Game.cache звука, который будет использовать этот объект.
volume	number	<optional>	1	Громкость, с которой будет воспроизводиться звук.
loop	boolean	<optional>	false	Циклическое воспроизведение звука.
connect	boolean	<optional>	true	Определяет, будет ли созданный объект Sound подключён к узлу усиления master gainNode SoundManager при работе в WebAudio.

Возвращаемое значение

Phaser.Sound -

Новый созданный объект звука.

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

audioSprite(key) → {Phaser.AudioSprite}

Создаёт новый объект AudioSprite.

Параметры

Имя	Тип	Описание
key	string	Ключ Game.cache звука, который будет использовать этот объект.

Возвращаемое значение

Phaser.AudioSprite -

Новый созданный объект AudioSprite.

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

bitmapData(width, height, key, addToCache) → {Phaser.BitmapData}

Создаёт объект BitmpaData.

Объект BitmapData может быть изменён и нарисован, как обычный объект Canvas, и использован для текстурирования Sprites.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
width	number	<optional>	256	Ширина BitmapData в пикселях.
height	number	<optional>	256	Высота BitmapData в пикселях.
key	string	<optional>	''	Ключ актива для BitmapData при хранении в кэше (см. параметр addToCache).
addToCache	boolean	<optional>	false	Добавить BitmapData в Game.Cache? Если да, то его можно получить с помощью Cache.getBitmapData(key)

Возвращаемое значение

Phaser.BitmapData -

Новый созданный объект BitmapData.

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

bitmapText(x, y, font, text, size, align) → {Phaser.BitmapText}

Создаёт новый объект BitmapText.

Объекты BitmapText работают с файлом текстуры и XML-файлом, описывающим структуру шрифта.
Затем он генерирует новый объект Sprite для каждой буквы текста, равномерно расположенные и выровненные
в соответствии со структурой шрифта.

Объекты BitmapText менее гибкие, чем объекты Text, у них меньше функций, таких как тени, заливки и возможность
использования веб-шрифтов. Однако, вы получаете чистую скорость рендеринга. Также можно создавать визуально привлекательные BitmapText, предварительно обработав текстуру шрифта в графическом редакторе, добавив заливки и другие эффекты.

Для создания многострочного текста в строке текста используйте escape-коды \r, \n или \r\n.

Для создания данных BitmapText вы можете использовать:

BMFont (Windows, бесплатно): http://www.angelcode.com/products/bmfont/
Glyph Designer (OS X, платно): http://www.71squared.com/en/glyphdesigner
Littera (Веб-приложение, бесплатно): http://kvazars.com/littera/

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
x	number			Координата X для отображения объекта BitmapText.
y	number			Координата Y для отображения объекта BitmapText.
font	string			Ключ BitmapText, хранящийся в Phaser.Cache.
text	string	<optional>	''	Текст, который будет отображаться. Это также можно установить позже через BitmapText.text.
size	number	<optional>	32	Размер шрифта в пикселях.
align	string	<optional>	'left'	Выравнивание многострочного текста. Не имеет эффекта, если текст состоит из одной строки.

Возвращаемое значение

Phaser.BitmapText -

Новый созданный объект bitmapText.

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

button(x, y, key, callback, callbackContext, overFrame, outFrame, downFrame, upFrame) → {Phaser.Button}

Создаёт новый объект Button.

Параметры

Имя	Тип	Аргумент	Описание
x	число	<необязательно>	Позиция X нового объекта кнопки.
y	число	<необязательно>	Позиция Y нового объекта кнопки.
key	строка	<необязательно>	Ключ изображения, как определено в Game.Cache, используемый в качестве текстуры для этой кнопки.
callback	функция	<необязательно>	Функция, вызываемая при нажатии на эту кнопку.
callbackContext	объект	<необязательно>	Контекст, в котором будет вызван обратный вызов (обычно 'this').
overFrame	строка | число	<необязательно>	Это кадр или имя кадра, которое будет установлено, когда эта кнопка находится в состоянии наведения. Укажите число для использования идентификатора кадра или строку для имени кадра.
outFrame	строка | число	<необязательно>	Это кадр или имя кадра, которое будет установлено, когда эта кнопка находится в состоянии выхода. Укажите число для использования идентификатора кадра или строку для имени кадра.
downFrame	строка | число	<необязательно>	Это кадр или имя кадра, которое будет установлено, когда эта кнопка находится в состоянии нажатия. Укажите число для использования идентификатора кадра или строку для имени кадра.
upFrame	строка | число	<необязательно>	Это кадр или имя кадра, которое будет установлено, когда эта кнопка находится в состоянии отжатия. Укажите число для использования идентификатора кадра или строку для имени кадра.

Возвращаемое значение

Phaser.Button -

Новый созданный объект кнопки.

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

emitter(x, y, maxParticles) → {Phaser.Emitter}

Создаёт новый объект Emitter.

Emitter — это лёгкий эмиттер частиц. Его можно использовать для одноразовых взрывов или для
непрерывных эффектов, таких как дождь и огонь. Всё, что он делает, — это запускает объекты Particle с определёнными интервалами и фиксирует их позиции и скорости.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
x	число	<необязательно>	0	Координата X внутри Emitter, откуда испускаются частицы.
y	число	<необязательно>	0	Координата Y внутри Emitter, откуда испускаются частицы.
maxParticles	число	<необязательно>	50	Общее количество частиц в этом эмиттере.

Возвращаемое значение

Phaser.Emitter -

Новый созданный объект эмиттера.

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

filter(filter) → {Phaser.Filter}

WebGL шейдер/фильтр, который может быть применён к Sprites.

Параметры

Имя	Тип	Описание
filter	строка	Имя фильтра, который вы хотите создать, например HueRotate или SineWave.
	любой	Любые параметры, которые необходимо передать в функцию инициализации фильтра.

Возвращаемое значение

Phaser.Filter -

Новый созданный объект Phaser.Filter.

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

graphics(x, y) → {Phaser.Graphics}

Создаёт новый объект Graphics.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
x	число	<необязательно>	0	Позиция X нового объекта graphics.
y	число	<необязательно>	0	Позиция Y нового объекта graphics.

Возвращаемое значение

Phaser.Graphics -

Новый созданный объект graphics.

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

group(parent, name, addToStage, enableBody, physicsBodyType) → {Phaser.Group}

Группа — это контейнер для элементов отображения, который позволяет быстро использовать пулы, повторное использование и проверку столкновений.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
parent	любой			Родительская группа или DisplayObjectContainer, содержащая эту группу, если есть.
name	строка	<необязательно>	'group'	Имя этой группы. Не используется внутри, но полезно для отладки.
addToStage	логическое	<необязательно>	false	Если установлено в true, эта группа будет добавлена непосредственно на Game.Stage вместо Game.World.
enableBody	логическое	<необязательно>	false	Если true, все Sprites, созданные с помощью Group.create или Group.createMulitple, будут иметь созданный на них физический объект. Тип физического объекта меняется с помощью physicsBodyType.
physicsBodyType	число	<необязательно>	0	Если enableBody равен true, это тип физического объекта, который создаётся на новых Sprite. Phaser.Physics.ARCADE, Phaser.Physics.P2, Phaser.Physics.NINJA и т. д.

Возвращаемое значение

Phaser.Group -

Новая созданная группа.

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

image(x, y, key, frame) → {Phaser.Image}

Создайте новый объект Image.

Image — это лёгкий объект, который можно использовать для отображения всего, что не нуждается в физике или анимации.
Он всё ещё может вращаться, масштабироваться, обрезаться и получать события ввода. Это идеально подходит для логотипов, фонов, простых кнопок и другой графики, не являющейся спрайтами.

Параметры

Имя	Тип	Аргумент	Описание
x	число		Позиция X изображения.
y	число		Позиция Y изображения.
key	строка | Phaser.RenderTexture | PIXI.Texture		Это изображение или текстура, используемые спрайтом во время отрисовки. Может быть строкой, которая ссылается на запись в кэше, или экземпляром RenderTexture или PIXI.Texture.
frame	строка | число	<необязательно>	Если спрайт использует изображение из текстурного атласа или спрайт-щита, вы можете передать фрейм здесь. Либо число для идентификатора фрейма, либо строка для имени фрейма.

Возвращает

Phaser.Image -

созданный объект спрайта.

Source code: gameobjects/GameObjectCreator.js (Line 33)

renderTexture(width, height, key, addToCache) → {Phaser.RenderTexture}

Динамическая, изначально пустая холщовая область, на которую можно рисовать изображения.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
width	число	<необязательно>	100	ширина RenderTexture.
height	число	<необязательно>	100	высота RenderTexture.
key	строка	<необязательно>	''	Ключ ресурса для RenderTexture при хранении в кэше (см. параметр addToCache).
addToCache	логическое	<необязательно>	false	Должен ли этот RenderTexture быть добавлен в Game.Cache? В этом случае его можно получить с помощью Cache.getTexture(key)

Возвращает

Phaser.RenderTexture -

Созданный объект RenderTexture.

Source code: gameobjects/GameObjectCreator.js (Line 353)

retroFont(font, characterWidth, characterHeight, chars, charsPerRow, xSpacing, ySpacing, xOffset, yOffset) → {Phaser.RetroFont}

Создайте новый объект RetroFont.

RetroFont можно использовать в качестве текстуры для Image или Sprite, а также необязательно добавить в кэш.
RetroFont использует карту битов, которая содержит символы фиксированной ширины для набора шрифтов. Вы используете интервал символов для определения набора.
Если вам нужен набор символов с переменной шириной, используйте объект BitmapText вместо него. Основное отличие между RetroFont и BitmapText
в том, что RetroFont создает одну текстуру, которую вы можете применить к объекту игры, а BitmapText создает один объект спрайта на каждую букву текста.
Текстура может быть назначена или одному, или нескольким изображениям/спрайтам, но обратите внимание, что текст, используемый RetroFont, будет общим для всех них,
т.е. если вам нужно, чтобы у каждого Image был другой текст, вам нужно создать несколько объектов RetroFont.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
font	строка			Ключ изображения в Game.Cache, который будет использоваться RetroFont.
characterWidth	число			Ширина каждого символа в наборе шрифтов.
characterHeight	число			Высота каждого символа в наборе шрифтов.
chars	строка			Символы, используемые в наборе шрифтов в порядке отображения. Вы можете использовать константы TEXT_SET для общих схем расположения наборов шрифтов.
charsPerRow	число			Количество символов в строке в наборе шрифтов.
xSpacing	число	<необязательно>	0	Если символы в наборе шрифтов имеют горизонтальный интервал, задайте требуемое значение здесь.
ySpacing	число	<необязательно>	0	Если символы в наборе шрифтов имеют вертикальный интервал, задайте требуемое значение здесь.
xOffset	число	<необязательно>	0	Если набор шрифтов не начинается в левом верхнем углу заданного изображения, укажите смещение координаты X здесь.
yOffset	число	<необязательно>	0	Если набор шрифтов не начинается в левом верхнем углу заданного изображения, укажите смещение координаты Y здесь.

Возвращает

Phaser.RetroFont -

Новая текстура RetroFont, которую можно применить к Image или Sprite.

Source code: gameobjects/GameObjectCreator.js (Line 269)

rope(x, y, width, height, key, frame) → {Phaser.Rope}

Создаёт новый объект Rope.

Параметры

Имя	Тип	Описание
x	число	Координата x (в пространстве мира) для размещения верёвки.
y	число	Координата y (в пространстве мира) для размещения верёвки.
width	число	Ширина верёвки.
height	число	Высота верёвки.
key	строка | Phaser.RenderTexture | Phaser.BitmapData | PIXI.Texture	Изображение или текстура, используемая TileSprite при отрисовке. Может быть строкой, которая является ссылкой на запись кэша, или экземпляром RenderTexture или PIXI.Texture.
frame	строка | число	Если эта верёвка использует часть спрайта или текстурной карты, вы можете указать конкретный кадр, передав строку или числовой индекс.

Возвращает

Phaser.Rope -

Созданный объект верёвки.

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

sound(key, volume, loop, connect) → {Phaser.Sound}

Создаёт новый объект Sound.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
key	строка			Ключ Game.cache для звука, который будет использоваться этим объектом.
volume	число	<необязательно>	1	Громкость, с которой будет воспроизводиться звук.
loop	булево	<необязательно>	false	Циклическое воспроизведение звука или нет.
connect	булево	<необязательно>	true	Определяет, будет ли созданный объект Sound подключён к главному узлу усиления SoundManager при работе с WebAudio.

Возвращает

Phaser.Sound -

Созданный объект текстового объекта.

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

sprite(x, y, key, frame) → {Phaser.Sprite}

Создаёт новый Sprite с заданной позицией и ключом спрайт-листа.

Параметры

Имя	Тип	Аргумент	Описание
x	число		Позиция X нового спрайта.
y	число		Позиция Y нового спрайта.
key	строка | Phaser.RenderTexture | PIXI.Texture		Изображение или текстура, используемая Sprite при отрисовке. Может быть строкой, которая является ссылкой на запись кэша, или экземпляром RenderTexture или PIXI.Texture.
frame	строка | число	<необязательно>	Если спрайт использует изображение из текстурной карты или спрайт-листа, вы можете указать кадр здесь. Либо число для идентификатора кадра, либо строка для имени кадра.

Возвращает

Phaser.Sprite -

созданный объект спрайта.

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

spriteBatch(parent, name, addToStage) → {Phaser.SpriteBatch}

Создаёт новый SpriteBatch.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
parent	любой			Родительская группа или DisplayObjectContainer, которая будет содержать эту группу, если она есть.
name	строка	<необязательно>	'group'	Имя этой группы. Не используется во внутреннем представлении, но полезно для отладки.
addToStage	булево	<необязательно>	false	Если установлено в true, эта группа будет добавлена непосредственно в Game.Stage вместо Game.World.

Возвращает

Phaser.SpriteBatch -

Созданная группа.

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

text(x, y, text, style) → {Phaser.Text}

Создаёт новый объект Text.

Параметры

Имя	Тип	Описание
x	число	Позиция X нового объекта текста.
y	число	Позиция Y нового объекта текста.
text	строка	Фактический текст, который будет выведен.
style	объект	Объект стиля, содержащий атрибуты стиля, такие как шрифт, размер шрифта и т. д.

Возвращает

Phaser.Text -

Созданный объект текстового объекта.

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

tilemap(key, tileWidth, tileHeight, width, height)

Создаёт новый объект Phaser.Tilemap.

Карта может быть заполнена данными из файла Tiled JSON или из CSV-файла.
Для этого передайте ключ кэш в качестве первого параметра. При использовании данных Tiled вам нужно указать только ключ.
При использовании данных CSV необходимо указать ключ, а также параметры tileWidth и tileHeight.
Если вы создаёте пустую карту для последующей заполнения, вы можете либо не указывать параметров, а затем использовать Tilemap.create, либо передать размеры карты и плиток.
Обратите внимание, что все Tilemap используют базовый размер плитки для расчёта размеров, но TilemapLayer может иметь свой уникальный размер плитки, который переопределяет его.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
key	string	<optional>		Ключ данных карты плиток, хранящихся в кэше. Если вы создаёте пустую карту, либо опустите этот параметр, либо передайте null.
tileWidth	number	<optional>	32	Ширина одной плитки карты в пикселях. Необходимо указать при использовании CSV-данных. Не требуется при использовании данных карты Tiled.
tileHeight	number	<optional>	32	Высота одной плитки карты в пикселях. Необходимо указать при использовании CSV-данных. Не требуется при использовании данных карты Tiled.
width	number	<optional>	10	Ширина карты в плитках. Не требуется, если карта создаётся из данных Tiled или CSV.
height	number	<optional>	10	Высота карты в плитках. Не требуется, если карта создаётся из данных Tiled или CSV.

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

tileSprite(x, y, width, height, key, frame) → {Phaser.TileSprite}

Создаёт новый объект TileSprite.

Параметры

Имя	Тип	Описание
x	number	Координата x (в глобальном пространстве) для размещения TileSprite.
y	number	Координата y (в глобальном пространстве) для размещения TileSprite.
width	number	Ширина TileSprite.
height	number	Высота TileSprite.
key	string | Phaser.BitmapData | PIXI.Texture	Изображение или текстура, используемые TileSprite при отрисовке. Может быть строкой, которая ссылается на запись в кэше изображений Phaser, или экземпляром PIXI.Texture или BitmapData.
frame	string | number	Если TileSprite использует часть спрайта или текстуры атласа, вы можете указать точный кадр, указав строку или числовой индекс.

Возвращает

Phaser.TileSprite -

Созданный объект tileSprite.

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

tween(obj) → {Phaser.Tween}

Создаёт объект tween для определённого объекта.

Объект может быть любым JavaScript-объектом или объектом Phaser, таким как Sprite.

Параметры

Имя	Тип	Описание
obj	object	Объект, на котором будет выполняться tween.

Возвращает

Phaser.Tween -

Объект Tween.

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