Spec-Zone.ru › Phaser

Класс: Phaser.Loader

Конструктор

new Loader(game)

Загрузчик обрабатывает загрузку всего внешнего содержимого, такого как изображения, звуки, атласы текстур и данные файлы.

Загрузчик использует комбинацию загрузки тегов (например, элементов изображения) и XHR и предоставляет обратные вызовы прогресса и завершения.

Поддерживается параллельная загрузка (см. enableParallel) и включена по умолчанию.
Поведение загрузки ресурсов в режиме параллельной загрузки контролируется точками синхронизации, как обсуждается в withSyncPoint.

Атласы текстур можно создавать с помощью инструментов, таких как Texture Packer и
Shoebox

Параметры
Имя Тип Описание
game Phaser.Game

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

Исходный код: loader/Loader.js (Строка 22)

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

[static] PHYSICS_LIME_CORONA_JSON : number

Исходный код: loader/Loader.js (Строка 322)

[static] PHYSICS_PHASER_JSON : number

Исходный код: loader/Loader.js (Строка 328)

[static] TEXTURE_ATLAS_JSON_ARRAY : number

Исходный код: loader/Loader.js (Строка 304)

[static] TEXTURE_ATLAS_JSON_HASH : number

Исходный код: loader/Loader.js (Строка 310)

[static] TEXTURE_ATLAS_JSON_PYXEL : number

Исходный код: loader/Loader.js (Строка 334)

[static] TEXTURE_ATLAS_XML_STARLING : number

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

_withSyncPointDepth

Счётчик: если больше нуля, файлы автоматически добавляются в качестве точки синхронизации.

Свойства:
Имя Тип Описание
_withSyncPointDepth; целое число
Исходный код: loader/Loader.js (Строка 227)

baseURL : строка

Если вы хотите добавить URL перед путём любого ресурса, вы можете установить его здесь.
Полезно, если базовый URL ресурсов можно настроить вне кода игры.
Строка должна заканчиваться "/".

Исходный код: loader/Loader.js (Строка 83)

<внутреннее> cache : Phaser.Cache

Локальная ссылка на Phaser.Cache.

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

crossOrigin : boolean | string

Значение crossOrigin, применяемое к загруженным изображениям. Очень часто его нужно установить в 'anonymous'.

Тип
  • boolean | строка
Исходный код: loader/Loader.js (Строка 74)

enableParallel : boolean

Если true (по умолчанию), то будет включена параллельная загрузка.

Чтобы отключить все параллельные загрузки, это значение должно быть установлено в false перед загрузкой любого ресурса.

Исходный код: loader/Loader.js (Строка 211)

<внутреннее> game : Phaser.Game

Локальная ссылка на игру.

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

hasLoaded : boolean

True, если все ресурсы в очереди завершили загрузку.

Исходный код: loader/Loader.js (Строка 57)

headers : Объект

Используется для сопоставления типов MIME приложения с заголовком Accept в запросах XHR.
Если эти сопоставления не требуются или они вызывают проблемы на вашем сервере,
удалите их из объекта headers, и XHR-запрос не будет пытаться их использовать.

Этот объект также можно использовать для установки заголовка X-Requested-With, чтобы
XMLHttpRequest (или любое другое необходимое значение). Для этого сделайте:

this.load.headers.requestedWith = 'XMLHttpRequest'

перед добавлением чего-либо в Loader. Затем XHR-загрузчик вызовет:

setRequestHeader('X-Requested-With', this.headers['requestedWith'])

Значение по умолчанию
  • {"undefined":"application/xml"}
Исходный код: loader/Loader.js (Строка 122)

isLoading : boolean

True, если Loader выполняет загрузку очереди.

Исходный код: loader/Loader.js (Строка 50)

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

Количество одновременно загружаемых ресурсов.

Многие современные браузеры ограничивают 6 запросов на домен; это немного консервативно.

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

onFileComplete : Phaser.Signal

Это событие срабатывает, когда файл был загружен или не удалось загрузить.

Любая функция, привязанная к этому событию, получит следующие параметры:

прогресс, ключ файла, успех?, общее количество загруженных файлов, общее количество файлов

Где прогресс - число от 1 до 100 (включительно), представляющее процент загрузки.

Исходный код: loader/Loader.js (Строка 175)

onFileError : Phaser.Signal

Это событие срабатывает, когда файл (или пакет) завершается ошибкой в результате запроса загрузки.

Для файлов оно будет вызвано до onFileComplete. Для пакетов оно будет вызвано до onPackComplete.

Параметры: (file key, file)

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

onFileStart : Phaser.Signal

Это событие срабатывает непосредственно перед началом загрузки файла.
Возможна ошибка файла (например, ошибка загрузки, неверный формат) после отправки этого события.

Параметры: (progress, file key, file url)

Исходный код: loader/Loader.js (Строка 162)

onLoadComplete : Phaser.Signal

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

Source code: loader/Loader.js (Line 141)

onLoadStart : Phaser.Signal

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

Source code: loader/Loader.js (Line 134)

onPackComplete : Phaser.Signal

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

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

Параметры: (pack key, success?, total packs loaded, total packs)

Source code: loader/Loader.js (Line 152)

path : string

Значение path, если задано, добавляется перед любым относительным путем к файлу. Например:

load.path = "images/sprites/"; load.image("ball", "ball.png"); load.image("tree", "level1/oaktree.png"); load.image("boom", "http://server.com/explode.png");

Будет загружать файл ball из images/sprites/ball.png и дерево из
images/sprites/level1/oaktree.png но файл boom будет загружаться из URL,
указанного в качестве абсолютного URL.

Обратите внимание, что путь добавляется перед именем файла, но после baseURL (если задано).

Строка должна заканчиваться "/".

Source code: loader/Loader.js (Line 103)

<internal> preloadSprite : Object

Вы можете по желанию связать спрайт прогресса с setPreloadSprite.

Это свойство — объект, содержащий: спрайт, прямоугольник, направление, ширину и высоту

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

progress

Значение процента загрузки (от 0 до 100). См. Phaser.Loader#progressFloat.

Свойства:
Тип Описание
целое число
Source code: loader/Loader.js (Line 3060)

progressFloat

Значение прогресса загрузки без округления (от 0,0 до 100,0).

Общий показатель прогресса.
Возможно снижение прогресса после onLoadStart, если добавляется больше файлов.

Свойства:
Тип Описание
число
Source code: loader/Loader.js (Line 3042)

resetLocked : boolean

Если true, все вызовы Loader.reset будут проигнорированы. Полезно, если вам нужно создать очередь загрузки перед переключением на состояние preloader.

Source code: loader/Loader.js (Line 43)

useXDomainRequest : boolean

