Класс: Phaser.Loader
Конструктор
new Loader(game)
Загрузчик обрабатывает загрузку всего внешнего содержимого, такого как изображения, звуки, атласы текстур и данные файлы.
Загрузчик использует комбинацию загрузки тегов (например, элементов изображения) и XHR и предоставляет обратные вызовы прогресса и завершения.
Поддерживается параллельная загрузка (см. enableParallel) и включена по умолчанию.
Поведение загрузки ресурсов в режиме параллельной загрузки контролируется точками синхронизации, как обсуждается в withSyncPoint.
Атласы текстур можно создавать с помощью инструментов, таких как Texture Packer и
Shoebox
Параметры
| Имя | Тип | Описание |
|---|---|---|
game | Phaser.Game | Ссылка на текущую запущенную игру. |
- Исходный код: loader/Loader.js (Строка 22)
Общедоступные свойства
- Исходный код: loader/Loader.js (Строка 322)
- Исходный код: loader/Loader.js (Строка 328)
- Исходный код: loader/Loader.js (Строка 304)
- Исходный код: loader/Loader.js (Строка 310)
- Исходный код: loader/Loader.js (Строка 334)
- Исходный код: loader/Loader.js (Строка 316)
- Исходный код: loader/Loader.js (Строка 227)
- Исходный код: loader/Loader.js (Строка 83)
- Внутреннее:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: loader/Loader.js (Строка 36)
- boolean | строка
- Исходный код: loader/Loader.js (Строка 74)
- Исходный код: loader/Loader.js (Строка 211)
- Внутреннее:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: loader/Loader.js (Строка 29)
- Исходный код: loader/Loader.js (Строка 57)
- Значение по умолчанию
- {"undefined":"application/xml"}
- Исходный код: loader/Loader.js (Строка 122)
- Исходный код: loader/Loader.js (Строка 50)
- Внутреннее:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: loader/Loader.js (Строка 221)
- Исходный код: loader/Loader.js (Строка 175)
- Исходный код: loader/Loader.js (Строка 186)
- Исходный код: loader/Loader.js (Строка 162)
[static] PHYSICS_LIME_CORONA_JSON : number
[static] PHYSICS_PHASER_JSON : number
[static] TEXTURE_ATLAS_JSON_ARRAY : number
[static] TEXTURE_ATLAS_JSON_HASH : number
[static] TEXTURE_ATLAS_JSON_PYXEL : number
[static] TEXTURE_ATLAS_XML_STARLING : number
_withSyncPointDepth
Счётчик: если больше нуля, файлы автоматически добавляются в качестве точки синхронизации.
Свойства:
| Имя | Тип | Описание |
|---|---|---|
_withSyncPointDepth; | целое число |
baseURL : строка
Если вы хотите добавить URL перед путём любого ресурса, вы можете установить его здесь.
Полезно, если базовый URL ресурсов можно настроить вне кода игры.
Строка должна заканчиваться "/".
<внутреннее> cache : Phaser.Cache
Локальная ссылка на Phaser.Cache.
crossOrigin : boolean | string
Значение crossOrigin, применяемое к загруженным изображениям. Очень часто его нужно установить в 'anonymous'.
Тип
enableParallel : boolean
Если true (по умолчанию), то будет включена параллельная загрузка.
Чтобы отключить все параллельные загрузки, это значение должно быть установлено в false перед загрузкой любого ресурса.
<внутреннее> game : Phaser.Game
Локальная ссылка на игру.
hasLoaded : boolean
True, если все ресурсы в очереди завершили загрузку.
headers : Объект
Используется для сопоставления типов MIME приложения с заголовком Accept в запросах XHR.
Если эти сопоставления не требуются или они вызывают проблемы на вашем сервере,
удалите их из объекта headers, и XHR-запрос не будет пытаться их использовать.
Этот объект также можно использовать для установки заголовка X-Requested-With, чтобыXMLHttpRequest (или любое другое необходимое значение). Для этого сделайте:
this.load.headers.requestedWith = 'XMLHttpRequest'
перед добавлением чего-либо в Loader. Затем XHR-загрузчик вызовет:
setRequestHeader('X-Requested-With', this.headers['requestedWith'])
isLoading : boolean
True, если Loader выполняет загрузку очереди.
<внутреннее> maxParallelDownloads : целое число
Количество одновременно загружаемых ресурсов.
Многие современные браузеры ограничивают 6 запросов на домен; это немного консервативно.
onFileComplete : Phaser.Signal
Это событие срабатывает, когда файл был загружен или не удалось загрузить.
Любая функция, привязанная к этому событию, получит следующие параметры:
прогресс, ключ файла, успех?, общее количество загруженных файлов, общее количество файлов
Где прогресс - число от 1 до 100 (включительно), представляющее процент загрузки.
onFileError : Phaser.Signal
Это событие срабатывает, когда файл (или пакет) завершается ошибкой в результате запроса загрузки.
Для файлов оно будет вызвано до onFileComplete. Для пакетов оно будет вызвано до onPackComplete.
Параметры: (file key, file)
onFileStart : Phaser.Signal
Это событие срабатывает непосредственно перед началом загрузки файла.
Возможна ошибка файла (например, ошибка загрузки, неверный формат) после отправки этого события.
Параметры: (progress, file key, file url)
onLoadComplete : Phaser.Signal
Это событие срабатывает, когда последний файл в очереди загрузки был загружен или произошла ошибка.
- Source code: loader/Loader.js (Line 141)
- Source code: loader/Loader.js (Line 134)
- Source code: loader/Loader.js (Line 152)
- Source code: loader/Loader.js (Line 103)
- Внутренний:
- Этот член является внутренним (защищенным) и может быть изменён или удалён в будущем.
- Source code: loader/Loader.js (Line 67)
- Source code: loader/Loader.js (Line 3060)
- Source code: loader/Loader.js (Line 3042)
- Source code: loader/Loader.js (Line 43)
- Этот метод устарел и не должен использоваться. Он может быть удалён в будущем.
- Устарело:
- Это актуально только для IE 9.
- Source code: loader/Loader.js (Line 196)
onLoadStart : Phaser.Signal
Это событие срабатывает при начале процесса загрузки: до запроса первого файла,
но после загрузки всех начальных пакетов.
onPackComplete : Phaser.Signal
Это событие срабатывает, когда пакет ресурсов загружен или не удалось загрузить.
Вызывается, когда файл манифеста пакета ресурсов загружен и его содержимое успешно добавлено в очередь загрузки.
Параметры: (pack key, success?, total packs loaded, total packs)
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 (если задано).
Строка должна заканчиваться "/".
<internal> preloadSprite : Object
Вы можете по желанию связать спрайт прогресса с setPreloadSprite.
Это свойство — объект, содержащий: спрайт, прямоугольник, направление, ширину и высоту
progress
Значение процента загрузки (от 0 до 100). См. Phaser.Loader#progressFloat.
Свойства:
| Тип | Описание |
|---|---|
| целое число |
progressFloat
Значение прогресса загрузки без округления (от 0,0 до 100,0).
Общий показатель прогресса.
Возможно снижение прогресса после onLoadStart, если добавляется больше файлов.
Свойства:
| Тип | Описание |
|---|---|
| число |
resetLocked : boolean
Если true, все вызовы Loader.reset будут проигнорированы. Полезно, если вам нужно создать очередь загрузки перед переключением на состояние preloader.
useXDomainRequest : boolean
Если true и браузер поддерживает XDomainRequest, он будет использоваться вместо XHR.
Это актуально только для IE 9 и должно только активироваться для клиентов IE 9, когда это требуется сервером/CDN.
Публичные методы
- Исходный код: loader/Loader.js (Строка 1675)
- См.
-
- withSyncPoint
- Внутренний:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: loader/Loader.js (Строка 515)
- Исходный код: loader/Loader.js (Строка 1544)
addSyncPoint(type, key) → {Phaser.Loader}
Добавить точку синхронизации для определённого файла/актива в очереди загрузки.
Это не повлияет на уже загруженные активы.
Параметры
| Имя | Тип | Описание |
|---|---|---|
type | string | Тип ресурса, который нужно превратить в точку синхронизации (изображение, звук, xml и т. д.). |
key | string | Ключ файла, который нужно превратить в точку синхронизации. |
Возвращаемое значение
Этот экземпляр Loader.
<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.
atlas(key, textureURL, atlasURL, atlasData, format) → {Phaser.Loader}
Добавляет файл Texture Atlas в текущую очередь загрузки.
Для создания Texture Atlas можно использовать такие инструменты, как:
Если используется 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 изображения файла текстурного атласа. Если не определён или |
atlasURL | string | <optional> | URL файла данных текстурного атласа. Если не определён или |
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. |
Возвращаемое значение
Этот экземпляр Loader.
atlasJSONArray(key, textureURL, atlasURL, atlasData) → {Phaser.Loader}
- Исходный код: loader/Loader.js (Строка 1398)
- Исходный код: loader/Loader.js (Строка 1444)
Добавляет файл Texture Atlas в текущую очередь загрузки.
В отличие от Loader.atlasJSONHash этот вызов ожидает, что данные атласа будут в формате JSON Array.
Для создания Texture Atlas можно использовать такие инструменты, как:
При использовании 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-адрес файла изображения текстурного атласа. Если не определено или |
atlasURL | string | <optional> | URL-адрес файла данных текстурного атласа. Если не определено или |
atlasData | object | <optional> | Объект данных JSON. Это не нужно, если данные загружаются из URL-адреса. |
Возвращает
Этот экземпляр загрузчика.
atlasJSONHash(key, textureURL, atlasURL, atlasData) → {Phaser.Loader}
Добавляет файл Texture Atlas в текущую очередь загрузки.
В отличие от Loader.atlas этот вызов ожидает, что данные атласа будут в формате JSON Hash.
Для создания Texture Atlas можно использовать такие инструменты, как:
При использовании 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-адрес файла изображения текстурного атласа. Если не определено или |
atlasURL | string | <optional> | URL-адрес файла данных текстурного атласа. Если не определено или |
atlasData | object | <optional> | Объект данных JSON. Это не нужно, если данные загружаются из URL-адреса. |
Возвращает
Этот экземпляр загрузчика.
atlasXML(key, textureURL, atlasURL, atlasData) → {Phaser.Loader}
Добавляет файл Texture Atlas в текущую очередь загрузки.
Этот вызов ожидает, что данные атласа будут в формате данных Starling XML.
Для создания Texture Atlas можно использовать такие инструменты, как:
При использовании 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-адреса и/или объект данных.
Параметры
- Исходный код: loader/Loader.js (Строка 1490)
- Исходный код: loader/Loader.js (Строка 991)
- Исходный код: loader/Loader.js (Строка 1034)
| Имя | Тип | Аргумент | Описание |
|---|---|---|---|
key | string | Уникальный ключ актива текстурной карты. | |
textureURL | string | <optional> | URL изображения текстурной карты. Если не определено или |
atlasURL | string | <optional> | URL файла данных текстурной карты. Если не определено или |
atlasData | object | <optional> | Объект данных XML. Вам это не нужно, если данные загружаются по URL. |
Возвращает
Этот экземпляр загрузчика.
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 или пар | ||
autoDecode | boolean | <optional> | true | При использовании Web Audio аудиофайлы могут быть декодированы во время загрузки или в процессе выполнения. |
Возвращает
Этот экземпляр загрузчика.
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 аудиофайлы могут быть декодированы во время загрузки или в процессе выполнения. |
Возвращает
Этот экземпляр загрузчика.
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 аудиофайлы могут быть декодированы во время загрузки или в процессе выполнения. |
Возвращает
- Исходный код: loader/Loader.js (Строка 1093)
- Исходный код: loader/Loader.js (Строка 911)
- Исходный код: loader/Loader.js (Строка 1307)
- Исходный код: loader/Loader.js (Строка 390)
Этот экземпляр загрузчика.
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 двоичного файла. Если неопределён или | |
callback | function | <optional> | (none) | Необязательный callback, которому будет передан файл после загрузки, чтобы вы могли выполнить дополнительную обработку. |
callbackContext | object | <optional> | Контекст, в котором будет применён callback. Если не указан, в качестве контекста будет использоваться сам callback. |
Возвращаемое значение
Этот экземпляр загрузчика.
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. Если неопределён или | ||
atlasURL | string | URL файла альтаса шрифта Bitmap Font (xml/json). Если неопределён или | ||
atlasData | object | Необязательный альфас шрифта Bitmap Font в виде строки (сериализованный xml/json). | ||
xSpacing | number | <optional> | 0 | Если вы хотите добавить дополнительное горизонтальное расстояние между символами, установите здесь пиксельное значение. |
ySpacing | number | <optional> | 0 | Если вы хотите добавить дополнительное вертикальное расстояние между строками, установите здесь пиксельное значение. |
Возвращаемое значение
Этот экземпляр загрузчика.
checkKeyExists(type, key) → {boolean}
Проверяет, есть ли файл/ресурс с определённым ключом в очереди загрузки.
Чтобы получить доступ к загруженному ресурсу, используйте Phaser.Cache, например Phaser.Cache#checkImageKey
Параметры
| Имя | Тип | Описание |
|---|---|---|
type | string | Тип ресурса, который нужно проверить. |
key | string | Ключ ресурса, который нужно проверить. |
Возвращаемое значение
Возвращает true, если существует, иначе возвращает false.
getAsset(type, key) → {any}
Находит файл/ресурс с определённым ключом.
Будут найдены только ресурсы в очереди загрузки.
Параметры
| Имя | Тип | Описание |
|---|---|---|
type | string | Тип ресурса, который нужно проверить. |
key | string | Ключ ресурса, который нужно проверить. |
Возвращаемое значение
Возвращает объект, если найден, который содержит 2 свойства: index и file; в противном случае возвращается значение, отличное от true.
Индекс может измениться и должен использоваться только сразу после этого вызова.
- Source code: loader/Loader.js (Line 441)
- Source code: loader/Loader.js (Line 406)
- Source code: loader/Loader.js (Line 693)
- Source code: loader/Loader.js (Line 722)
- Source code: loader/Loader.js (Line 794)
getAssetIndex(type, key) → {number}
Получить индекс элемента очереди загрузки файла/актива с определённым ключом.
Будут найдены только активы, находящиеся в очереди загрузки файла.
Parameters
| Name | Type | Описание |
|---|---|---|
type | string | Тип актива, который нужно проверить. |
key | string | Ключ актива, который нужно проверить. |
Returns
Индекс этого ключа в списке файлов или -1, если не найден.
Индекс может изменяться и следует использовать только сразу после этого вызова.
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 файла изображения. Если не определён или | |
overwrite | boolean | <optional> | false | Если в очереди уже существует незагруженный файл с совпадающим ключом, эта запись перезапишет его. |
Returns
Этот экземпляр загрузчика.
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. Если не определён или |
Returns
Этот экземпляр загрузчика.
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. Если не определён или | |
overwrite | boolean | <optional> | false | Если в очереди уже существует незагруженный файл с совпадающим ключом, эта запись перезапишет его. |
Returns
Этот экземпляр загрузчика.
pack(key, url, data, callbackContext) → {Phaser.Loader}
Добавить ресурс пакета JSON ('packfile') в загрузчик.
Файл пакета — это файл JSON, содержащий список активов, которые нужно загрузить.
См. пример 'loader/asset pack' в репозитории примеров Phaser.
Пакеты всегда добавляются перед первым файлом, который не является пакетом и не загружен/загружается.
Это означает, что все пакеты, добавленные до начала загрузки, добавляются в начало
очереди файла в порядке добавления.
Ключ должен быть уникальной строкой. Он используется для добавления файла в Phaser.Cache после успешной загрузки.
URL файла пакета может быть относительным или абсолютным. Если URL относительный, к нему будут добавлены значения Loader.baseURL и Loader.path.
Parameters
- Исходный код: loader/Loader.js (Строка 613)
- Исходный код: loader/Loader.js (Строка 1246)
- Внутренний:
- Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
- Исходный код: loader/Loader.js (Строка 1722)
- Внутренний:
- Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
- Исходный код: loader/Loader.js (Строка 1698)
- Внутренний:
- Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
- Исходный код: loader/Loader.js (Строка 597)
- Внутренний:
- Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
- Исходный код: loader/Loader.js (Строка 465)
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
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, требуют контекста для своих обратных вызовов. Передайте контекст здесь. |
Возвращает
Этот экземпляр загрузчика.
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 файла данных физики. Если не определен или | |
data | object | string | <optional> | Необязательный объект данных в формате JSON. Если задан, URL игнорируется, и этот объект JSON используется для данных физики вместо него. | |
format | string | <optional> | Phaser.Physics.LIME_CORONA_JSON | Формат данных физики. |
Возвращает
Этот экземпляр загрузчика.
<internal> removeAll()
Удаляет все запросы загрузки файлов - этого недостаточно для остановки текущей загрузки. Используйте reset вместо этого.
<internal> removeFile(type, key)
Удаляет файл/ресурс из очереди загрузки.
Файл, который загружается или начал загружаться, удалить нельзя.
Параметры
| Имя | Тип | Описание |
|---|---|---|
type | string | Тип ресурса, который нужно добавить в список (изображение, аудио, xml и т.д.). |
key | string | Ключ файла, который нужно удалить. |
<internal> replaceInFileList(type, key, url, properties)
Внутренняя функция, которая заменяет существующую запись в списке файлов новой. Не вызывать напрямую.
Параметры
| Имя | Тип | Описание |
|---|---|---|
type | string | Тип ресурса, который нужно добавить в список (изображение, аудио, xml и т.д.). |
key | string | Уникальный ключ Cache ID этого ресурса. |
url | string | URL, из которого будет загружен ресурс. |
properties | object | Дополнительные свойства, необходимые для загрузки файла. |
<internal> reset(hard, clearEvents)
Сбросить загрузчик и очистить все размещенные активы. Если Loader.resetLocked равно true, эта операция будет прервана.
Это приведет к прерыванию загрузки и очистке всех размещенных активов.
Необязательно, вы можете очистить все связанные события.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
hard | boolean | <optional> | false | Если true, то предварительно загруженные спрайты и другие артефакты также могут быть очищены. |
clearEvents | boolean | <optional> | false | Если true, то на всех сигналах Loader будет вызван removeAll. |
- Внутреннее:
- Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
- Исходный код: loader/Loader.js (Строка 373)
- Исходный код: loader/Loader.js (Строка 876)
- Исходный код: loader/Loader.js (Строка 338)
- Исходный код: loader/Loader.js (Строка 822)
<internal> resize()
Вызывается автоматически менеджером масштабирования (ScaleManager) при изменении размера игры в режиме масштабирования RESIZE.
Это можно использовать для корректировки размера предварительно загружаемого спрайта, например.
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. Если не определен или | |
callback | function | <optional> | (none) | Необязательный обратный вызов, который будет вызван после загрузки тега скрипта, чтобы вы могли выполнить дополнительную обработку. |
callbackContext | object | <optional> | (загрузчик) | Контекст, в котором будет применен обратный вызов. Если не указан, в качестве контекста будет использован загрузчик Phaser. |
Возвращает
Экземпляр загрузчика (Loader).
setPreloadSprite(sprite, direction)
Устанавливает спрайт в качестве спрайта предварительной загрузки, передав его в этот метод.
Спрайт предварительной загрузки будет изменять обрезку ширины или высоты в зависимости от процента загрузки в режиме реального времени.
Это позволяет легко создавать индикаторы загрузки для игр.
Спрайт автоматически станет видимым при вызове этого метода.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
sprite | Phaser.Sprite | Phaser.Image | Спрайт или изображение, которые будут обрезаться во время загрузки. | ||
direction | number | <optional> | 0 | Значение 0 означает, что спрайт будет обрезаться по горизонтали, а значение 1 — по вертикали. |
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 файла фрагментного шейдера. Если не определен или | |
overwrite | boolean | <optional> | false | Если загружаемый файл с соответствующим ключом уже существует в очереди, эта запись заменит его. |
Возвращает
Экземпляр загрузчика (Loader).
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.
Параметры
- Исходный код: loader/Loader.js (Строка 949)
- Исходный код: loader/Loader.js (Строка 1735)
- Исходный код: loader/Loader.js (Строка 767)
- Исходный код: loader/Loader.js (Строка 1165)
- Внутреннее:
- Этот член внутренний (защищенный) и может быть изменён или удалён в будущем.
- Исходный код: loader/Loader.js (Строка 2988)
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
key | string | Уникальный ключ актива файла таблицы. | ||
url | string | URL файла спрайт-листа. Если не определено или | ||
frameWidth | number | Ширина в пикселях одного кадра в спрайт-листе. | ||
frameHeight | number | Высота в пикселях одного кадра в спрайт-листе. | ||
frameMax | number | <optional> | -1 | Количество кадров в спрайт-листе. Если не указано, вся картинка будет разделена на кадры. |
margin | number | <optional> | 0 | Если кадры нарисованы с отступом, укажите его величину здесь. |
spacing | number | <optional> | 0 | Если между кадрами есть отступ, укажите его величину здесь. |
Возвращает
Этот экземпляр Loader.
start()
Начать загрузку активов. Обычно вам не нужно вызывать это самим, так как StateManager сделает это.
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 текстового файла. Если не определено или | |
overwrite | boolean | <optional> | false | Если в очереди уже существует не загруженный файл с совпадающим ключом, эта запись перезапишет его. |
Возвращает
Этот экземпляр Loader.
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 файла карты тайлов. Если не определено или | |
data | object | string | <optional> | Необязательный объект JSON. Если указан, URL игнорируется, и этот объект JSON используется вместо данных карты. | |
format | number | <optional> | Phaser.Tilemap.CSV | Формат данных карты. Либо Phaser.Tilemap.CSV, либо Phaser.Tilemap.TILED_JSON. |
Возвращает
Этот экземпляр Loader.
<internal> totalLoadedFiles() → {number}
Возвращает количество файлов, которые уже загружены, даже если они завершились ошибкой.
Возвращает
Количество файлов, которые уже загружены (даже если они завершились ошибкой)
<internal> totalLoadedPacks() → {number}
Возвращает количество наборов активов, которые уже загружены, даже если они завершились ошибкой.
Возвращает
- Внутреннее:
- Этот член является внутренним (защищенным) и может быть изменён или удалён в будущем.
- Исходный код: loader/Loader.js (Строка 3014)
- Внутреннее:
- Этот член является внутренним (защищенным) и может быть изменён или удалён в будущем.
- Исходный код: loader/Loader.js (Строка 3001)
- Внутреннее:
- Этот член является внутренним (защищенным) и может быть изменён или удалён в будущем.
- Исходный код: loader/Loader.js (Строка 3027)
- Внутреннее:
- Этот член является внутренним (защищенным) и может быть изменён или удалён в будущем.
- Исходный код: loader/Loader.js (Строка 2063)
- Исходный код: loader/Loader.js (Строка 1111)
- Исходный код: loader/Loader.js (Строка 1649)
Количество уже загруженных пакетов ресурсов (даже если произошла ошибка)
<внутреннее> totalQueuedFiles() → {число}
Возвращает количество файлов, ожидающих обработки в очереди загрузки. Это значение уменьшается по мере загрузки каждого файла из очереди.
Возвращает
Количество файлов, которые всё ещё остаются в очереди загрузки.
<внутреннее> totalQueuedPacks() → {число}
Возвращает количество пакетов ресурсов, ожидающих обработки в очереди загрузки. Это значение уменьшается по мере загрузки каждого пакета из очереди.
Возвращает
Количество пакетов ресурсов, которые всё ещё остаются в очереди загрузки.
<внутреннее> transformUrl(url, file) → {строка}
Преобразует URL ресурса.
Встроенная реализация добавляет префикс baseURL, если URL не начинается с http или //
Параметры
| Имя | Тип | Описание |
|---|---|---|
url | строка | Преобразуемый URL. |
file | объект | Объект файла, который преобразуется. |
Возвращает
Преобразованный URL. В редких случаях, когда URL не указан, возвращает false.
video(key, urls, loadEvent, asBlob) → {Phaser.Loader}
Добавляет видеофайл в текущую очередь загрузки.
Файл не загружается сразу после вызова этого метода. Файл добавляется в очередь для загрузки, когда начинается процесс загрузки.
Ключ должен быть уникальной строкой. Он используется для добавления файла в Phaser.Cache при успешной загрузке.
Получить файл можно с помощью Cache.getVideo(key).
URL может быть относительным или абсолютным. Если URL относительный, к нему будут добавлены значения Loader.baseURL и Loader.path.
Не нужно предварительно загружать видео, чтобы воспроизводить его в вашей игре. Подробности см. в Video.createVideoFromURL.
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
key | строка | Уникальный ключ видеофайла. | ||
urls | строка | Массив.<строка> | Массив.<объект> | Строка или массив URI или пар | ||
loadEvent | строка | <необязательно> | 'canplaythrough' | Это устанавливает событие источника видео для прослушивания перед тем, как загрузка будет считаться завершённой. |
asBlob | логическое | <необязательно> | false | Видеофайлы могут быть загружены путём создания элемента видео, в котором устанавливается свойство src. |
Возвращает
Этот экземпляр Loader.
withSyncPoints(callback, callbackContext) → {Phaser.Loader}
Добавляет точку синхронизации к ресурсам/файлам, добавленным в предоставленном обратном вызове.
Точка синхронизации обозначает, что ресурс обязательно должен быть полностью загружен перед загрузкой последующих ресурсов.
Ресурс, помеченный как точка синхронизации, не обязательно ожидает загрузки предыдущих ресурсов (если они не являются точками синхронизации). Ресурсы, такие как пакеты, могут загружаться параллельно с точками синхронизации, пока они не завершат свою загрузку.
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
callback | функция | Обратный вызов, которому передаётся один аргумент: загрузчик. | ||
callbackContext | объект | <необязательно> | (загрузчик) | Контекст обратного вызова. |
Возвращает
Этот экземпляр Loader.
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.
Параметры
- Исходный код: loader/Loader.js (Строка 849)
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
key | строка | Уникальный ключ ресурса xml-файла. | ||
url | строка | <необязательно> | URL XML-файла. Если не определено или | |
overwrite | логическое | <необязательно> | false | Если загруженный файл с совпадающим ключом уже существует в очереди, эта запись его перезапишет. |
Возвращает
Экземпляр этого загрузчика.
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.Loader.html