Класс: Phaser.StateManager
Конструктор
new StateManager(game, pendingState)
Менеджер состояний отвечает за загрузку, настройку и переключение состояний игры.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
game | Phaser.Game | Ссылка на запущенную игру. | ||
pendingState | Phaser.State | Object | <optional> | null | Объект состояния для инициализации менеджера. |
- Исходный код: core/StateManager.js (Строка 17)
Открытые свойства
- Исходный код: core/StateManager.js (Строка 774)
- Исходный код: core/StateManager.js (Строка 68)
- Исходный код: core/StateManager.js (Строка 22)
- Исходный код: core/StateManager.js (Строка 100)
- Исходный код: core/StateManager.js (Строка 88)
- Исходный код: core/StateManager.js (Строка 136)
- Исходный код: core/StateManager.js (Строка 130)
- Исходный код: core/StateManager.js (Строка 142)
- Исходный код: core/StateManager.js (Строка 154)
- Исходный код: core/StateManager.js (Строка 94)
- Исходный код: core/StateManager.js (Строка 124)
- Исходный код: core/StateManager.js (Строка 112)
- Исходный код: core/StateManager.js (Строка 118)
- Исходный код: core/StateManager.js (Строка 148)
- Исходный код: core/StateManager.js (Строка 160)
- Исходный код: core/StateManager.js (Строка 82)
- Исходный код: core/StateManager.js (Строка 106)
- Исходный код: core/StateManager.js (Строка 27)
[readonly] created : boolean
Истина, если для текущего состояния был выполнен метод create (если он есть, иначе значение по умолчанию - истина).
current : string
Текущий активный объект состояния.
game : Phaser.Game
Ссылка на запущенную игру.
onCreateCallback : Function
Вызывается, когда загрузка состояния завершена и начинается создание.
onInitCallback : Function
Вызывается, когда состояние устанавливается как активное.
onLoadRenderCallback : Function
Вызывается, когда состояние отображается на этапе предварительной загрузки.
onLoadUpdateCallback : Function
Вызывается, когда состояние обновляется на этапе предварительной загрузки.
onPausedCallback : Function
Вызывается, когда игра приостановлена.
onPauseUpdateCallback : Function
Вызывается каждый кадр, пока игра приостановлена.
onPreloadCallback : Function
Вызывается, когда состояние начинает загружать ресурсы.
onPreRenderCallback : Function
Вызывается перед отображением состояния и перед очисткой сцены, но после того, как все игровые объекты получили корректировку своих конечных свойств.
onRenderCallback : Function
Вызывается после отображения. Не происходит во время предварительной загрузки (см. onLoadRenderCallback).
onResizeCallback : Function
Вызывается, если ScaleManager.scalemode имеет значение RESIZE и происходит событие изменения размера. Ему передаются новые ширина и высота.
onResumedCallback : Function
Вызывается, когда игра возобновляется из приостановленного состояния.
onShutDownCallback : Function
Вызывается, когда состояние закрывается (т.е. заменяется другим состоянием).
onStateChange : Phaser.Signal
onStateChange - это Phaser.Signal, который отправляется всякий раз, когда игра меняет состояние.
Он отправляется только при запуске нового состояния, что обычно не происходит одновременно с вызовом StateManager.start,
потому что переключение состояний выполняется синхронно с игровым циклом. Он отправляется перед вызовом любых методов нового состояния
(таких как preload и create) и после того, как метод shutdown предыдущего состояния был выполнен.
Указанный вами обратный вызов получает два параметра: строковый ключ нового состояния,
а второй параметр - строковый ключ старого/предыдущего состояния.
onUpdateCallback : Function
Вызывается при обновлении состояния, в каждом игровом цикле. Не происходит во время предварительной загрузки (@see onLoadUpdateCallback).
states : Object
Объект, содержащий Phaser.States.
Открытые методы
- Исходный код: core/StateManager.js (Строка 183)
- Исходный код: core/StateManager.js (Строка 423)
- Исходный код: core/StateManager.js (Строка 378)
- Исходный код: core/StateManager.js (Строка 736)
- Исходный код: core/StateManager.js (Строка 569)
- Внутреннее:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/StateManager.js (Строка 452)
- Внутреннее:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/StateManager.js (Строка 580)
- Внутреннее:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/StateManager.js (Строка 604)
- Внутреннее:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/StateManager.js (Строка 653)
- Внутреннее:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/StateManager.js (Строка 676)
- Исходный код: core/StateManager.js (Строка 324)
- Исходный код: core/StateManager.js (Строка 231)
- Внутреннее:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/StateManager.js (Строка 703)
- Внутреннее:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/StateManager.js (Строка 690)
add(key, state, autoStart)
Добавляет новый State в StateManager. Каждому State необходимо присвоить уникальный ключ для его идентификации.
State может быть объектом Phaser.State (или объектом, расширяющим его), обычным JavaScript-объектом или функцией.
Если передана функция, новый объект состояния будет создан путём вызова этой функции.
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
key | string | Уникальный ключ, используемый для ссылки на этот State, например, "MainMenu", "Level1". | ||
state | Phaser.State | object | function | State, на который необходимо переключиться. | ||
autoStart | boolean | <optional> | false | Если true, State будет запущен сразу после добавления. |
checkState(key) → {boolean}
Проверяет, является ли данный Phaser State допустимым. State считается допустимым, если он содержит хотя бы одну из основных функций: preload, create, update или render.
Параметры
| Имя | Тип | Описание |
|---|---|---|
key | string | Ключ проверяемого State. |
Возвращает
true, если State содержит необходимые функции, иначе false.
clearCurrentState()
Очищает текущий State, вызывая его обратный вызов shutdown. Процесс также удаляет все активные анимации,
сбрасывает камеру, сбрасывает вход, очищает физику, удаляет таймеры и, если задано, очищает мир и кэш.
destroy()
Удаляет все ссылки обратных вызовов StateManager на объект State, обнуляет ссылку на игру и очищает объект States.
Изменить это невозможно без повторной сборки экземпляра Phaser.
getCurrentState() → {Phaser.State}
Возвращает текущий State.
Возвращает
<internal> link(key)
Связывает свойства игры со State, заданным ключом.
Параметры
| Имя | Тип | Описание |
|---|---|---|
key | string | Ключ состояния. |
<internal> loadComplete()
<internal> pause()
<internal> pauseUpdate()
<internal> preRender(elapsedTime)
Параметры
| Имя | Тип | Описание |
|---|---|---|
elapsedTime | number | Время, прошедшее с момента последнего обновления. |
preUpdate()
preUpdate вызывается в самом начале цикла игры. Он отвечает за переключение на новый State, который был запрошен ранее.
remove(key)
Удаляет заданный State.
Параметры
| Имя | Тип | Описание |
|---|---|---|
key | string | Уникальный ключ, используемый для ссылки на этот State, например, "MainMenu", "Level1". |
<internal> render()
<internal> resize()
restart(clearWorld, clearCache, parameter)
Перезапускает текущий State. State.shutDown будет вызван (если он существует) перед перезапуском State.
Параметры
- Исходный код: core/StateManager.js (Строка 291)
- Внутреннее:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/StateManager.js (Строка 617)
- Исходный код: core/StateManager.js (Строка 262)
- Внутреннее:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/StateManager.js (Строка 483)
- Внутреннее:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: core/StateManager.js (Строка 630)
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
clearWorld | boolean | <optional> | true | Очистить всё в мире? Это полностью очищает список отображения мира (но не сцену, поэтому, если вы добавили собственные объекты на сцену, вам необходимо будет управлять ими напрямую). |
clearCache | boolean | <optional> | false | Очистить кэш игры? Это удаляет все загруженные ресурсы. По умолчанию значение false, и вам необходимо иметь clearWorld=true, если вы хотите также очистить кэш. |
parameter | * | <repeatable> | Дополнительные параметры, которые будут переданы в функцию State.init, если она существует. |
<internal> resume()
start(key, clearWorld, clearCache, parameter)
Запустить заданный State. Если State уже выполняется, то State.shutDown будет вызван (если он существует) перед переключением на новый State.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
key | string | Ключ состояния, которое вы хотите запустить. | ||
clearWorld | boolean | <optional> | true | Очистить всё в мире? Это полностью очищает список отображения мира (но не сцену, поэтому, если вы добавили собственные объекты на сцену, вам необходимо будет управлять ими напрямую). |
clearCache | boolean | <optional> | false | Очистить кэш игры? Это удаляет все загруженные ресурсы. По умолчанию значение false, и вам необходимо иметь clearWorld=true, если вы хотите также очистить кэш. |
parameter | * | <repeatable> | Дополнительные параметры, которые будут переданы в функцию State.init (если она существует). |
<internal> unlink(key)
Устанавливает в null все свойства уровня State Phaser, включая ссылку на Game.
Параметры
| Имя | Тип | Описание |
|---|---|---|
key | string | Ключ состояния. |
<internal> update()
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.StateManager.html