Spec-Zone.ru › Phaser

Класс: 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)

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

add : Phaser.GameObjectFactory

Ссылка на Phaser.GameObjectFactory.

Исходный код: core/Game.js (Строка 156)

antialias : boolean

Активировать сглаживание графики. По умолчанию масштабированные изображения сглаживаются в Canvas и WebGL. Установите anti-alias в false, чтобы отключить это глобально.

Значение по умолчанию
  • true
Исходный код: core/Game.js (Строка 102)

cache : Phaser.Cache

Ссылка на кэш ресурсов.

Исходный код: core/Game.js (Строка 166)

camera : Phaser.Camera

Удобная ссылка на world.camera.

Исходный код: core/Game.js (Строка 241)

canvas :HTMLCanvasElement

Удобная ссылка на renderer.view, холст, на котором отрисовывается игра.

Исходный код: core/Game.js (Строка 246)

clearBeforeRender : boolean

Очищать холст Canvas перед отрисовкой списка отображения в каждом кадре.
Вы можете установить это значение в false для повышения производительности, если в вашей игре всегда есть фон, полностью заполняющий отображение.

Значение по умолчанию
  • true
Исходный код: core/Game.js (Строка 116)

config : Object

Объект конфигурации Phaser.Game.

Исходный код: core/Game.js (Строка 36)

context :CanvasRenderingContext2D

Удобная ссылка на renderer.context (только для игр CANVAS, а не WebGL)

Исходный код: core/Game.js (Строка 251)

create : Phaser.Create

Генератор ресурсов.

Исходный код: core/Game.js (Строка 266)

<internal> currentUpdateID : integer

ID текущего/последнего логического обновления, примененного в этом кадре рендеринга, начиная с 0.
Первое обновление currentUpdateID === 0 и последнее currentUpdateID === updatesThisFrame.

Внутреннее:
  • Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
Исходный код: core/Game.js (Строка 336)

debug : Phaser.Utils.Debug

Набор полезных инструментов отладки.

Исходный код: core/Game.js (Строка 256)

device : Phaser.Device

Содержит информацию об устройстве и его возможности.

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

forceSingleUpdate : boolean

Должен ли цикл игры принудительно выполнить логическое обновление, независимо от таймера задержки? Установите в true, если вы знаете, что это необходимо. Вы можете переключать его в динамическом режиме.

Исходный код: core/Game.js (Строка 380)

fpsProblemNotifier : Phaser.Signal

Если игра испытывает трудности с поддержанием желаемой частоты кадров в секунду, это событие будет отправлено.
Желаемая/выбранная частота кадров в секунду, вероятно, должна быть ближе к значению Phaser.Time#suggestedFps.

Исходный код: core/Game.js (Строка 375)

[readonly] height : integer

Текущая высота игры в пикселях.
Не изменяйте этот параметр напрямую: используйте Phaser.ScaleManager#setGameSize - например, game.scale.setGameSize(width, height) - вместо него.

Значение по умолчанию
  • 600
Исходный код: core/Game.js (Строка 69)

[readonly] id : number

Идентификатор игры Phaser (для случаев, когда Pixi поддерживает несколько экземпляров).

Исходный код: core/Game.js (Строка 31)

input : Phaser.Input

Ссылка на менеджер ввода.

Исходный код: core/Game.js (Строка 171)

[readonly] isBooted : boolean

Загружен ли движок игры, т.е. доступен ли?

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

[readonly] isRunning : boolean

Игра запущена или приостановлена?

Исходный код: core/Game.js (Строка 145)

load : Phaser.Loader

Ссылка на загрузчик ресурсов.

Исходный код: core/Game.js (Строка 176)

lockRender : boolean

Если false Phaser будет автоматически рендерить список отображения в каждом обновлении. Если true цикл рендеринга будет пропущен.
Вы можете изменить это значение во время выполнения для точного управления тем, когда Phaser рендерит. Это может быть полезно в определенных типах игр или приложений.
Обратите внимание, что если вы не рендерите список отображения, то никакие преобразования объектов игры не будут обновлены, поэтому используйте это значение осторожно.

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

make : Phaser.GameObjectCreator

Ссылка на создатель GameObject.

Исходный код: core/Game.js (Строка 161)

math : Phaser.Math

Ссылка на математический помощник.

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

net : Phaser.Net

Ссылка на сетевой класс.

Исходный код: core/Game.js (Строка 186)

onBlur : Phaser.Signal

Это событие срабатывает, когда игра теряет фокус (обычно при скрытии страницы).

Исходный код: core/Game.js (Строка 311)

onFocus : Phaser.Signal

Это событие срабатывает, когда игра получает фокус (обычно при показе страницы).

