Класс: Phaser.GameObjectFactory
Конструктор
new GameObjectFactory(game)
GameObjectFactory — это быстрый способ создания многих общих объектов игры
используя .game.add
Созданные объекты автоматически добавляются в соответствующий менеджер, мир или в явно указанную родительскую группу.
Параметры
| Имя | Тип | Описание |
|---|---|---|
game | Phaser.Game | Ссылка на текущую запущенную игру. |
- Исходный код: gameobjects/GameObjectFactory.js (Строка 17)
Общедоступные свойства
- Внутреннее:
- Этот член является внутренним (защищенным) и может быть изменён или удалён в будущем.
- Исходный код: gameobjects/GameObjectFactory.js (Строка 23)
- Внутреннее:
- Этот член является внутренним (защищенным) и может быть изменён или удалён в будущем.
- Исходный код: gameobjects/GameObjectFactory.js (Строка 29)
<internal> game : Phaser.Game
Ссылка на текущую запущенную игру.
<internal> world : Phaser.World
Ссылка на мир игры.
Общедоступные методы
- Исходный код: gameobjects/GameObjectFactory.js (Строка 230)
- Исходный код: gameobjects/GameObjectFactory.js (Строка 262)
- Исходный код: gameobjects/GameObjectFactory.js (Строка 526)
- Исходный код: gameobjects/GameObjectFactory.js (Строка 425)
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. |
Возвращаемое значение
Новый созданный объект звука.
audioSprite(key) → {Phaser.AudioSprite}
Создаёт новый объект AudioSprite.
Параметры
| Имя | Тип | Описание |
|---|---|---|
key | string | Ключ Game.cache для звука, который будет использовать этот объект. |
Возвращаемое значение
Новый созданный объект AudioSprite.
bitmapData(width, height, key, addToCache) → {Phaser.BitmapData}
Создаёт объект BitmapData.
Объект BitmapData может быть изменён и нарисован на нём, как традиционный объект Canvas, и использован для текстурирования Sprite.
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
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) |
Возвращаемое значение
Новый созданный объект BitmapData.
bitmapText(x, y, font, text, size, group) → {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 | Размер шрифта в пикселях. |
group | Phaser.Group | <optional> | Дополнительная группа для добавления объекта. Если не указано, он будет добавлен в группу World. |
Возвращаемое значение
Созданный объект bitmapText.
button(x, y, key, callback, callbackContext, overFrame, outFrame, downFrame, upFrame, group) → {Phaser.Button}
Создаёт новый объект Button.
Параметры
- Исходный код: gameobjects/GameObjectFactory.js (Строка 337)
- Исходный код: gameobjects/GameObjectFactory.js (Строка 125)
- Исходный код: gameobjects/GameObjectFactory.js (Строка 378)
- Исходный код: gameobjects/GameObjectFactory.js (Строка 35)
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
x | число | <необязательно> | 0 | Координата x кнопки. Координата относительна любому контейнеру-родителю, в котором может находиться эта кнопка. |
y | число | <необязательно> | 0 | Координата y кнопки. Координата относительна любому контейнеру-родителю, в котором может находиться эта кнопка. |
key | строка | <необязательно> | Ключ изображения, определённый в Game.Cache, используемый в качестве текстуры для этой кнопки. | |
callback | функция | <необязательно> | Функция, вызываемая при нажатии этой кнопки. | |
callbackContext | объект | <необязательно> | Контекст, в котором будет вызван обратный вызов (обычно «this») | |
overFrame | строка | число | <необязательно> | Это кадр или имя кадра, которое будет установлено, когда эта кнопка находится в состоянии наведения. Укажите число для использования идентификатора кадра или строку для имени кадра. | |
outFrame | строка | число | <необязательно> | Это кадр или имя кадра, которое будет установлено, когда эта кнопка находится в состоянии обычного отображения. | |
downFrame | строка | число | <необязательно> | Это кадр или имя кадра, которое будет установлено, когда эта кнопка находится в нажатом состоянии. | |
upFrame | строка | число | <необязательно> | Это кадр или имя кадра, которое будет установлено, когда эта кнопка находится в обычном состоянии. | |
group | Phaser.Group | <необязательно> | Необязательная группа, в которую нужно добавить объект. Если не указано, объект будет добавлен в группу World. |
Возвращает
Созданный объект Button.
creature(x, y, key, group) → {Phaser.Creature}
Создаёт новый объект анимации Creature.
Creature — это пользовательский объект игры, используемый совместно с библиотеками Creature Runtime от Kestrel Moon Studios.
Он позволяет отображать анимированные объекты игры, созданные с помощью Creature Automated Animation Tool.
Примечание 1: Вы можете использовать объекты Phaser.Creature только в играх с поддержкой WebGL. Они не работают в играх с поддержкой Canvas.
Примечание 2: Вам необходимо использовать сборку Phaser, которая включает CreatureMeshBone.js runtime и gl-matrix.js, или загрузить их
перед запуском игры Phaser.
Дополнительную информацию см. в процессе создания пользовательской сборки Phaser.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
x | число | <необязательно> | 0 | Координата x существа. Координата относительна любому контейнеру-родителю, в котором может находиться это существо. |
y | число | <необязательно> | 0 | Координата y существа. Координата относительна любому контейнеру-родителю, в котором может находиться это существо. |
key | строка | PIXI.Texture | <необязательно> | Изображение, используемое в качестве текстуры этим объектом существа при отрисовке. Если строка, Phaser получит значение из кэша изображений. Или это может быть экземпляр PIXI.Texture. | |
group | Phaser.Group | <необязательно> | Необязательная группа, в которую нужно добавить объект. Если не указано, объект будет добавлен в группу World. |
Возвращает
Созданный объект Sprite.
emitter(x, y, maxParticles) → {Phaser.Particles.Arcade.Emitter}
Создаёт новый объект Emitter.
Эмиттер частиц может использоваться для однократных взрывов или для
постоянных эффектов, таких как дождь и огонь. Всё, что он делает, — это запускает объекты частиц с заданными интервалами и устанавливает их положение и скорость соответственно.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
x | число | <необязательно> | 0 | Координата x в эмиттере, от которой испускаются частицы. |
y | число | <необязательно> | 0 | Координата y в эмиттере, от которой испускаются частицы. |
maxParticles | число | <необязательно> | 50 | Общее количество частиц в этом эмиттере. |
Возвращает
Созданный объект эмиттера.
existing(object) → {any}
Добавляет существующий объект отображения в игровой мир.
Параметры
| Имя | Тип | Описание |
|---|---|---|
object | any | Экземпляр Phaser.Sprite, Phaser.Button или любого другого объекта отображения. |
Возвращает
Добавленный в мир объект.
filter(filter) → {Phaser.Filter}
WebGL шейдер/фильтр, который можно применить к Sprite.
Параметры
- Исходный код: gameobjects/GameObjectFactory.js (Строка 554)
- Исходный код: gameobjects/GameObjectFactory.js (Строка 361)
- Исходный код: gameobjects/GameObjectFactory.js (Строка 173)
- Исходный код: gameobjects/GameObjectFactory.js (Строка 78)
| Имя | Тип | Описание |
|---|---|---|
filter | string | Имя фильтра, который вы хотите создать, например HueRotate или SineWave. |
| any | Любые параметры, которые необходимо передать функции инициализации фильтра. |
Возвращаемое значение
Новый созданный объект Phaser.Filter.
graphics(x, y, group) → {Phaser.Graphics}
Создает новый объект Graphics.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
x | number | <optional> | 0 | Координата x объекта Graphic. Координата относительна любому контейнеру-родителю, в котором может находиться этот объект. |
y | number | <optional> | 0 | Координата y объекта Graphic. Координата относительна любому контейнеру-родителю, в котором может находиться этот объект. |
group | Phaser.Group | <optional> | Необязательная группа, к которой добавить объект. Если не указано, объект будет добавлен к группе World. |
Возвращаемое значение
Новый созданный объект graphics.
group(parent, name, addToStage, enableBody, physicsBodyType) → {Phaser.Group}
Группа — это контейнер для элементов отображения, позволяющий быстро создавать пулы, переиспользовать и проверять столкновения.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
parent | any | <optional> | Родительская группа или DisplayObjectContainer, которая будет содержать эту группу, если таковая имеется. Если установлено в null, группа не будет добавлена в список отображения. Если не определено, по умолчанию она будет добавлена в World. | |
name | string | <optional> | 'group' | Имя этой группы. Не используется во внутренней работе, но полезно для отладки. |
addToStage | boolean | <optional> | false | Если установлено в true, эта группа будет добавлена непосредственно на Game.Stage вместо Game.World. |
enableBody | boolean | <optional> | false | Если true, все созданные с помощью |
physicsBodyType | number | <optional> | 0 | Если enableBody установлено в true, это тип физического объекта, который создается для новых спрайтов. Phaser.Physics.ARCADE, Phaser.Physics.P2, Phaser.Physics.NINJA и т.д. |
Возвращаемое значение
Новая созданная группа.
image(x, y, key, frame, group) → {Phaser.Image}
Создает новый объект Image.
Изображение — это легкий объект, который можно использовать для отображения всего, что не требует физики или анимации.
Он по-прежнему может вращаться, масштабироваться, обрезаться и получать события ввода.
Это идеально подходит для логотипов, фонов, простых кнопок и другой графики без спрайтов.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
x | number | <optional> | 0 | Координата x изображения. Координата относительна любому контейнеру-родителю, в котором может находиться это изображение. |
y | number | <optional> | 0 | Координата y изображения. Координата относительна любому контейнеру-родителю, в котором может находиться это изображение. |
key | string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture | <optional> | Изображение, используемое в качестве текстуры этим объектом отображения во время отрисовки. Если строка, Phaser получит запись в кэше изображений. Или это может быть экземпляр RenderTexture, BitmapData, Video или PIXI.Texture. | |
frame | string | number | <optional> | Если используется атлас текстур или спрайт-лист, это позволяет указать используемую рамку. Используйте целое число для идентификатора кадра или строку для имени кадра. | |
group | Phaser.Group | <optional> | Необязательная группа, к которой добавить объект. Если не указано, объект будет добавлен к группе World. |
Возвращаемое значение
Новый созданный объект Image.
physicsGroup(physicsBodyType, parent, name, addToStage) → {Phaser.Group}
Группа — это контейнер для элементов отображения, позволяющий быстро создавать пулы, переиспользовать и проверять столкновения.
Физическая группа — это та же, что и обычная группа, за исключением того, что в ней по умолчанию включен enableBody, поэтому все созданные ею спрайты автоматически получают физический объект.
Параметры
- Исходный код: gameobjects/GameObjectFactory.js (Строка 190)
- Исходный код: gameobjects/GameObjectFactory.js (Строка 574)
- Исходный код: gameobjects/GameObjectFactory.js (Строка 484)
- Исходный код: gameobjects/GameObjectFactory.js (Строка 397)
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
physicsBodyType | number | <optional> | Phaser.Physics.ARCADE | Если enableBody равно true, это тип физического тела, который создаётся для новых спрайтов. Phaser.Physics.ARCADE, Phaser.Physics.P2JS, Phaser.Physics.NINJA и т.д. |
parent | any | <optional> | Родительская группа или контейнер DisplayObjectContainer, который будет содержать эту группу, если таковой имеется. Если установлено в null, группа не будет добавлена в список отображения. Если undefined, она будет добавлена в World по умолчанию. | |
name | string | <optional> | 'group' | Имя этой группы. Не используется внутри, но полезно для отладки. |
addToStage | boolean | <optional> | false | Если установлено в true, эта группа будет добавлена напрямую в Game.Stage вместо Game.World. |
Возвращаемое значение
Новенее созданная группа.
plugin(plugin, parameter) → {Phaser.Plugin}
Добавляет новый плагин в PluginManager.
Плагин должен иметь 2 свойства: game и parent. Plugin.game устанавливается в ссылку на игру, используемую PluginManager, а parent устанавливается в PluginManager.
Параметры
| Имя | Тип | Аргумент | Описание |
|---|---|---|---|
plugin | object | Phaser.Plugin | Плагин, который нужно добавить в PluginManager. Это может быть функция или существующий объект. | |
parameter | * | <repeatable> | Дополнительные параметры, которые будут переданы в метод Plugin.init. |
Возвращаемое значение
Плагин, который был добавлен в менеджер.
renderTexture(width, height, key, addToCache) → {Phaser.RenderTexture}
Динамическая, изначально пустая холщовая область, на которую можно рисовать изображения.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
width | number | <optional> | 100 | ширина RenderTexture. |
height | number | <optional> | 100 | высота RenderTexture. |
key | string | <optional> | '' | Ключ ресурса для RenderTexture при хранении в кэше (см. параметр addToCache). |
addToCache | boolean | <optional> | false | Нужно ли добавить эту RenderTexture в Game.Cache? Если да, вы можете получить её с помощью Cache.getTexture(key) |
Возвращаемое значение
Новый созданный объект RenderTexture.
retroFont(font, characterWidth, characterHeight, chars, charsPerRow, xSpacing, ySpacing, xOffset, yOffset) → {Phaser.RetroFont}
Создаёт новый объект RetroFont.
RetroFont может использоваться как текстура для Image или Sprite и, по желанию, добавляться в кэш.
RetroFont использует растровое изображение с фиксированной шириной символов для набора шрифтов. Вы используете интервалы символов для определения набора.
Если вам нужна поддержка символов с переменной шириной, используйте объект BitmapText вместо этого. Основное отличие между RetroFont и BitmapText
состоит в том, что RetroFont создаёт одну текстуру, которую вы можете применить к объекту игры, а BitmapText создаёт один объект Sprite на каждую букву текста.
Текстура может быть назначена одному или нескольким изображениям/спрайтам, но обратите внимание, что используемый текст RetroFont будет общим для всех них,
т.е. если вам нужно, чтобы у каждого изображения был разный текст, то вам необходимо создать несколько объектов RetroFont.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
font | string | Ключ изображения в Game.Cache, который будет использовать RetroFont. | ||
characterWidth | number | Ширина каждого символа в наборе шрифтов. | ||
characterHeight | number | Высота каждого символа в наборе шрифтов. | ||
chars | string | Символы, используемые в наборе шрифтов, в порядке отображения. Вы можете использовать константы TEXT_SET для распространённых расположений наборов шрифтов. | ||
charsPerRow | number | Количество символов на строке в наборе шрифтов. | ||
xSpacing | number | <optional> | 0 | Если символы в наборе шрифтов имеют горизонтальные интервалы между собой, укажите требуемое количество здесь. |
ySpacing | number | <optional> | 0 | Если символы в наборе шрифтов имеют вертикальные интервалы между собой, укажите требуемое количество здесь. |
xOffset | number | <optional> | 0 | Если набор шрифтов не начинается с левого верхнего угла заданного изображения, укажите смещение координаты X здесь. |
yOffset | number | <optional> | 0 | Если набор шрифтов не начинается с левого верхнего угла заданного изображения, укажите смещение координаты Y здесь. |
Возвращаемое значение
Новенее созданная текстура RetroFont, которую можно применить к Image или Sprite.
rope(x, y, key, frame, points, group) → {Phaser.Rope}
Создаёт новый объект Rope.
Пример использования: https://github.com/codevinsky/phaser-rope-demo/blob/master/dist/demo.js
- Исходный код: gameobjects/GameObjectFactory.js (Строка 296)
- Исходный код: gameobjects/GameObjectFactory.js (Строка 246)
- Исходный код: gameobjects/GameObjectFactory.js (Строка 102)
- Исходный код: gameobjects/GameObjectFactory.js (Строка 209)
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
x | число | <необязательно> | 0 | Координата x верёвки. Координата относительна любому контейнеру, в котором может находиться эта верёвка. |
y | число | <необязательно> | 0 | Координата y верёвки. Координата относительна любому контейнеру, в котором может находиться эта верёвка. |
key | строка | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture | <необязательно> | Изображение, используемое в качестве текстуры этим объектом отображения во время отрисовки. Если строка, Phaser получит значение из кэша изображений. Или это может быть экземпляр RenderTexture, BitmapData, Video или PIXI.Texture. | |
frame | строка | число | <необязательно> | Если используется атлас текстур или спрайт-лист, это позволяет указать используемый кадр. Используйте целое число для идентификатора кадра или строку для имени кадра. | |
points | Массив | Массив {Phaser.Point}. | ||
group | Phaser.Group | <необязательно> | Необязательная группа, к которой нужно добавить объект. Если не указано, он будет добавлен в группу World. |
Возвращает
Созданный объект Rope.
sound(key, volume, loop, connect) → {Phaser.Sound}
Создает новый объект звука.
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
key | строка | Ключ Game.cache для звука, который будет использовать этот объект. | ||
volume | число | <необязательно> | 1 | Громкость, с которой будет воспроизводиться звук. |
loop | логическое | <необязательно> | false | Циклическое воспроизведение звука. |
connect | логическое | <необязательно> | true | Управляет подключением созданного объекта Sound к узлу усиления master gainNode SoundManager при работе под WebAudio. |
Возвращает
Новый объект звука.
sprite(x, y, key, frame, group) → {Phaser.Sprite}
Создает новый Sprite с определенной позицией и ключом спрайт-листа.
В самом простом виде Sprite состоит из набора координат и текстуры, используемой при отрисовке.
Они также содержат дополнительные свойства, позволяющие управлять физическим движением (через Sprite.body), обработкой ввода (через Sprite.input),
событиями (через Sprite.events), анимацией (через Sprite.animations), обрезкой камеры и многое другое. Примеры использования см. в примерах.
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
x | число | <необязательно> | 0 | Координата x спрайта. Координата относительна любому контейнеру, в котором может находиться этот спрайт. |
y | число | <необязательно> | 0 | Координата y спрайта. Координата относительна любому контейнеру, в котором может находиться этот спрайт. |
key | строка | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture | <необязательно> | Изображение, используемое в качестве текстуры этим объектом отображения во время отрисовки. Если строка, Phaser получит значение из кэша изображений. Или это может быть экземпляр RenderTexture, BitmapData, Video или PIXI.Texture. | |
frame | строка | число | <необязательно> | Если используется атлас текстур или спрайт-лист, это позволяет указать используемый кадр. Используйте целое число для идентификатора кадра или строку для имени кадра. | |
group | Phaser.Group | <необязательно> | Необязательная группа, к которой нужно добавить объект. Если не указано, он будет добавлен в группу World. |
Возвращает
Созданный объект Sprite.
spriteBatch(parent, name, addToStage) → {Phaser.SpriteBatch}
SpriteBatch — это очень быстрая версия Phaser Group, созданная исключительно для скорости.
Используйте, когда вам нужно много спрайтов или частиц, все с одной и той же текстурой.
Увеличение скорости специфично для WebGL. В режиме Canvas вы не увидите реальной разницы.
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
parent | Phaser.Group | null | Родительская группа, которая будет содержать этот Sprite Batch. Установите в | ||
name | строка | <необязательно> | 'group' | Имя этого Sprite Batch. Не используется во внутренней работе, но полезно для отладки. |
addToStage | логическое | <необязательно> | false | Если установлено в true, этот Sprite Batch будет добавлен непосредственно в Game.Stage вместо родителя. |
Возвращает
Созданный Sprite Batch.
- Исходный код: gameobjects/GameObjectFactory.js (Строка 318)
- Исходный код: gameobjects/GameObjectFactory.js (Строка 461)
- Исходный код: gameobjects/GameObjectFactory.js (Строка 275)
- Исходный код: gameobjects/GameObjectFactory.js (Строка 158)
text(x, y, text, style, group) → {Phaser.Text}
Создаёт новый объект Text.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
x | number | <optional> | 0 | Координата x объекта Text. Координата относительна к любому родительскому контейнеру, в котором может находиться этот текст. |
y | number | <optional> | 0 | Координата y объекта Text. Координата относительна к любому родительскому контейнеру, в котором может находиться этот текст. |
text | string | <optional> | '' | Строка текста, которая будет отображаться. |
style | object | <optional> | Объект стиля, содержащий атрибуты стиля, такие как шрифт, размер шрифта и т. д. | |
group | Phaser.Group | <optional> | Необязательная группа для добавления объекта. Если не указано, объект будет добавлен в группу World. |
Возвращаемое значение
Созданный объект текста.
tilemap(key, tileWidth, tileHeight, width, height) → {Phaser.Tilemap}
Создаёт новый объект Phaser.Tilemap.
Карта может быть заполнена данными из файла Tiled JSON или CSV.
Для этого передайте ключ кеша в качестве первого параметра. При использовании данных Tiled вам нужно указать только ключ.
При использовании данных CSV вы должны указать ключ и параметры tileWidth и tileHeight.
Если вы создаёте пустую карту для последующего заполнения, вы можете не указывать никаких параметров или передать Tilemap.create, либо передать размеры карты и плиток здесь.
Обратите внимание, что все Tilemap используют базовый размер плитки для расчёта размеров, но TilemapLayer может иметь свой уникальный размер плитки, который переопределяет его.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
key | string | <optional> | Ключ данных tilemap, хранящихся в кэше. Если вы создаёте пустую карту, либо оставьте этот параметр, либо передайте | |
tileWidth | number | <optional> | 32 | Ширина в пикселях одной плитки карты. Если используются данные CSV, вы должны указать это. Не требуется при использовании данных карты Tiled. |
tileHeight | number | <optional> | 32 | Высота в пикселях одной плитки карты. Если используются данные CSV, вы должны указать это. Не требуется при использовании данных карты Tiled. |
width | number | <optional> | 10 | Ширина карты в плитках. Если эта карта создана из данных Tiled или CSV, вам не нужно это указывать. |
height | number | <optional> | 10 | Высота карты в плитках. Если эта карта создана из данных Tiled или CSV, вам не нужно это указывать. |
Возвращаемое значение
Созданный объект tilemap.
tileSprite(x, y, width, height, key, frame, group) → {Phaser.TileSprite}
Создаёт новый объект TileSprite.
Параметры
| Имя | Тип | Аргумент | Описание |
|---|---|---|---|
x | number | Координата x TileSprite. Координата относительна к любому родительскому контейнеру, в котором может находиться этот TileSprite. | |
y | number | Координата y TileSprite. Координата относительна к любому родительскому контейнеру, в котором может находиться этот TileSprite. | |
width | number | Ширина TileSprite. | |
height | number | Высота TileSprite. | |
key | string | Phaser.BitmapData | PIXI.Texture | Изображение или текстура, используемая TileSprite при отрисовке. Может быть строкой, являющейся ссылкой на запись в кэше Phaser Image, или экземпляром PIXI.Texture или BitmapData. | |
frame | string | number | <optional> | Если используется Texture Atlas или Sprite Sheet, это позволяет указать используемую кадр. Используйте целое число для ID кадра или строку для имени кадра. |
group | Phaser.Group | <optional> | Необязательная группа для добавления объекта. Если не указано, объект будет добавлен в группу World. |
Возвращаемое значение
Созданный объект TileSprite.
tween(object) → {Phaser.Tween}
Создаёт анимацию (tween) для определённого объекта.
Объект может быть любым JavaScript-объектом или объектом Phaser, например, Sprite.
Параметры
| Имя | Тип | Описание |
|---|---|---|
object | object | Объект, для которого будет выполнена анимация. |
Возвращаемое значение
Созданный объект Phaser.Tween.
video(key, url) → {Phaser.Video}
Создаёт объект Video.
Это вернёт объект Phaser.Video, который можно передать в Sprite для использования в качестве текстуры.
Параметры
- Исходный код: gameobjects/GameObjectFactory.js (Строка 510)
- Исходный код: gameobjects/GameObjectFactory.js (Строка 48)
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
key | строка | null | <необязательно> | null | Ключ видеофайла в кэше Phaser.Cache, который будет воспроизводиться этим объектом Video. Установите в значение |
url | строка | null | <необязательно> | null | Если видео еще не загружено, вы можете указать здесь полный URL-адрес файла (убедитесь, что ключ установлен в значение null). |
Возвращаемое значение
Новый созданный объект Video.
weapon(количество, ключ, кадр, группа) → {Phaser.Weapon}
Оружие предоставляет возможность легко создавать пул и менеджер пуль.
Оружие стреляет объектами Phaser.Bullet, которые по существу являются Sprites с несколькими дополнительными свойствами.
Пули активированы для физики Arcade. В настоящее время они не работают с физикой P2.
Пули создаются внутри Weapon.bullets, который представляет собой экземпляр Phaser.Group. Всё, что вы
обычно можете делать с группой, например, перемещать её по списку отображения, итерировать её и т.д., может быть сделано
и для группы пуль.
Пули могут иметь текстуры и даже анимации. Вы можете контролировать скорость их стрельбы,
частоту стрельбы, угол стрельбы и даже установить для них такие параметры, как гравитация.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
quantity | целое число | <необязательно> | 1 | Количество пуль для заполнения оружия. Если -1, пул будет автоматически расширяться. |
key | строка | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture | <необязательно> | Изображение, используемое в качестве текстуры пуль при отрисовке. Если строка, Phaser получит значение из кэша изображений. Либо это может быть экземпляр RenderTexture, BitmapData, Video или PIXI.Texture. | |
frame | строка | число | <необязательно> | Если используется атлас текстур или спрайт-лист, это позволяет указать кадр, который будет использоваться пулями. Используйте целое число для идентификатора кадра или строку для имени кадра. | |
group | Phaser.Group | <необязательно> | Необязательная группа, к которой нужно добавить оружие. Если не указано, оно будет добавлено к группе World. |
Возвращаемое значение
Экземпляр Weapon.
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.GameObjectFactory.html