Этот метод устарел и не должен использоваться. Он может быть удалён в будущем.

Если true и браузер поддерживает XDomainRequest, он будет использоваться вместо XHR.

Это актуально только для IE 9 и должно только активироваться для клиентов IE 9, когда это требуется сервером/CDN.

Устарело:
  • Это актуально только для IE 9.
Source code: loader/Loader.js (Line 196)

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

addSyncPoint(type, key) → {Phaser.Loader}

Добавить точку синхронизации для определённого файла/актива в очереди загрузки.

Это не повлияет на уже загруженные активы.

Параметры
Имя Тип Описание
type string

Тип ресурса, который нужно превратить в точку синхронизации (изображение, звук, xml и т. д.).

key string

Ключ файла, который нужно превратить в точку синхронизации.

Возвращаемое значение
Phaser.Loader -

Этот экземпляр Loader.

Исходный код: loader/Loader.js (Строка 1675)
См.
  • withSyncPoint

<internal> addToFileList(type, key, url, properties, overwrite, extension) → {Phaser.Loader}

Внутренняя функция, добавляющая новую запись в список файлов. Не вызывать напрямую.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
type string

Тип ресурса, добавляемого в список (изображение, звук, xml и т. д.).

key string

Уникальный ключ кэша для этого ресурса.

url string <optional>

URL, откуда будет загружен актив.

properties object <optional>
(none)

Дополнительные свойства, необходимые для загрузки файла. Они добавляются непосредственно в объект добавленного файла и перезаписывают любые значения по умолчанию.

overwrite boolean <optional>
false

Если true, то это перезапишет актив файла того же типа/ключа. В противном случае добавит только новый актив. Если overwrite = true и актив уже загружается (или был загружен), то он добавляется в конец.

extension string <optional>

Если URL не указан, Loader иногда автоматически сгенерирует URL на основе ключа, используя это как расширение.

Возвращаемое значение
Phaser.Loader -

Этот экземпляр загрузчика Phaser.

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

atlas(key, textureURL, atlasURL, atlasData, format) → {Phaser.Loader}

Добавляет файл Texture Atlas в текущую очередь загрузки.

Для создания Texture Atlas можно использовать такие инструменты, как:

Texture Packer
Shoebox

Если используется Texture Packer, рекомендуется включить опцию "Trim sprite names".
Если в вашем инструменте есть опция "поворот" получившихся кадров, отключите её.

Вы можете либо загрузить данные внешним образом, указав URL файла json.
Или передать JSON-объект или строку через параметр atlasData.
Если вы передадите строку, данные автоматически пройдут через JSON.parse, а затем немедленно добавятся в кэш Phaser.

Если указаны URL, файлы не загружаются сразу после вызова этого метода, а добавляются в очередь загрузки.

Ключ должен быть уникальной строкой. Он используется для добавления файла в кэш Phaser после успешной загрузки.

Получить файл можно через Cache.getImage(key). JSON-файлы автоматически парсятся при загрузке.
Если нужно контролировать время парсинга JSON, используйте Loader.text и парсите JSON-файл по мере необходимости.

URL могут быть относительными или абсолютными. Если URL относительный, значения Loader.baseURL и Loader.path будут добавлены к нему.

Если textureURL не указан, Loader возьмёт ключ и создаст имя файла из него.
Например, если ключ "player", а textureURL = null, Loader установит URL в "player.png".
То же самое относится к atlasURL. Если atlasURL не указан и не предоставлен atlasData, Loader
установит atlasURL как ключ. Например, если ключ "player", atlasURL будет "player.json".

Если вы этого не хотите, предоставьте URL и/или объект данных.

Параметры
Имя Тип Аргумент Описание
key string

Уникальный ключ актива файла текстурного атласа.

textureURL string <optional>

URL изображения файла текстурного атласа. Если не определён или null, URL будет установлен в <key>.png, т. е. если key был "alien", то URL будет "alien.png".

atlasURL string <optional>

URL файла данных текстурного атласа. Если не определён или null и не предоставлен atlasData, URL будет установлен в <key>.json, т. е. если key был "alien", то URL будет "alien.json".

atlasData object <optional>

Объект JSON или XML данных. Вам не нужно это, если данные загружаются по URL.

format number <optional>

Формат данных. Может быть Phaser.Loader.TEXTURE_ATLAS_JSON_ARRAY (по умолчанию), Phaser.Loader.TEXTURE_ATLAS_JSON_HASH или Phaser.Loader.TEXTURE_ATLAS_XML_STARLING.

Возвращаемое значение
Phaser.Loader -

Этот экземпляр Loader.

Исходный код: loader/Loader.js (Строка 1544)

atlasJSONArray(key, textureURL, atlasURL, atlasData) → {Phaser.Loader}

Добавляет файл Texture Atlas в текущую очередь загрузки.

В отличие от Loader.atlasJSONHash этот вызов ожидает, что данные атласа будут в формате JSON Array.

Для создания Texture Atlas можно использовать такие инструменты, как:

Texture Packer
Shoebox

При использовании Texture Packer рекомендуется включить "Trim sprite names".
Если в вашем программном обеспечении для атласа есть опция "повернуть" результирующие кадры, вы должны отключить её.

Вы можете загрузить данные либо извне, предоставив URL-адрес файла json.
Или вы можете передать объект JSON или строку через параметр atlasData.
Если вы передаёте строку, данные автоматически обрабатываются через JSON.parse и затем немедленно добавляются в Phaser.Cache.

Если предоставляются URL-адреса, файлы не загружаются сразу после вызова этого метода, а добавляются в очередь загрузки.

Ключ должен быть уникальной строкой. Он используется для добавления файла в Phaser.Cache после успешной загрузки.

Получите файл через Cache.getImage(key). JSON-файлы автоматически разбираются при загрузке.
Если вам нужно контролировать, когда выполняется разбор JSON, используйте вместо этого Loader.text и разбирайте JSON-файл по мере необходимости.

URL-адреса могут быть относительными или абсолютными. Если URL-адрес является относительным, к нему будут добавлены значения Loader.baseURL и Loader.path.

Если textureURL не указан, загрузчик возьмёт ключ и создаст из него имя файла.
Например, если ключ равен "player", а textureURL равен null, то загрузчик установит URL в "player.png".
То же самое верно для atlasURL. Если atlasURL не указан, и atlasData не предоставлен, то загрузчик
установит atlasURL в ключ. Например, если ключ равен "player", atlasURL будет установлен в "player.json".

Если вы не хотите этого действия, укажите URL-адреса и/или объект данных.

Параметры
Имя Тип Аргумент Описание
key string

Уникальный ключ ресурса файла текстурного атласа.

textureURL string <optional>