Исходный код: core/Game.js (Строка 316)

onPause : Phaser.Signal

Это событие срабатывает, когда игра приостанавливается.

Исходный код: core/Game.js (Строка 301)

onResume : Phaser.Signal

Это событие срабатывает, когда игра возобновляется после приостановки.

Исходный код: core/Game.js (Строка 306)

parent : строка | HTMLElement

Родительский элемент игры в DOM.

Тип
  • строка | HTMLElement
Исходный код: core/Game.js (Строка 47)

particles : Phaser.Particles

Менеджер частиц.

Исходный код: core/Game.js (Строка 261)

paused : boolean

Состояние приостановки игры. Приостановленная игра не обновляет свои подсистемы.
При приостановке игры отправляется событие onPause. При возобновлении отправляется событие onResume. Возвращает и устанавливает состояние приостановки игры.

Исходный код: core/Game.js (Строка 1154)

[только для чтения] pendingStep : boolean

Внутреннее свойство, используемое enableStep, но также полезно для запросов от ваших собственных объектов игры.

Исходный код: core/Game.js (Строка 289)

physics : Phaser.Physics

Ссылка на менеджер физики.

Исходный код: core/Game.js (Строка 221)

physicsConfig : Объект

Объект конфигурации Phaser.Physics.World.

Исходный код: core/Game.js (Строка 41)

plugins : Phaser.PluginManager

Ссылка на менеджер плагинов.

Исходный код: core/Game.js (Строка 226)

preserveDrawingBuffer : boolean

Значение флага preserveDrawingBuffer влияет на то, сохраняются ли содержимое буфера трассировки после отрисовки.

Исходный код: core/Game.js (Строка 108)

<внутреннее> raf : Phaser.RequestAnimationFrame

Автоматически обрабатывает основной цикл игры с помощью requestAnimationFrame или setTimeout

Внутреннее:
  • Этот член является внутренним (защищенным) и может быть изменён или удалён в будущем.
Исходный код: core/Game.js (Строка 151)

<внутреннее> renderer : PIXI.CanvasRenderer | PIXI.WebGLRenderer

Отрисовщик Pixi.

Тип
  • PIXI.CanvasRenderer | PIXI.WebGLRenderer
Внутреннее:
  • Этот член является внутренним (защищенным) и может быть изменён или удалён в будущем.
Исходный код: core/Game.js (Строка 122)

[только для чтения] renderType : число

Отрисовщик, который будет использовать эта игра. Либо Phaser.AUTO, Phaser.CANVAS, Phaser.WEBGL, или Phaser.HEADLESS.

Исходный код: core/Game.js (Строка 128)

[только для чтения] resolution : целое число

Разрешение вашей игры. Это значение является только для чтения, но его можно изменить во время запуска через объект конфигурации игры.

Значение по умолчанию
  • 1
Исходный код: core/Game.js (Строка 78)

rnd : Phaser.RandomDataGenerator

Экземпляр генератора повторяемых случайных данных.

Исходный код: core/Game.js (Строка 231)

scale : Phaser.ScaleManager

Менеджер масштабирования игры.

Исходный код: core/Game.js (Строка 191)

sound : Phaser.SoundManager

Ссылка на менеджер звука.

Исходный код: core/Game.js (Строка 196)

stage : Phaser.Stage

Ссылка на сцену.

Source code: core/Game.js (Line 201)

state : Phaser.StateManager

Менеджер состояний.

Source code: core/Game.js (Line 133)

[только для чтения] stepCount : число

При включённом шаговом режиме содержит текущий цикл шага.

Source code: core/Game.js (Line 296)

[только для чтения] stepping : boolean

Включить шаговый режим цикла ядра с помощью Game.enableStep().

Source code: core/Game.js (Line 282)

time : Phaser.Time

Ссылка на игровые часы.

Source code: core/Game.js (Line 206)

transparent : boolean

Использовать прозрачный фон холста или нет.

Source code: core/Game.js (Line 96)

tweens : Phaser.TweenManager

Ссылка на менеджер анимации.

Source code: core/Game.js (Line 211)

<внутреннее> updatesThisFrame : целое число

Количество ожидаемых логических обновлений в этом кадре рендеринга; будет равно 1, если не требуется/разрешено выполнение catch-up.

Внутреннее:
  • Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
Source code: core/Game.js (Line 343)

[только для чтения] width : целое число

Текущая ширина игры в пикселях.

Не изменяйте этот параметр напрямую: используйте Phaser.ScaleManager#setGameSize - например. game.scale.setGameSize(width, height).

Значение по умолчанию
  • 800
Source code: core/Game.js (Line 58)

world : Phaser.World

Ссылка на мир.

