Класс: Phaser.Game
Конструктор
new Game(width, height, renderer, parent, state, transparent, antialias, physicsConfig)
Здесь происходит магия. Объект Game является сердцем вашей игры,
предоставляя быстрый доступ к общим функциям и обрабатывая процесс загрузки.
«Черт, здесь нет правил - мы пытаемся чего-то добиться».
Томас Эдисон
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
width | число | строка | <необязательно> | 800 | Ширина вашей игры в пикселях игры. Если задано как строка, значение должно быть между 0 и 100 и будет использоваться как процентная ширина родительского контейнера или окна браузера, если родительский контейнер не задан. |
height | число | строка | <необязательно> | 600 | Высота вашей игры в пикселях игры. Если задано как строка, значение должно быть между 0 и 100 и будет использоваться как процентная высота родительского контейнера или окна браузера, если родительский контейнер не задан. |
renderer | число | <необязательно> | Phaser.AUTO | Какой рендер использовать: Phaser.AUTO автоматически определит, Phaser.WEBGL, Phaser.CANVAS или Phaser.HEADLESS (нет рендеринга вообще). |
parent | строка | HTMLElement | <необязательно> | '' | Элемент DOM, в который будет внедрен холст этой игры. Либо идентификатор DOM-элемента (строка), либо сам элемент. |
state | объект | <необязательно> | null | Объект состояния по умолчанию. Объект, состоящий из функций Phaser.State (preload, create, update, render) или null. |
transparent | логическое | <необязательно> | false | Использовать прозрачный фон холста или нет. |
antialias | логическое | <необязательно> | true | Отображать все текстуры изображений с антиалиасингом или нет. По умолчанию используется плавное изображение, но отключите, если в игре используется пиксельное искусство. |
physicsConfig | объект | <необязательно> | null | Объект конфигурации физики, передаваемый в физический мир при создании. |
- Исходный код: core/Game.js (Строка 25)
Общедоступные свойства
- Исходный код: core/Game.js (Строка 156)
- Значение по умолчанию
- true
- Исходный код: core/Game.js (Строка 102)
- Исходный код: core/Game.js (Строка 166)
- Исходный код: core/Game.js (Строка 241)
- Исходный код: core/Game.js (Строка 246)
- Значение по умолчанию
- true
- Исходный код: core/Game.js (Строка 116)
- Исходный код: core/Game.js (Строка 36)
- Исходный код: core/Game.js (Строка 251)
- Исходный код: core/Game.js (Строка 266)
- Внутреннее:
- Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
- Исходный код: core/Game.js (Строка 336)
- Исходный код: core/Game.js (Строка 256)
- Исходный код: core/Game.js (Строка 236)
- Исходный код: core/Game.js (Строка 380)
- Исходный код: core/Game.js (Строка 375)
- Значение по умолчанию
- 600
- Исходный код: core/Game.js (Строка 69)
- Исходный код: core/Game.js (Строка 31)
- Исходный код: core/Game.js (Строка 171)
- Исходный код: core/Game.js (Строка 139)
- Исходный код: core/Game.js (Строка 145)
- Исходный код: core/Game.js (Строка 176)
- Исходный код: core/Game.js (Строка 275)
add : Phaser.GameObjectFactory
Ссылка на Phaser.GameObjectFactory.
antialias : boolean
Активировать сглаживание графики. По умолчанию масштабированные изображения сглаживаются в Canvas и WebGL. Установите anti-alias в false, чтобы отключить это глобально.
cache : Phaser.Cache
Ссылка на кэш ресурсов.
camera : Phaser.Camera
Удобная ссылка на world.camera.
canvas :HTMLCanvasElement
Удобная ссылка на renderer.view, холст, на котором отрисовывается игра.
clearBeforeRender : boolean
Очищать холст Canvas перед отрисовкой списка отображения в каждом кадре.
Вы можете установить это значение в false для повышения производительности, если в вашей игре всегда есть фон, полностью заполняющий отображение.
config : Object
Объект конфигурации Phaser.Game.
context :CanvasRenderingContext2D
Удобная ссылка на renderer.context (только для игр CANVAS, а не WebGL)
create : Phaser.Create
Генератор ресурсов.
<internal> currentUpdateID : integer
ID текущего/последнего логического обновления, примененного в этом кадре рендеринга, начиная с 0.
Первое обновление currentUpdateID === 0 и последнее currentUpdateID === updatesThisFrame.
debug : Phaser.Utils.Debug
Набор полезных инструментов отладки.
device : Phaser.Device
Содержит информацию об устройстве и его возможности.
forceSingleUpdate : boolean
Должен ли цикл игры принудительно выполнить логическое обновление, независимо от таймера задержки? Установите в true, если вы знаете, что это необходимо. Вы можете переключать его в динамическом режиме.
fpsProblemNotifier : Phaser.Signal
Если игра испытывает трудности с поддержанием желаемой частоты кадров в секунду, это событие будет отправлено.
Желаемая/выбранная частота кадров в секунду, вероятно, должна быть ближе к значению Phaser.Time#suggestedFps.
[readonly] height : integer
Текущая высота игры в пикселях.
Не изменяйте этот параметр напрямую: используйте Phaser.ScaleManager#setGameSize - например, game.scale.setGameSize(width, height) - вместо него.
[readonly] id : number
Идентификатор игры Phaser (для случаев, когда Pixi поддерживает несколько экземпляров).
input : Phaser.Input
Ссылка на менеджер ввода.
[readonly] isBooted : boolean
Загружен ли движок игры, т.е. доступен ли?
[readonly] isRunning : boolean
Игра запущена или приостановлена?
load : Phaser.Loader
Ссылка на загрузчик ресурсов.
lockRender : boolean
Если false Phaser будет автоматически рендерить список отображения в каждом обновлении. Если true цикл рендеринга будет пропущен.
Вы можете изменить это значение во время выполнения для точного управления тем, когда Phaser рендерит. Это может быть полезно в определенных типах игр или приложений.
Обратите внимание, что если вы не рендерите список отображения, то никакие преобразования объектов игры не будут обновлены, поэтому используйте это значение осторожно.
make : Phaser.GameObjectCreator
Ссылка на создатель GameObject.
- Исходный код: core/Game.js (Строка 161)
- Исходный код: core/Game.js (Строка 181)
- Исходный код: core/Game.js (Строка 186)
- Исходный код: core/Game.js (Строка 311)
- Исходный код: core/Game.js (Строка 316)
- Исходный код: core/Game.js (Строка 301)
- Исходный код: core/Game.js (Строка 306)
- строка | HTMLElement
- Исходный код: core/Game.js (Строка 47)
- Исходный код: core/Game.js (Строка 261)
- Исходный код: core/Game.js (Строка 1154)
- Исходный код: core/Game.js (Строка 289)
- Исходный код: core/Game.js (Строка 221)
- Исходный код: core/Game.js (Строка 41)
- Исходный код: core/Game.js (Строка 226)
- Исходный код: core/Game.js (Строка 108)
- Внутреннее:
- Этот член является внутренним (защищенным) и может быть изменён или удалён в будущем.
- Исходный код: core/Game.js (Строка 151)
- Внутреннее:
- Этот член является внутренним (защищенным) и может быть изменён или удалён в будущем.
- Исходный код: core/Game.js (Строка 122)
- Исходный код: core/Game.js (Строка 128)
- Значение по умолчанию
- 1
- Исходный код: core/Game.js (Строка 78)
- Исходный код: core/Game.js (Строка 231)
- Исходный код: core/Game.js (Строка 191)
- Исходный код: core/Game.js (Строка 196)
math : Phaser.Math
Ссылка на математический помощник.
net : Phaser.Net
Ссылка на сетевой класс.
onBlur : Phaser.Signal
Это событие срабатывает, когда игра теряет фокус (обычно при скрытии страницы).
onFocus : Phaser.Signal
Это событие срабатывает, когда игра получает фокус (обычно при показе страницы).
onPause : Phaser.Signal
Это событие срабатывает, когда игра приостанавливается.
onResume : Phaser.Signal
Это событие срабатывает, когда игра возобновляется после приостановки.
parent : строка | HTMLElement
Родительский элемент игры в DOM.
Тип
particles : Phaser.Particles
Менеджер частиц.
paused : boolean
Состояние приостановки игры. Приостановленная игра не обновляет свои подсистемы.
При приостановке игры отправляется событие onPause. При возобновлении отправляется событие onResume. Возвращает и устанавливает состояние приостановки игры.
[только для чтения] pendingStep : boolean
Внутреннее свойство, используемое enableStep, но также полезно для запросов от ваших собственных объектов игры.
physics : Phaser.Physics
Ссылка на менеджер физики.
physicsConfig : Объект
Объект конфигурации Phaser.Physics.World.
plugins : Phaser.PluginManager
Ссылка на менеджер плагинов.
preserveDrawingBuffer : boolean
Значение флага preserveDrawingBuffer влияет на то, сохраняются ли содержимое буфера трассировки после отрисовки.
<внутреннее> raf : Phaser.RequestAnimationFrame
Автоматически обрабатывает основной цикл игры с помощью requestAnimationFrame или setTimeout
<внутреннее> renderer : PIXI.CanvasRenderer | PIXI.WebGLRenderer
Отрисовщик Pixi.
Тип
[только для чтения] renderType : число
Отрисовщик, который будет использовать эта игра. Либо Phaser.AUTO, Phaser.CANVAS, Phaser.WEBGL, или Phaser.HEADLESS.
[только для чтения] resolution : целое число
Разрешение вашей игры. Это значение является только для чтения, но его можно изменить во время запуска через объект конфигурации игры.
rnd : Phaser.RandomDataGenerator
Экземпляр генератора повторяемых случайных данных.
scale : Phaser.ScaleManager
Менеджер масштабирования игры.
sound : Phaser.SoundManager
Ссылка на менеджер звука.
stage : Phaser.Stage
Ссылка на сцену.
- Source code: core/Game.js (Line 201)
- Source code: core/Game.js (Line 133)
- Source code: core/Game.js (Line 296)
- Source code: core/Game.js (Line 282)
- Source code: core/Game.js (Line 206)
- Source code: core/Game.js (Line 96)
- Source code: core/Game.js (Line 211)
- Внутреннее:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Source code: core/Game.js (Line 343)
- Значение по умолчанию
- 800
- Source code: core/Game.js (Line 58)
- Source code: core/Game.js (Line 216)
state : Phaser.StateManager
Менеджер состояний.
[только для чтения] stepCount : число
При включённом шаговом режиме содержит текущий цикл шага.
[только для чтения] stepping : boolean
Включить шаговый режим цикла ядра с помощью Game.enableStep().
time : Phaser.Time
Ссылка на игровые часы.
transparent : boolean
Использовать прозрачный фон холста или нет.
tweens : Phaser.TweenManager
Ссылка на менеджер анимации.
<внутреннее> updatesThisFrame : целое число
Количество ожидаемых логических обновлений в этом кадре рендеринга; будет равно 1, если не требуется/разрешено выполнение catch-up.
[только для чтения] width : целое число
Текущая ширина игры в пикселях.
Не изменяйте этот параметр напрямую: используйте Phaser.ScaleManager#setGameSize - например. game.scale.setGameSize(width, height).
world : Phaser.World
Ссылка на мир.
Публичные методы
- Внутренний:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/Game.js (Строка 520)
- Исходный код: core/Game.js (Строка 1001)
- Исходный код: core/Game.js (Строка 976)
- Исходный код: core/Game.js (Строка 962)
- Внутренний:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/Game.js (Строка 1132)
- Внутренний:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/Game.js (Строка 1114)
- Внутренний:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/Game.js (Строка 1048)
- Внутренний:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/Game.js (Строка 1080)
- Внутренний:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/Game.js (Строка 440)
- Внутренний:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/Game.js (Строка 676)
- Внутренний:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/Game.js (Строка 609)
- Исходный код: core/Game.js (Строка 988)
- Внутренний:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/Game.js (Строка 777)
- Внутренний:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/Game.js (Строка 877)
<internal> boot()
Инициализирует подмодули движка и запускает игру.
destroy()
Уничтожает всю игру.
Вызывает destroy у Game.state, Game.sound, Game.scale, Game.stage, Game.input, Game.physics и Game.plugins.
Затем устанавливает все эти локальные обработчики в null, уничтожает рендерер, удаляет холст из DOM
и сбрасывает значения по умолчанию для рендерера PIXI.
disableStep()
Отключает шаги основного цикла игры.
enableStep()
Включает шаги основного цикла игры. При включении нужно вызывать game.step() напрямую (возможно, через кнопку DOM?)
Вызов step продвинет цикл игры на один кадр. Это чрезвычайно полезно для отладки трудноуловимых ошибок!
<internal> focusGain(event)
Вызывается обработчиком видимости стадии.
Параметры
| Имя | Тип | Описание |
|---|---|---|
event | объект | Событие DOM, которое привело к паузе игры, если таковое имеется. |
<internal> focusLoss(event)
Вызывается обработчиком видимости стадии.
Параметры
| Имя | Тип | Описание |
|---|---|---|
event | объект | Событие DOM, которое привело к паузе игры, если таковое имеется. |
<internal> gamePaused(event)
Вызывается обработчиком видимости стадии.
Параметры
| Имя | Тип | Описание |
|---|---|---|
event | объект | Событие DOM, которое привело к паузе игры, если таковое имеется. |
<internal> gameResumed(event)
Вызывается обработчиком видимости стадии.
Параметры
| Имя | Тип | Описание |
|---|---|---|
event | объект | Событие DOM, которое привело к паузе игры, если таковое имеется. |
<internal> parseConfig()
Парсит объект конфигурации игры.
<internal> setUpRenderer()
Проверяет, может ли устройство использовать запрошенный рендерер, и настраивает его или альтернативный, если нет.
<internal> showDebugHeader()
Отображает заголовок отладки версии Phaser в консоли.
step()
При включённом режиме шагов вы должны вызвать эту функцию напрямую (возможно, через кнопку DOM?), чтобы продвинуть цикл игры на один кадр.
Это чрезвычайно полезно для отладки трудноуловимых ошибок! Используйте внутреннее свойство stepCount для отслеживания прогресса.
<internal> update(time)
Основной цикл игры.
Параметры
| Имя | Тип | Описание |
|---|---|---|
time | число | Текущее время, предоставленное RequestAnimationFrame. |
<internal> updateLogic(timeStep)
Обновляет все логические подсистемы в Phaser. Вызывается автоматически функцией Game.update.
Параметры
| Имя | Тип | Описание |
|---|---|---|
timeStep | число | Значение текущего timeStep, определённое функцией Game.update. |
<internal> updateRender(elapsedTime)
- Внутренний:
- Этот член является внутренним (защищенным) и может быть изменён или удалён в будущем.
- Исходный код: core/Game.js (Строка 925)
Выполняет цикл рендеринга.
Он начинается с вызова State.preRender. Здесь вы можете произвести любые необходимые последние корректировки отображаемых объектов.
Затем вызывается рендерер, который отрисовывает весь список отображения, начиная с объекта Stage и двигаясь вниз.
Затем вызывается plugin.render для всех загруженных плагинов в порядке их включения.
После этого вызывается State.render. Любой рендеринг, выполняемый здесь, будет происходить поверх списка отображения.
Наконец, вызывается plugin.postRender для всех загруженных плагинов в порядке их включения.
Этот метод вызывается автоматически методом Game.update, вызывать его напрямую не нужно.
Если вам требуется точный контроль над временем рендеринга Phaser, используйте boolean Game.lockRender.
Phaser будет выполнять рендеринг только тогда, когда этот boolean равен false.
Параметры
| Имя | Тип | Описание |
|---|---|---|
elapsedTime | число | Время, прошедшее с момента последнего обновления. |
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.Game.html