URL-адрес файла изображения текстурного атласа. Если не определено или null, URL будет установлен в <key>.png, то есть, если key было "alien", то URL будет "alien.png".

atlasURL string <optional>

URL-адрес файла данных текстурного атласа. Если не определено или null, и atlasData не задан, URL будет установлен в <key>.json, то есть, если key было "alien", то URL будет "alien.json".

atlasData object <optional>

Объект данных JSON. Это не нужно, если данные загружаются из URL-адреса.

Возвращает
Phaser.Loader -

Этот экземпляр загрузчика.

Исходный код: loader/Loader.js (Строка 1398)

atlasJSONHash(key, textureURL, atlasURL, atlasData) → {Phaser.Loader}

Добавляет файл Texture Atlas в текущую очередь загрузки.

В отличие от Loader.atlas этот вызов ожидает, что данные атласа будут в формате JSON Hash.

Для создания Texture Atlas можно использовать такие инструменты, как:

Texture Packer
Shoebox

При использовании Texture Packer рекомендуется включить "Trim sprite names".
Если в вашем программном обеспечении для атласа есть опция "повернуть" результирующие кадры, вы должны отключить её.

Вы можете загрузить данные либо извне, предоставив URL-адрес файла json.
Или вы можете передать объект JSON или строку через параметр atlasData.
Если вы передаёте строку, данные автоматически обрабатываются через JSON.parse и затем немедленно добавляются в Phaser.Cache.

Если предоставляются URL-адреса, файлы не загружаются сразу после вызова этого метода, а добавляются в очередь загрузки.

Ключ должен быть уникальной строкой. Он используется для добавления файла в Phaser.Cache после успешной загрузки.

Получите файл через Cache.getImage(key). JSON-файлы автоматически разбираются при загрузке.
Если вам нужно контролировать, когда выполняется разбор JSON, используйте вместо этого Loader.text и разбирайте JSON-файл по мере необходимости.

URL-адреса могут быть относительными или абсолютными. Если URL-адрес является относительным, к нему будут добавлены значения Loader.baseURL и Loader.path.

Если textureURL не указан, загрузчик возьмёт ключ и создаст из него имя файла.
Например, если ключ равен "player", а textureURL равен null, то загрузчик установит URL в "player.png".
То же самое верно для atlasURL. Если atlasURL не указан, и atlasData не предоставлен, то загрузчик
установит atlasURL в ключ. Например, если ключ равен "player", atlasURL будет установлен в "player.json".

Если вы не хотите этого действия, укажите URL-адреса и/или объект данных.

Параметры
Имя Тип Аргумент Описание
key string

Уникальный ключ ресурса файла текстурного атласа.

textureURL string <optional>

URL-адрес файла изображения текстурного атласа. Если не определено или null, URL будет установлен в <key>.png, то есть, если key было "alien", то URL будет "alien.png".

atlasURL string <optional>

URL-адрес файла данных текстурного атласа. Если не определено или null, и atlasData не задан, URL будет установлен в <key>.json, то есть, если key было "alien", то URL будет "alien.json".

atlasData object <optional>

Объект данных JSON. Это не нужно, если данные загружаются из URL-адреса.

Возвращает
Phaser.Loader -

Этот экземпляр загрузчика.

Исходный код: loader/Loader.js (Строка 1444)

atlasXML(key, textureURL, atlasURL, atlasData) → {Phaser.Loader}

Добавляет файл Texture Atlas в текущую очередь загрузки.

Этот вызов ожидает, что данные атласа будут в формате данных Starling XML.

Для создания Texture Atlas можно использовать такие инструменты, как:

Texture Packer
Shoebox

При использовании Texture Packer рекомендуется включить "Trim sprite names".
Если в вашем программном обеспечении для атласа есть опция "повернуть" результирующие кадры, вы должны отключить её.

Вы можете загрузить данные либо извне, предоставив URL-адрес xml-файла.
Или вы можете передать объект XML или строку через параметр atlasData.
Если вы передаёте строку, данные автоматически обрабатываются через Loader.parseXML и затем немедленно добавляются в Phaser.Cache.

Если предоставляются URL-адреса, файлы не загружаются сразу после вызова этого метода, а добавляются в очередь загрузки.

Ключ должен быть уникальной строкой. Он используется для добавления файла в Phaser.Cache после успешной загрузки.

Получите файл через Cache.getImage(key). XML-файлы автоматически разбираются при загрузке.
Если вам нужно контролировать, когда выполняется разбор XML, используйте вместо этого Loader.text и разбирайте XML-файл по мере необходимости.

URL-адреса могут быть относительными или абсолютными. Если URL-адрес является относительным, к нему будут добавлены значения Loader.baseURL и Loader.path.

Если textureURL не указан, загрузчик возьмёт ключ и создаст из него имя файла.
Например, если ключ равен "player", а textureURL равен null, то загрузчик установит URL в "player.png".
То же самое верно для atlasURL. Если atlasURL не указан, и atlasData не предоставлен, то загрузчик
установит atlasURL в ключ. Например, если ключ равен "player", atlasURL будет установлен в "player.xml".

Если вы не хотите этого действия, укажите URL-адреса и/или объект данных.

Параметры
Имя Тип Аргумент Описание
key string

Уникальный ключ актива текстурной карты.

textureURL string <optional>

URL изображения текстурной карты. Если не определено или null значение URL будет установлено в <key>.png, т.е. если key было "alien", то URL будет "alien.png".

atlasURL string <optional>

URL файла данных текстурной карты. Если не определено или null и нет данных atlasData, значение URL будет установлено в <key>.json, т.е. если key было "alien", то URL будет "alien.xml".

atlasData object <optional>

Объект данных XML. Вам это не нужно, если данные загружаются по URL.

Возвращает
Phaser.Loader -

Этот экземпляр загрузчика.

Исходный код: loader/Loader.js (Строка 1490)

audio(key, urls, autoDecode) → {Phaser.Loader}

Добавляет аудиофайл в текущую очередь загрузки.

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

Ключ должен быть уникальной строкой. Он используется для добавления файла в Phaser.Cache при успешной загрузке.

Получить файл можно через Cache.getSound(key).

URL может быть относительным или абсолютным. Если URL относительный, к нему будут добавлены значения Loader.baseURL и Loader.path.

Предупреждение для мобильных устройств: Есть некоторые мобильные устройства (определённые версии iPad 2 и iPad Mini), которые не могут воспроизводить аудио с частотой 48000 Гц.
При попытке воспроизведения аудио искажается и появляется гудение, в конечном итоге приводящее к сбою звуковой системы.
Решение заключается в использовании более низкой частоты кодирования, такой как 44100 Гц.

Параметры
Имя Тип Аргумент По умолчанию Описание
key string

Уникальный ключ актива аудиофайла.