Source code: core/Game.js (Line 216)

Публичные методы

<internal> boot()

Инициализирует подмодули движка и запускает игру.

Внутренний:
  • Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
Исходный код: core/Game.js (Строка 520)

destroy()

Уничтожает всю игру.

Вызывает destroy у Game.state, Game.sound, Game.scale, Game.stage, Game.input, Game.physics и Game.plugins.

Затем устанавливает все эти локальные обработчики в null, уничтожает рендерер, удаляет холст из DOM
и сбрасывает значения по умолчанию для рендерера PIXI.

Исходный код: core/Game.js (Строка 1001)

disableStep()

Отключает шаги основного цикла игры.

Исходный код: core/Game.js (Строка 976)

enableStep()

Включает шаги основного цикла игры. При включении нужно вызывать game.step() напрямую (возможно, через кнопку DOM?)
Вызов step продвинет цикл игры на один кадр. Это чрезвычайно полезно для отладки трудноуловимых ошибок!

Исходный код: core/Game.js (Строка 962)

<internal> focusGain(event)

Вызывается обработчиком видимости стадии.

Параметры
Имя Тип Описание
event объект

Событие DOM, которое привело к паузе игры, если таковое имеется.

Внутренний:
  • Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
Исходный код: core/Game.js (Строка 1132)

<internal> focusLoss(event)

Вызывается обработчиком видимости стадии.

Параметры
Имя Тип Описание
event объект

Событие DOM, которое привело к паузе игры, если таковое имеется.

Внутренний:
  • Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
Исходный код: core/Game.js (Строка 1114)

<internal> gamePaused(event)

Вызывается обработчиком видимости стадии.

Параметры
Имя Тип Описание
event объект

Событие DOM, которое привело к паузе игры, если таковое имеется.

Внутренний:
  • Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
Исходный код: core/Game.js (Строка 1048)

<internal> gameResumed(event)

Вызывается обработчиком видимости стадии.

Параметры
Имя Тип Описание
event объект

Событие DOM, которое привело к паузе игры, если таковое имеется.

Внутренний:
  • Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
Исходный код: core/Game.js (Строка 1080)

<internal> parseConfig()

Парсит объект конфигурации игры.

Внутренний:
  • Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
Исходный код: core/Game.js (Строка 440)

<internal> setUpRenderer()

Проверяет, может ли устройство использовать запрошенный рендерер, и настраивает его или альтернативный, если нет.

Внутренний:
  • Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
Исходный код: core/Game.js (Строка 676)

<internal> showDebugHeader()

Отображает заголовок отладки версии Phaser в консоли.

Внутренний:
  • Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
Исходный код: core/Game.js (Строка 609)

step()

При включённом режиме шагов вы должны вызвать эту функцию напрямую (возможно, через кнопку DOM?), чтобы продвинуть цикл игры на один кадр.
Это чрезвычайно полезно для отладки трудноуловимых ошибок! Используйте внутреннее свойство stepCount для отслеживания прогресса.

Исходный код: core/Game.js (Строка 988)

<internal> update(time)

Основной цикл игры.

Параметры
Имя Тип Описание
time число

Текущее время, предоставленное RequestAnimationFrame.

Внутренний:
  • Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
Исходный код: core/Game.js (Строка 777)

<internal> updateLogic(timeStep)

Обновляет все логические подсистемы в Phaser. Вызывается автоматически функцией Game.update.

Параметры
Имя Тип Описание
timeStep число

Значение текущего timeStep, определённое функцией Game.update.

Внутренний:
  • Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
Исходный код: core/Game.js (Строка 877)

<internal> updateRender(elapsedTime)

Выполняет цикл рендеринга.
Он начинается с вызова State.preRender. Здесь вы можете произвести любые необходимые последние корректировки отображаемых объектов.
Затем вызывается рендерер, который отрисовывает весь список отображения, начиная с объекта Stage и двигаясь вниз.
Затем вызывается plugin.render для всех загруженных плагинов в порядке их включения.
После этого вызывается State.render. Любой рендеринг, выполняемый здесь, будет происходить поверх списка отображения.
Наконец, вызывается plugin.postRender для всех загруженных плагинов в порядке их включения.
Этот метод вызывается автоматически методом Game.update, вызывать его напрямую не нужно.
Если вам требуется точный контроль над временем рендеринга Phaser, используйте boolean Game.lockRender.
Phaser будет выполнять рендеринг только тогда, когда этот boolean равен false.

Параметры
Имя Тип Описание
elapsedTime число

Время, прошедшее с момента последнего обновления.

Внутренний:
  • Этот член является внутренним (защищенным) и может быть изменён или удалён в будущем.
Исходный код: core/Game.js (Строка 925)

© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.Game.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API