urls string | Array.<string> | Array.<object>

Либо строка, либо массив URI или пар {uri: .., type: ..}.
Если указан массив, то будет выбран первый URI (или URI + пара MIME), совместимый с устройством.
Например: "jump.mp3", ['jump.mp3', 'jump.ogg', 'jump.m4a'], или [{uri: "data:<opus_resource>", type: 'opus'}, 'fallback.mp3'].
BLOB и DATA URI могут быть использованы, но автоматическое определение поддерживается только при использовании в виде пары; в противном случае формат необходимо проверить вручную перед добавлением ресурса.

autoDecode boolean <optional>
true

При использовании Web Audio аудиофайлы могут быть декодированы во время загрузки или в процессе выполнения.
Аудиофайлы нельзя воспроизводить до их декодирования, и, если указано, это позволяет немедленное декодирование. Декодирование — это асинхронный процесс, не блокирующий выполнение, однако он сильно загружает процессор мобильных устройств.

Возвращает
Phaser.Loader -

Этот экземпляр загрузчика.

Исходный код: loader/Loader.js (Строка 991)

audioSprite(key, urls, jsonURL, jsonData, autoDecode) → {Phaser.Loader}

Добавляет файл аудио-спрайта в текущую очередь загрузки.

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

Ключ должен быть уникальной строкой. Он используется для добавления файла в Phaser.Cache при успешной загрузке.

Аудио-спрайты — это сочетание аудиофайлов и конфигурации JSON.

JSON соответствует формату, созданному https://github.com/tonistiigi/audiosprite

Получить файл можно через Cache.getSoundData(key).

URL может быть относительным или абсолютным. Если URL относительный, к нему будут добавлены значения Loader.baseURL и Loader.path.

Параметры
Имя Тип Аргумент По умолчанию Описание
key string

Уникальный ключ актива аудиофайла.

urls Array | string

Массив, содержащий URL аудиофайлов, например: [ 'audiosprite.mp3', 'audiosprite.ogg', 'audiosprite.m4a' ] или одна строка с одним URL.

jsonURL string <optional>
null

URL объекта JSON конфигурации аудио-спрайта. Если вы хотите передать данные напрямую, установите этот параметр в null.

jsonData string | object <optional>
null

Объект JSON или строка, содержащая данные конфигурации аудио-спрайта. Игнорируется, если jsonURL не null.

autoDecode boolean <optional>
true

При использовании Web Audio аудиофайлы могут быть декодированы во время загрузки или в процессе выполнения.
Аудиофайлы нельзя воспроизводить до их декодирования, и, если указано, это позволяет немедленное декодирование. Декодирование — это асинхронный процесс, не блокирующий выполнение, однако он сильно загружает процессор мобильных устройств.

Возвращает
Phaser.Loader -

Этот экземпляр загрузчика.

Исходный код: loader/Loader.js (Строка 1034)

audiosprite(key, urls, jsonURL, jsonData, autoDecode) → {Phaser.Loader}

Легальный псевдоним для Loader.audioSprite. Пожалуйста, смотрите этот метод для документации.

Параметры
Имя Тип Аргумент По умолчанию Описание
key string

Уникальный ключ актива аудиофайла.

urls Array | string

Массив, содержащий URL аудиофайлов, например: [ 'audiosprite.mp3', 'audiosprite.ogg', 'audiosprite.m4a' ] или одна строка с одним URL.

jsonURL string <optional>
null

URL объекта JSON конфигурации аудио-спрайта. Если вы хотите передать данные напрямую, установите этот параметр в null.

jsonData string | object <optional>
null

Объект JSON или строка, содержащая данные конфигурации аудио-спрайта. Игнорируется, если jsonURL не null.

autoDecode boolean <optional>
true

При использовании Web Audio аудиофайлы могут быть декодированы во время загрузки или в процессе выполнения.
Аудиофайлы нельзя воспроизводить до их декодирования, и, если указано, это позволяет немедленное декодирование. Декодирование — это асинхронный процесс, не блокирующий выполнение, однако он сильно загружает процессор мобильных устройств.

Возвращает
Phaser.Loader -

Этот экземпляр загрузчика.

Исходный код: loader/Loader.js (Строка 1093)

binary(key, url, callback, callbackContext) → {Phaser.Loader}

Добавляет двоичный файл в текущую очередь загрузки.

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

Ключ должен быть уникальной строкой. Он используется для добавления файла в кэш Phaser при успешной загрузке.

Получить файл можно через Cache.getBinary(key).

URL может быть относительным или абсолютным. Если URL относительный, то Loader.baseURL и Loader.path будут добавлены перед ним.

Если URL не указан, загрузчик возьмёт ключ и создаст имя файла из него. Например, если ключ — "alien"
и URL не задан, загрузчик установит URL как "alien.bin". Он всегда добавит .bin в качестве расширения.
Если этого не требуется, укажите URL.

Файл будет загружен с помощью xhr с responseType "arraybuffer". Вы можете указать необязательный callback для обработки файла после загрузки.
При вызове callback ему будут переданы 2 параметра: ключ файла и данные файла.

ВНИМАНИЕ: Если указан callback, данные будут установлены в то, что он возвращает. Всегда возвращайте объект данных, даже если вы его не изменяли.

Параметры
Имя Тип Аргумент По умолчанию Описание
key string

Уникальный ключ ресурса двоичного файла.

url string <optional>

URL двоичного файла. Если неопределён или null, URL будет установлен как <key>.bin, т.е. если key был "alien", то URL будет "alien.bin".

callback function <optional>
(none)

Необязательный callback, которому будет передан файл после загрузки, чтобы вы могли выполнить дополнительную обработку.

callbackContext object <optional>

Контекст, в котором будет применён callback. Если не указан, в качестве контекста будет использоваться сам callback.

Возвращаемое значение
Phaser.Loader -

Этот экземпляр загрузчика.

Исходный код: loader/Loader.js (Строка 911)

bitmapFont(key, textureURL, atlasURL, atlasData, xSpacing, ySpacing) → {Phaser.Loader}

Добавляет файлы шрифтов Bitmap Font в текущую очередь загрузки.

Для создания файлов Bitmap Font вы можете использовать:

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

Вы можете загрузить данные внешне, указав URL файла xml.
Или передать объект или строку XML через параметр xmlData.
Если вы передаёте строку, данные автоматически обрабатываются через Loader.parseXML и сразу добавляются в кэш Phaser.

Если URL указаны, файлы не загружаются сразу после вызова этого метода, а добавляются в очередь загрузки.

Ключ должен быть уникальной строкой. Он используется для добавления файла в кэш Phaser при успешной загрузке.

Получить файл можно через Cache.getBitmapFont(key). XML-файлы автоматически парсятся при загрузке.
Если вам нужно контролировать время парсинга XML, используйте Loader.text и обрабатывайте XML-файл по мере необходимости.

URL могут быть относительными или абсолютными. Если URL относительный, то Loader.baseURL и Loader.path будут добавлены перед ним.

Если textureURL не указан, загрузчик возьмёт ключ и создаст имя файла из него.
Например, если ключ — "megaFont" и textureURL — null, то загрузчик установит URL как "megaFont.png".
То же самое относится к atlasURL. Если atlasURL не указан и atlasData не предоставлен, загрузчик
установит atlasURL как ключ. Например, если ключ — "megaFont", atlasURL будет установлен как "megaFont.xml".

Если этого не требуется, укажите URL и/или объект данных.

Параметры
Имя Тип Аргумент По умолчанию Описание
key string

Уникальный ключ ресурса шрифта Bitmap Font.

textureURL string

URL файла текстуры шрифта Bitmap Font. Если неопределён или null, URL будет установлен как <key>.png, т.е. если key был "megaFont", то URL будет "megaFont.png".

atlasURL string

URL файла альтаса шрифта Bitmap Font (xml/json). Если неопределён или null И atlasData равно null, URL будет установлен как <key>.xml, т.е. если key был "megaFont", то URL будет "megaFont.xml".

atlasData object

Необязательный альфас шрифта Bitmap Font в виде строки (сериализованный xml/json).

xSpacing number <optional>
0

Если вы хотите добавить дополнительное горизонтальное расстояние между символами, установите здесь пиксельное значение.

ySpacing number <optional>
0

Если вы хотите добавить дополнительное вертикальное расстояние между строками, установите здесь пиксельное значение.

Возвращаемое значение
Phaser.Loader -

Этот экземпляр загрузчика.

Исходный код: loader/Loader.js (Строка 1307)

checkKeyExists(type, key) → {boolean}

Проверяет, есть ли файл/ресурс с определённым ключом в очереди загрузки.

Чтобы получить доступ к загруженному ресурсу, используйте Phaser.Cache, например Phaser.Cache#checkImageKey

Параметры
Имя Тип Описание
type string

Тип ресурса, который нужно проверить.

key string

Ключ ресурса, который нужно проверить.

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

Возвращает true, если существует, иначе возвращает false.

Исходный код: loader/Loader.js (Строка 390)

getAsset(type, key) → {any}

Находит файл/ресурс с определённым ключом.

Будут найдены только ресурсы в очереди загрузки.

Параметры
Имя Тип Описание
type string

Тип ресурса, который нужно проверить.

key string

Ключ ресурса, который нужно проверить.

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

Возвращает объект, если найден, который содержит 2 свойства: index и file; в противном случае возвращается значение, отличное от true.
Индекс может измениться и должен использоваться только сразу после этого вызова.

Source code: loader/Loader.js (Line 441)

getAssetIndex(type, key) → {number}

Получить индекс элемента очереди загрузки файла/актива с определённым ключом.

Будут найдены только активы, находящиеся в очереди загрузки файла.

Parameters
Name Type Описание
type string

Тип актива, который нужно проверить.

key string

Ключ актива, который нужно проверить.

Returns
number -

Индекс этого ключа в списке файлов или -1, если не найден.
Индекс может изменяться и следует использовать только сразу после этого вызова.

Source code: loader/Loader.js (Line 406)

image(key, url, overwrite) → {Phaser.Loader}

Добавляет изображение в текущую очередь загрузки.

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

Phaser может загружать все распространённые типы изображений: png, jpg, gif и любые другие форматы, которые браузер может обрабатывать напрямую.

Ключ должен быть уникальной строкой. Он используется для добавления файла в Phaser.Cache после успешной загрузки.

Получить изображение с помощью Cache.getImage(key)

URL может быть относительным или абсолютным. Если URL относительный, к нему будут добавлены значения Loader.baseURL и Loader.path.

Если URL не указан, загрузчик возьмёт ключ и создаст имя файла из него. Например, если ключ "alien"
и URL не указан, загрузчик установит URL как "alien.png". Он всегда добавляет .png в качестве расширения.
Если этого не требуется, укажите URL.

Parameters
Name Type Аргумент Значение по умолчанию Описание
key string

Уникальный ключ актива этого файла изображения.

url string <optional>

URL файла изображения. Если не определён или null, URL будет установлен как <key>.png, т.е. если key был "alien", URL будет "alien.png".

overwrite boolean <optional>
false

Если в очереди уже существует незагруженный файл с совпадающим ключом, эта запись перезапишет его.

Returns
Phaser.Loader -

Этот экземпляр загрузчика.

Source code: loader/Loader.js (Line 693)

images(keys, urls) → {Phaser.Loader}

Добавляет массив изображений в текущую очередь загрузки.

Работает, передавая каждый элемент массива методу Loader.image.

Файлы не загружаются сразу после вызова этого метода. Файлы добавляются в очередь для загрузки при запуске загрузчика.

Phaser может загружать все распространённые типы изображений: png, jpg, gif и любые другие форматы, которые браузер может обрабатывать напрямую.

Ключи должны быть уникальными строками. Они используются для добавления файлов в Phaser.Cache после успешной загрузки.

Получить изображения с помощью Cache.getImage(key)

URL может быть относительным или абсолютным. Если URL относительный, к нему будут добавлены значения Loader.baseURL и Loader.path.

Если URL не указан, загрузчик возьмёт ключ и создаст имя файла из него. Например, если ключ "alien"
и URL не указан, загрузчик установит URL как "alien.png". Он всегда добавляет .png в качестве расширения.
Если этого не требуется, укажите URL.

Parameters
Name Type Аргумент Описание
keys array

Массив уникальных ключей актива файлов изображений.

urls array <optional>

Необязательный массив URL. Если не определён или null, URL будет установлен как <key>.png, т.е. если key был "alien", URL будет "alien.png". Если указан, длина массива URLs должна совпадать с длиной массива keys.

Returns
Phaser.Loader -

Этот экземпляр загрузчика.

Source code: loader/Loader.js (Line 722)

json(key, url, overwrite) → {Phaser.Loader}

Добавляет файл JSON в текущую очередь загрузки.

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

Ключ должен быть уникальной строкой. Он используется для добавления файла в Phaser.Cache после успешной загрузки.

Получить файл с помощью Cache.getJSON(key). Файлы JSON автоматически парсятся при загрузке.
Если нужно контролировать время разбора JSON, используйте Loader.text и разобрать текстовый файл по мере необходимости.

URL может быть относительным или абсолютным. Если URL относительный, к нему будут добавлены значения Loader.baseURL и Loader.path.

Если URL не указан, загрузчик возьмёт ключ и создаст имя файла из него. Например, если ключ "alien"
и URL не указан, загрузчик установит URL как "alien.json". Он всегда добавляет .json в качестве расширения.
Если этого не требуется, укажите URL.

Parameters
Name Type Аргумент Значение по умолчанию Описание
key string

Уникальный ключ актива файла json.

url string <optional>

URL файла JSON. Если не определён или null, URL будет установлен как <key>.json, т.е. если key был "alien", URL будет "alien.json".

overwrite boolean <optional>
false

Если в очереди уже существует незагруженный файл с совпадающим ключом, эта запись перезапишет его.

Returns
Phaser.Loader -

Этот экземпляр загрузчика.

Source code: loader/Loader.js (Line 794)

pack(key, url, data, callbackContext) → {Phaser.Loader}

Добавить ресурс пакета JSON ('packfile') в загрузчик.

Файл пакета — это файл JSON, содержащий список активов, которые нужно загрузить.
См. пример 'loader/asset pack' в репозитории примеров Phaser.

Пакеты всегда добавляются перед первым файлом, который не является пакетом и не загружен/загружается.

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

Ключ должен быть уникальной строкой. Он используется для добавления файла в Phaser.Cache после успешной загрузки.

URL файла пакета может быть относительным или абсолютным. Если URL относительный, к нему будут добавлены значения Loader.baseURL и Loader.path.

Parameters
Имя Тип Аргумент Значение по умолчанию Описание
key string

Уникальный ключ ресурса этого пакета ресурсов.

url string <optional>

URL файла Asset Pack JSON. Если вы хотите передать объект json, установите это значение в null и передайте объект в параметре data.

data object <optional>

Данные Asset Pack в формате JSON. Используйте это для передачи объекта данных json вместо загрузки из URL. TODO

callbackContext object <optional>
(loader)

Некоторые операции загрузчика, такие как Binary и Script, требуют контекста для своих обратных вызовов. Передайте контекст здесь.

Возвращает
Phaser.Loader -

Этот экземпляр загрузчика.

Исходный код: loader/Loader.js (Строка 613)

physics(key, url, data, format) → {Phaser.Loader}

Добавляет файл данных физики в текущую очередь загрузки.

Данные должны быть в формате Lime + Corona JSON. Physics Editor от code'n'web экспортирует данные в этом формате напрямую.

Вы можете загрузить данные внешне, указав URL файла json.
Или вы можете передать объект JSON или строку через параметр data.
Если вы передаете строку, данные автоматически проходят через JSON.parse и сразу же добавляются в Phaser.Cache.

Если указан URL, файл не загружается сразу после вызова этого метода, а добавляется в очередь загрузки.

Ключ должен быть уникальной строкой. Он используется для добавления файла в Phaser.Cache после успешной загрузки.

Получите файл через Cache.getJSON(key). JSON-файлы автоматически парсятся при загрузке.
Если вам нужно контролировать момент парсинга JSON, используйте Loader.text и проанализируйте текстовый файл по мере необходимости.

URL может быть относительным или абсолютным. Если URL относительный, Loader.baseURL и Loader.path значения будут добавлены к нему.

Если URL не указан и нет данных, загрузчик возьмет ключ и создаст имя файла из него.
Например, если ключ "alien" и нет URL или данных, загрузчик установит URL в "alien.json".
Он всегда будет использовать .json в качестве расширения.

Если вы этого не хотите, укажите URL или объект данных.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
key string

Уникальный ключ ресурса данных физики в формате json.

url string <optional>

URL файла данных физики. Если не определен или null и нет данных, URL будет установлен в <key>.json, т.е. если key был "alien", то URL будет "alien.json".

data object | string <optional>

Необязательный объект данных в формате JSON. Если задан, URL игнорируется, и этот объект JSON используется для данных физики вместо него.

format string <optional>
Phaser.Physics.LIME_CORONA_JSON

Формат данных физики.

Возвращает
Phaser.Loader -

Этот экземпляр загрузчика.

Исходный код: loader/Loader.js (Строка 1246)

<internal> removeAll()

Удаляет все запросы загрузки файлов - этого недостаточно для остановки текущей загрузки. Используйте reset вместо этого.

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

<internal> removeFile(type, key)

Удаляет файл/ресурс из очереди загрузки.

Файл, который загружается или начал загружаться, удалить нельзя.

Параметры
Имя Тип Описание
type string

Тип ресурса, который нужно добавить в список (изображение, аудио, xml и т.д.).

key string

Ключ файла, который нужно удалить.

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

<internal> replaceInFileList(type, key, url, properties)

Внутренняя функция, которая заменяет существующую запись в списке файлов новой. Не вызывать напрямую.

Параметры
Имя Тип Описание
type string

Тип ресурса, который нужно добавить в список (изображение, аудио, xml и т.д.).

key string

Уникальный ключ Cache ID этого ресурса.

url string

URL, из которого будет загружен ресурс.

properties object

Дополнительные свойства, необходимые для загрузки файла.

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

<internal> reset(hard, clearEvents)

Сбросить загрузчик и очистить все размещенные активы. Если Loader.resetLocked равно true, эта операция будет прервана.

Это приведет к прерыванию загрузки и очистке всех размещенных активов.

Необязательно, вы можете очистить все связанные события.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
hard boolean <optional>
false

Если true, то предварительно загруженные спрайты и другие артефакты также могут быть очищены.

clearEvents boolean <optional>
false

Если true, то на всех сигналах Loader будет вызван removeAll.

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

<internal> resize()

Вызывается автоматически менеджером масштабирования (ScaleManager) при изменении размера игры в режиме масштабирования RESIZE.

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

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

script(key, url, callback, callbackContext) → {Phaser.Loader}

Добавляет файл JavaScript в текущую очередь загрузки.

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

Ключ должен быть уникальной строкой.

URL может быть относительным или абсолютным. Если URL является относительным, ему будут добавлены значения Loader.baseURL и Loader.path.

Если URL не указан, загрузчик (Loader) возьмет ключ и создаст имя файла из него. Например, если ключ — "alien"
и URL не задан, загрузчик установит URL как "alien.js". Он всегда добавляет .js в качестве расширения.
Если этого не нужно, укажите URL.

После успешной загрузки JavaScript автоматически преобразуется в тег скрипта и выполняется, поэтому будьте осторожны с тем, что вы загружаете!

Можно также указать обратный вызов, который будет вызван после создания тега скрипта.
Обратный вызов должен возвращать соответствующие data.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
key string

Уникальный ключ ресурса файла скрипта.

url string <optional>

URL файла JavaScript. Если не определен или null, URL будет установлен как <key>.js, т.е. если key было "alien", URL будет "alien.js".

callback function <optional>
(none)

Необязательный обратный вызов, который будет вызван после загрузки тега скрипта, чтобы вы могли выполнить дополнительную обработку.

callbackContext object <optional>
(загрузчик)

Контекст, в котором будет применен обратный вызов. Если не указан, в качестве контекста будет использован загрузчик Phaser.

Возвращает
Phaser.Loader -

Экземпляр загрузчика (Loader).

Исходный код: loader/Loader.js (Строка 876)

setPreloadSprite(sprite, direction)

Устанавливает спрайт в качестве спрайта предварительной загрузки, передав его в этот метод.

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

Спрайт автоматически станет видимым при вызове этого метода.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
sprite Phaser.Sprite | Phaser.Image

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

direction number <optional>
0

Значение 0 означает, что спрайт будет обрезаться по горизонтали, а значение 1 — по вертикали.

Исходный код: loader/Loader.js (Строка 338)

shader(key, url, overwrite) → {Phaser.Loader}

Добавляет файл фрагментного шейдера в текущую очередь загрузки.

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

Ключ должен быть уникальной строкой. Он используется для добавления файла в Phaser.Cache при успешной загрузке.

Получить файл можно с помощью Cache.getShader(key).

URL может быть относительным или абсолютным. Если URL является относительным, ему будут добавлены значения Loader.baseURL и Loader.path.

Если URL не указан, загрузчик (Loader) возьмет ключ и создаст имя файла из него. Например, если ключ — "blur"
и URL не задан, загрузчик установит URL как "blur.frag". Он всегда добавляет .frag в качестве расширения.
Если этого не нужно, укажите URL.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
key string

Уникальный ключ ресурса файла фрагментного шейдера.

url string <optional>

URL файла фрагментного шейдера. Если не определен или null, URL будет установлен как <key>.frag, т.е. если key было "blur", URL будет "blur.frag".

overwrite boolean <optional>
false

Если загружаемый файл с соответствующим ключом уже существует в очереди, эта запись заменит его.

Возвращает
Phaser.Loader -

Экземпляр загрузчика (Loader).

Исходный код: loader/Loader.js (Строка 822)

spritesheet(key, url, frameWidth, frameHeight, frameMax, margin, spacing) → {Phaser.Loader}

Добавляет спрайт-лист в текущую очередь загрузки.

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

Для уточнения терминологии, используемой Phaser: Спрайт-лист — это изображение, содержащее кадры, как правило, анимации, все одинакового
размера и часто в последовательности. Например, если размер кадра 32x32, то каждый кадр в спрайт-листе будет такого размера.
Иногда (вне Phaser) термин "спрайт-лист" используется для обозначения текстурного атласа.
Текстурный атлас работает, объединяя изображения наилучшим образом, используя любые размеры кадров, часто с обрезкой и обрезкой
кадров в процессе. Программы, такие как Texture Packer, Flash CC или Shoebox, создают текстурные атласы, а не спрайт-листы.
Если у вас атлас, используйте Loader.atlas вместо него.

Ключ должен быть уникальной строкой. Он используется для добавления изображения в Phaser.Cache при успешной загрузке.

Получить файл можно с помощью Cache.getImage(key). Спрайт-листы, являясь изображениями, хранятся в том же кэше, что и все другие изображения.

URL может быть относительным или абсолютным. Если URL является относительным, ему будут добавлены значения Loader.baseURL и Loader.path.

Если URL не указан, загрузчик (Loader) возьмет ключ и создаст имя файла из него. Например, если ключ — "alien"
и URL не задан, загрузчик установит URL как "alien.png". Он всегда добавляет .png в качестве расширения.
Если этого не нужно, укажите URL.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
key string

Уникальный ключ актива файла таблицы.

url string

URL файла спрайт-листа. Если не определено или null, URL будет установлен на <key>.png, т.е. если key было "alien", то URL будет "alien.png".

frameWidth number

Ширина в пикселях одного кадра в спрайт-листе.

frameHeight number

Высота в пикселях одного кадра в спрайт-листе.

frameMax number <optional>
-1

Количество кадров в спрайт-листе. Если не указано, вся картинка будет разделена на кадры.

margin number <optional>
0

Если кадры нарисованы с отступом, укажите его величину здесь.

spacing number <optional>
0

Если между кадрами есть отступ, укажите его величину здесь.

Возвращает
Phaser.Loader -

Этот экземпляр Loader.

Исходный код: loader/Loader.js (Строка 949)

start()

Начать загрузку активов. Обычно вам не нужно вызывать это самим, так как StateManager сделает это.

Исходный код: loader/Loader.js (Строка 1735)

text(key, url, overwrite) → {Phaser.Loader}

Добавляет текстовый файл в текущую очередь загрузки.

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

Ключ должен быть уникальной строкой. Он используется для добавления файла в Phaser.Cache после успешной загрузки.

Получить файл через Cache.getText(key)

URL может быть относительным или абсолютным. Если URL относительный, Loader.baseURL и Loader.path значения будут добавлены к нему.

Если URL не указан, загрузчик возьмет ключ и создаст имя файла из него. Например, если ключ "alien"
и URL не указан, то загрузчик установит URL как "alien.txt". Он всегда добавит .txt в качестве расширения.
Если вам не нужно этого делать, укажите URL.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
key string

Уникальный ключ актива текстового файла.

url string <optional>

URL текстового файла. Если не определено или null, URL будет установлен на <key>.txt, т.е. если key было "alien", то URL будет "alien.txt".

overwrite boolean <optional>
false

Если в очереди уже существует не загруженный файл с совпадающим ключом, эта запись перезапишет его.

Возвращает
Phaser.Loader -

Этот экземпляр Loader.

Исходный код: loader/Loader.js (Строка 767)

tilemap(key, url, data, format) → {Phaser.Loader}

Добавляет файл данных карты тайлов в текущую очередь загрузки.

Phaser может загружать данные в двух форматах: CSV и Tiled JSON.

Tiled — бесплатное программное обеспечение, предназначенное для создания карт тайлов, доступное на http://www.mapeditor.org

Вы можете загрузить данные из внешнего источника, указав URL файла json.
Или вы можете передать объект JSON или строку через параметр data.
Если вы передадите строку, данные автоматически пройдут через JSON.parse и будут сразу же добавлены в Phaser.Cache.

Если указан URL, файл не загружается немедленно после вызова этого метода, а добавляется в очередь загрузки.

Ключ должен быть уникальной строкой. Он используется для добавления файла в Phaser.Cache после успешной загрузки.

Получить файл через Cache.getTilemapData(key). Файлы JSON автоматически парсятся при загрузке.
Если вам нужно контролировать время парсинга JSON, используйте Loader.text и обрабатывайте текстовый файл по мере необходимости.

URL может быть относительным или абсолютным. Если URL относительный, Loader.baseURL и Loader.path значения будут добавлены к нему.

Если URL не указан и данные не предоставлены, загрузчик возьмет ключ и создаст имя файла из него.
Например, если ключ "level1" и URL или данные не указаны, загрузчик установит URL как "level1.json".
Если вы установите формат как Tilemap.CSV, он установит URL как "level1.csv" вместо этого.

Если вам не нужно этого делать, укажите URL или объект данных.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
key string

Уникальный ключ актива данных карты тайлов.

url string <optional>

URL файла карты тайлов. Если не определено или null и данные не указаны, URL будет установлен на <key>.json, т.е. если key было "level1", то URL будет "level1.json".

data object | string <optional>

Необязательный объект JSON. Если указан, URL игнорируется, и этот объект JSON используется вместо данных карты.

format number <optional>
Phaser.Tilemap.CSV

Формат данных карты. Либо Phaser.Tilemap.CSV, либо Phaser.Tilemap.TILED_JSON.

Возвращает
Phaser.Loader -

Этот экземпляр Loader.

Исходный код: loader/Loader.js (Строка 1165)

<internal> totalLoadedFiles() → {number}

Возвращает количество файлов, которые уже загружены, даже если они завершились ошибкой.

Возвращает
number -

Количество файлов, которые уже загружены (даже если они завершились ошибкой)

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

<internal> totalLoadedPacks() → {number}

Возвращает количество наборов активов, которые уже загружены, даже если они завершились ошибкой.

Возвращает
число -

Количество уже загруженных пакетов ресурсов (даже если произошла ошибка)

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

<внутреннее> totalQueuedFiles() → {число}

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

Возвращает
число -

Количество файлов, которые всё ещё остаются в очереди загрузки.

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

<внутреннее> totalQueuedPacks() → {число}

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

Возвращает
число -

Количество пакетов ресурсов, которые всё ещё остаются в очереди загрузки.

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

<внутреннее> transformUrl(url, file) → {строка}

Преобразует URL ресурса.

Встроенная реализация добавляет префикс baseURL, если URL не начинается с http или //

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

Преобразуемый URL.

file объект

Объект файла, который преобразуется.

Возвращает
строка -

Преобразованный URL. В редких случаях, когда URL не указан, возвращает false.

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

video(key, urls, loadEvent, asBlob) → {Phaser.Loader}

Добавляет видеофайл в текущую очередь загрузки.

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

Ключ должен быть уникальной строкой. Он используется для добавления файла в Phaser.Cache при успешной загрузке.

Получить файл можно с помощью Cache.getVideo(key).

URL может быть относительным или абсолютным. Если URL относительный, к нему будут добавлены значения Loader.baseURL и Loader.path.

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

Параметры
Имя Тип Аргумент По умолчанию Описание
key строка

Уникальный ключ видеофайла.

urls строка | Массив.<строка> | Массив.<объект>

Строка или массив URI или пар {uri: .., type: ..}.
Если указан массив, будет выбран первый URI (или URI + пара MIME), совместимый с устройством.
Например: "boom.mp4", ['boom.mp4', 'boom.ogg', 'boom.webm'], или [{uri: "data:<opus_resource>", type: 'opus'}, 'fallback.mp4'].
BLOB и DATA URI могут быть использованы, но автоматическое обнаружение поддерживается только в паре; в противном случае формат должен быть проверен вручную перед добавлением ресурса.

loadEvent строка <необязательно>
'canplaythrough'

Это устанавливает событие источника видео для прослушивания перед тем, как загрузка будет считаться завершённой.
'canplaythrough' означает, что видео загрузило достаточно данных, и пропускная способность достаточно высока для воспроизведения до конца.
'canplay' означает, что видео загрузило достаточно данных для начала воспроизведения, но не обязательно до конца.
'loadeddata' просто гарантирует, что метаданные видео и первый кадр загрузились. Phaser автоматически использует это значение, если браузер определяется как Firefox и не указан loadEvent, иначе по умолчанию canplaythrough.

asBlob логическое <необязательно>
false

Видеофайлы могут быть загружены путём создания элемента видео, в котором устанавливается свойство src.
Или они могут быть загружены через xhr, сохранены как двоичные данные в памяти и затем преобразованы в Blob. Это не поддерживается в IE9 или Android 2.
Если вам нужно воспроизводить одно и то же видео в разное время на разных элементах Sprites, вам нужно загрузить его как Blob.

Возвращает
Phaser.Loader -

Этот экземпляр Loader.

Исходный код: loader/Loader.js (Строка 1111)

withSyncPoints(callback, callbackContext) → {Phaser.Loader}

Добавляет точку синхронизации к ресурсам/файлам, добавленным в предоставленном обратном вызове.

Точка синхронизации обозначает, что ресурс обязательно должен быть полностью загружен перед загрузкой последующих ресурсов.
Ресурс, помеченный как точка синхронизации, не обязательно ожидает загрузки предыдущих ресурсов (если они не являются точками синхронизации). Ресурсы, такие как пакеты, могут загружаться параллельно с точками синхронизации, пока они не завершат свою загрузку.

Параметры
Имя Тип Аргумент По умолчанию Описание
callback функция

Обратный вызов, которому передаётся один аргумент: загрузчик.

callbackContext объект <необязательно>
(загрузчик)

Контекст обратного вызова.

Возвращает
Phaser.Loader -

Этот экземпляр Loader.

Исходный код: loader/Loader.js (Строка 1649)

xml(key, url, overwrite) → {Phaser.Loader}

Добавляет XML-файл в текущую очередь загрузки.

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

Ключ должен быть уникальной строкой. Он используется для добавления файла в Phaser.Cache при успешной загрузке.

Получить файл можно с помощью Cache.getXML(key).

URL может быть относительным или абсолютным. Если URL относительный, к нему будут добавлены значения Loader.baseURL и Loader.path.

Если URL не указан, загрузчик возьмёт ключ и создаст имя файла из него. Например, если ключ "alien", а URL не указан, загрузчик установит URL как "alien.xml". Он всегда добавит .xml в качестве расширения.
Если этого не требуется, укажите URL.

Параметры
Имя Тип Аргумент По умолчанию Описание
key строка

Уникальный ключ ресурса xml-файла.

url строка <необязательно>

URL XML-файла. Если не определено или null URL будет установлен на <key>.xml, т.е. если key было "alien", то URL будет "alien.xml".

overwrite логическое <необязательно>
false

Если загруженный файл с совпадающим ключом уже существует в очереди, эта запись его перезапишет.

Возвращает
Phaser.Loader -

Экземпляр этого загрузчика.

Исходный код: loader/Loader.js (Строка 849)

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

Spec-Zone.ru

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