Класс: Phaser.Cache

Конструктор

new Cache(game)

Параметры

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

Публичные свойства

[статично] BINARY : число

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

[статично] BITMAPDATA : число

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

[статично] BITMAPFONT : число

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

[статично] CANVAS : число

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

[статично] DEFAULT : PIXI.Texture

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

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

[статично] IMAGE : число

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

[статично] JSON : число

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

[статично] MISSING : PIXI.Texture

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

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

[статично] PHYSICS : число

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

[статично] RENDER_TEXTURE : число

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

[статично] SHADER : число

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

[статично] SOUND : число

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

[статично] TEXT : число

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

[статично] TEXTURE : число

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

[статично] TILEMAP : число

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

[статично] VIDEO : число

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

[статично] XML : число

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

autoResolveURL : логическое

Автоматически разрешить URL ресурсов до абсолютных путей для использования с методом Cache.getURL.

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

game : Phaser.Game

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

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

onSoundUnlock : Phaser.Signal

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

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

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

addBinary(key, binaryData)

Добавить бинарный объект в кэш.

Параметры

Имя	Тип	Описание
key	string	Ключ, под которым этот актив будет сохранён в кэше. Он должен быть уникальным в рамках этого кэша.
binaryData	object	Бинарный объект, который нужно добавить в кэш.

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

addBitmapData(key, bitmapData, frameData) → {Phaser.BitmapData}

Добавить объект BitmapData в кэш.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	string			Ключ, под которым этот актив будет сохранён в кэше. Он должен быть уникальным в рамках этого кэша.
bitmapData	Phaser.BitmapData			Объект BitmapData, который нужно добавить в кэш.
frameData	Phaser.FrameData | null	<необязательно>	(автосоздание)	Необязательный набор FrameData, связанный с заданным BitmapData. Если не указан (или undefined) создаётся новый объект FrameData, содержащий фрейм Bitmap. Если null указан, то FrameData не создаётся.

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

Phaser.BitmapData -

Объект BitmapData, который нужно добавить в кэш.

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

addBitmapFont(key, url, data, atlasData, atlasType, xSpacing, ySpacing)

Добавить новый Bitmap шрифт в кэш.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	string			Ключ, под которым этот актив будет сохранён в кэше. Он должен быть уникальным в рамках этого кэша.
url	string			URL ресурса, с которого был загружен актив. Если актив был загружен не из внешнего источника, то значение null.
data	object			Дополнительные данные шрифта.
atlasData	object			Данные фреймов карты текстур.
atlasType	string	<необязательно>	'xml'	Формат карты текстур ( 'json' или 'xml' ).
xSpacing	number	<необязательно>	0	Если необходимо добавить дополнительный горизонтальный отступ между символами, установите здесь пиксельное значение.
ySpacing	number	<необязательно>	0	Если необходимо добавить дополнительный вертикальный отступ между строками, установите здесь пиксельное значение.

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

addCanvas(key, canvas, context)

Добавить новый объект холста в кэш.

Параметры

Имя	Тип	Аргумент	Описание
key	string		Ключ, под которым этот актив будет сохранён в кэше. Он должен быть уникальным в рамках этого кэша.
canvas	HTMLCanvasElement		Элемент DOM холста.
context	CanvasRenderingContext2D	<необязательно>	Контекст элемента холста. Если не указано, по умолчанию getContext('2d').

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

<internal> addDefaultImage()

Добавляет изображение по умолчанию, используемое в особых случаях, таких как WebGL-фильтры.
Использует специальный зарезервированный ключ __default.
Этот метод вызывается автоматически при создании кэша.
Это изображение пропускается при вызове Cache.destroy, из-за внутренних требований.

Внутренний:

• Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.

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

addImage(key, url, data) → {object}

Добавляет изображение в кэш. Файл должен быть уже загружен, обычно через Phaser.Loader, но также может быть загружен в DOM.
Если изображение с тем же ключом уже существует в кэше, оно удаляется и уничтожается, а новое изображение вставляется на его место.

Параметры

Имя	Тип	Описание
key	string	Ключ, под которым этот актив будет сохранён в кэше. Он должен быть уникальным в рамках этого кэша.
url	string	URL ресурса, с которого был загружен актив. Если актив был загружен не из внешнего источника, то значение null.
data	object	Дополнительные данные изображения.

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

object -

Полный объект изображения, добавленный в кэш.

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

addJSON(key, url, data)

Добавить новый объект json в кэш.

Параметры

Имя	Тип	Описание
key	string	Ключ, под которым этот актив будет сохранён в кэше. Он должен быть уникальным в рамках этого кэша.
url	string	URL ресурса, с которого был загружен актив. Если актив был загружен не из внешнего источника, то значение null.
data	object	Дополнительные данные json.

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

<internal> addMissingImage()

Добавляет изображение, используемое при ошибке/отсутствии ключа.
Использует специальный зарезервированный ключ __missing.
Этот метод вызывается автоматически при создании кэша.
Это изображение пропускается, когда вызывается Cache.destroy, из-за внутренних требований.

Внутреннее:

• Этот член является внутренним (защищенным) и может быть изменён или удалён в будущем.

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

addPhysicsData(key, url, JSONData, format)

Добавляет новый объект данных физики в кэш.

Параметры

Имя	Тип	Описание
key	string	Ключ, под которым этот актив будет сохранён в кэше. Он должен быть уникальным в пределах этого кэша.
url	string	URL, откуда был загружен актив. Если актив не загружался извне, установите значение null.
JSONData	object	Объект данных физики (файл JSON).
format	number	Формат данных физики.

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

addRenderTexture(key, texture)

Добавляет новый Phaser.RenderTexture в кэш.

Параметры

Имя	Тип	Описание
key	string	Ключ, под которым этот актив будет сохранён в кэше. Он должен быть уникальным в пределах этого кэша.
texture	Phaser.RenderTexture	Текстура, используемая в качестве основы RenderTexture.

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

addShader(key, url, data)

Добавляет фрагментный шейдер в кэш. Файл должен быть загружен, обычно через Phaser.Loader.

Параметры

Имя	Тип	Описание
key	string	Ключ, под которым этот актив будет сохранён в кэше. Он должен быть уникальным в пределах этого кэша.
url	string	URL, откуда был загружен актив. Если актив не загружался извне, установите значение null.
data	object	Дополнительные данные шейдера.

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

addSound(key, url, data, webAudio, audioTag)

Добавляет звуковой файл в кэш. Файл должен быть загружен, обычно через Phaser.Loader.

Параметры

Имя	Тип	Описание
key	string	Ключ, под которым этот актив будет сохранён в кэше. Он должен быть уникальным в пределах этого кэша.
url	string	URL, откуда был загружен актив. Если актив не загружался извне, установите значение null.
data	object	Дополнительные данные звука.
webAudio	boolean	Истина, если файл использует веб-аудио.
audioTag	boolean	Истина, если файл использует устаревший HTML-аудио.

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

addSpriteSheet(key, url, data, frameWidth, frameHeight, frameMax, margin, spacing)

Добавляет новый спрайт-лист в кэш.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	string			Ключ, под которым этот актив будет сохранён в кэше. Он должен быть уникальным в пределах этого кэша.
url	string			URL, откуда был загружен актив. Если актив не загружался извне, установите значение null.
data	object			Дополнительные данные спрайт-листа.
frameWidth	number			Ширина спрайт-листа.
frameHeight	number			Высота спрайт-листа.
frameMax	number	<optional>	-1	Количество кадров в спрайт-листе. Если -1, то лист делится равномерно.
margin	number	<optional>	0	Если кадры отрисованы с отступом, укажите его здесь.
spacing	number	<optional>	0	Если между кадрами есть отступ, укажите его здесь.

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

addText(key, url, data)

Добавляет новые данные текста.

Параметры

Имя	Тип	Описание
key	string	Ключ, под которым этот актив будет сохранён в кэше. Он должен быть уникальным в пределах этого кэша.
url	string	URL, откуда был загружен актив. Если актив не загружался извне, установите значение null.
data	object	Дополнительные данные текста.

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

addTextureAtlas(key, url, data, atlasData, format)

Добавляет новый атлас текстур в кэш.

Параметры

Имя	Тип	Описание
key	string	Ключ, под которым этот ресурс будет храниться в кэше. Он должен быть уникальным в пределах этого кэша.
url	string	URL, с которого был загружен ресурс. Если ресурс не загружался из внешнего источника, значение устанавливается в null.
data	object	Дополнительные данные атласа текстур.
atlasData	object	Данные кадров атласа текстур.
format	number	Формат атласа текстур.

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

addTilemap(key, url, mapData, format)

Добавить новую карту плиток в кэш.

Параметры

Имя	Тип	Описание
key	string	Ключ, под которым этот ресурс будет храниться в кэше. Он должен быть уникальным в пределах этого кэша.
url	string	URL, с которого был загружен ресурс. Если ресурс не загружался из внешнего источника, значение устанавливается в null.
mapData	object	Объект данных карты плиток (файл CSV или JSON).
format	number	Формат данных карты плиток.

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

addVideo(key, url, data, isBlob)

Добавляет видеофайл в кэш. Файл должен быть уже загружен, обычно через Phaser.Loader.

Параметры

Имя	Тип	Описание
key	string	Ключ, под которым этот ресурс будет храниться в кэше. Он должен быть уникальным в пределах этого кэша.
url	string	URL, с которого был загружен ресурс. Если ресурс не загружался из внешнего источника, значение устанавливается в null.
data	object	Дополнительные данные видео.
isBlob	boolean	Истинно, если файл предварительно загружен через xhr, и параметр data является объектом Blob. Ложно, если вместо этого был создан тег Video.

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

addXML(key, url, data)

Добавить новый XML-объект в кэш.

Параметры

Имя	Тип	Описание
key	string	Ключ, под которым этот ресурс будет храниться в кэше. Он должен быть уникальным в пределах этого кэша.
url	string	URL, с которого был загружен ресурс. Если ресурс не загружался из внешнего источника, значение устанавливается в null.
data	object	Дополнительные текстовые данные.

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

checkBinaryKey(key) → {boolean}

Проверяет, существует ли заданный ключ в кэше двоичных данных.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса в кэше.

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

boolean -

Истина, если ключ существует в кэше, иначе ложь.

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

checkBitmapDataKey(key) → {boolean}

Проверяет, существует ли заданный ключ в кэше BitmapData.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса в кэше.

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

boolean -

Истина, если ключ существует в кэше, иначе ложь.

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

checkBitmapFontKey(key) → {boolean}

Проверяет, существует ли заданный ключ в кэше BitmapFont.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса в кэше.

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

boolean -

Истина, если ключ существует в кэше, иначе ложь.

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

checkCanvasKey(key) → {boolean}

Проверяет, существует ли заданный ключ в кэше Canvas.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса в кэше.

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

boolean -

Истина, если ключ существует в кэше, иначе ложь.

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

checkImageKey(key) → {boolean}

Проверяет, существует ли заданный ключ в кэше изображений. Обратите внимание, что это также включает атласы текстур, спрайт-листы и ретро шрифты.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса в кэше.

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

boolean -

Истина, если ключ существует в кэше, иначе ложь.

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

checkJSONKey(key) → {boolean}

Проверяет, существует ли данный ключ в JSON-кэше.

Параметры

Name	Type	Description
key	string	Ключ ресурса в кэше.

Возвращает

boolean -

True, если ключ существует в кэше, иначе false.

Source code: loader/Cache.js (Line 954)

checkKey(cache, key) → {boolean}

Проверяет, существует ли ключ для данного типа объекта кэша.

Параметры

Name	Type	Description
cache	integer	Кэш для поиска. Одна из констант Cache, таких как Phaser.Cache.IMAGE или Phaser.Cache.SOUND.
key	string	Ключ ресурса в кэше.

Возвращает

boolean -

True, если ключ существует, иначе false.

Source code: loader/Cache.js (Line 784)

checkPhysicsKey(key) → {boolean}

Проверяет, существует ли данный ключ в кэше физики.

Параметры

Name	Type	Description
key	string	Ключ ресурса в кэше.

Возвращает

boolean -

True, если ключ существует в кэше, иначе false.

Source code: loader/Cache.js (Line 889)

checkRenderTextureKey(key) → {boolean}

Проверяет, существует ли данный ключ в кэше текстур рендеринга.

Параметры

Name	Type	Description
key	string	Ключ ресурса в кэше.

Возвращает

boolean -

True, если ключ существует в кэше, иначе false.

Source code: loader/Cache.js (Line 1006)

checkShaderKey(key) → {boolean}

Проверяет, существует ли данный ключ в кэше фрагментных шейдеров.

Параметры

Name	Type	Description
key	string	Ключ ресурса в кэше.

Возвращает

boolean -

True, если ключ существует в кэше, иначе false.

Source code: loader/Cache.js (Line 993)

checkSoundKey(key) → {boolean}

Проверяет, существует ли данный ключ в кэше звуков.

Параметры

Name	Type	Description
key	string	Ключ ресурса в кэше.

Возвращает

boolean -

True, если ключ существует в кэше, иначе false.

Source code: loader/Cache.js (Line 863)

checkTextKey(key) → {boolean}

Проверяет, существует ли данный ключ в кэше текста.

Параметры

Name	Type	Description
key	string	Ключ ресурса в кэше.

Возвращает

boolean -

True, если ключ существует в кэше, иначе false.

Source code: loader/Cache.js (Line 876)

checkTextureKey(key) → {boolean}

Проверяет, существует ли данный ключ в кэше текстур.

Параметры

Name	Type	Description
key	string	Ключ ресурса в кэше.

Возвращает

boolean -

True, если ключ существует в кэше, иначе false.

Source code: loader/Cache.js (Line 850)

checkTilemapKey(key) → {boolean}

Проверяет, существует ли данный ключ в кэше тайлмапов.

Параметры

Name	Type	Description
key	string	Ключ ресурса в кэше.

Возвращает

boolean -

True, если ключ существует в кэше, иначе false.

Source code: loader/Cache.js (Line 902)

checkURL(url) → {boolean}

Проверяет, был ли данный URL загружен в кэш.
Этот метод будет работать только в том случае, если Cache.autoResolveURL был установлен в true до начала любой предварительной загрузки.
Метод выполнит вызов DOM src для заданного URL, поэтому имейте в виду это для определенных типов файлов, таких как звуковые файлы в Firefox,
что может привести к случаям двойной загрузки.

Параметры

Name	Type	Description
url	string	URL для проверки в кэше.

Возвращает

boolean -

True, если URL существует, иначе false.

Source code: loader/Cache.js (Line 803)

checkVideoKey(key) → {boolean}

Проверяет, существует ли данный ключ в кэше видео.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса в кэше.

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

boolean -

True, если ключ существует в кэше, иначе false.

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

checkXMLKey(key) → {boolean}

Проверяет, существует ли заданный ключ в кэше XML.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса в кэше.

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

boolean -

True, если ключ существует в кэше, иначе false.

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

<internal> clearGLTextures()

Очищает все текстуры GL из изображений, хранящихся в кэше.
Это вызывается автоматически при потере и последующем восстановлении контекста WebGL.

Внутреннее:

• Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.

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

decodedSound(key, data)

Добавляет новый декодированный звук.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса в кэше.
data	object	Дополнительные данные звука.

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

destroy()

Очищает кэш. Удаляет все ссылки на локальные объекты кэша.
Если объект в кэше имеет метод destroy, он также будет вызван.

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

getBaseTexture(key, cache) → {PIXI.BaseTexture}

Получает PIXI.BaseTexture по ключу из заданного кэша.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	string			Ключ ресурса изображения, для которого требуется BaseTexture.
cache	integer	<optional>	Phaser.Cache.IMAGE	Кэш для поиска элемента.

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

PIXI.BaseTexture -

Объект BaseTexture.

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

getBinary(key) → {object}

Получает бинарный объект из кэша.

Объект ищется по заданному ключу.

Примечание: Если объект не найден, отображается сообщение console.warn.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса для извлечения из кэша.

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

object -

Объект бинарных данных.

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

getBitmapData(key) → {Phaser.BitmapData}

Получает объект BitmapData из кэша.

Объект ищется по заданному ключу.

Примечание: Если объект не найден, отображается сообщение console.warn.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса для извлечения из кэша.

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

Phaser.BitmapData -

Запрошенный объект BitmapData, если найден, иначе null.

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

getBitmapFont(key) → {Phaser.BitmapFont}

Получает объект BitmapFont из кэша.

Объект ищется по заданному ключу.

Примечание: Если объект не найден, отображается сообщение console.warn.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса для извлечения из кэша.

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

Phaser.BitmapFont -

Запрошенный объект BitmapFont, если найден, иначе null.

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

getCanvas(key) → {object}

Получает объект Canvas из кэша.

Объект ищется по заданному ключу.

Примечание: Если объект не найден, отображается сообщение console.warn.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса для извлечения из кэша.

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

object -

Объект canvas или null, если по ключу ничего не найдено.

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

getFrame(key, cache) → {Phaser.Frame}

Получает отдельный кадр по ключу. Это делается только для получения созданного по умолчанию кадра для изображения без атласа/спрайт-шита.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	string			Ключ ресурса данных кадра, который нужно извлечь из кэша.
cache	integer	<optional>	Phaser.Cache.IMAGE	Кэш, в котором нужно искать элемент.

Возвращает

Phaser.Frame -

Данные кадра.

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

getFrameByIndex(key, index, cache) → {Phaser.Frame}

Получить один кадр из набора данных кадров по ключу.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	string			Ключ ресурса данных кадра, который нужно извлечь из кэша.
index	number			Индекс кадра, который нужно получить.
cache	integer	<optional>	Phaser.Cache.IMAGE	Кэш, в котором нужно искать. Одно из констант кэша, таких как Phaser.Cache.IMAGE или Phaser.Cache.SOUND.

Возвращает

Phaser.Frame -

Объект кадра.

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

getFrameByName(key, name, cache) → {Phaser.Frame}

Получить один кадр из набора данных кадров по ключу.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	string			Ключ ресурса данных кадра, который нужно извлечь из кэша.
name	string			Имя кадра, который нужно получить.
cache	integer	<optional>	Phaser.Cache.IMAGE	Кэш, в котором нужно искать. Одно из констант кэша, таких как Phaser.Cache.IMAGE или Phaser.Cache.SOUND.

Возвращает

Phaser.Frame -

Объект кадра.

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

getFrameCount(key, cache) → {number}

Получить общее количество кадров, содержащихся в объекте FrameData, заданном данным ключом.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	string			Ключ ресурса FrameData, который нужно получить.
cache	integer	<optional>	Phaser.Cache.IMAGE	Кэш, в котором нужно искать элемент.

Возвращает

number -

Количество кадров. 0, если изображение не найдено.

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

getFrameData(key, cache) → {Phaser.FrameData}

Получает объект Phaser.FrameData из кэша изображений.

Объект ищется по заданному ключу.

Примечание: Если объект не найден, отображается сообщение console.warn.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	string			Ключ ресурса данных кадра, который нужно извлечь из кэша.
cache	integer	<optional>	Phaser.Cache.IMAGE	Кэш, в котором нужно искать элемент.

Возвращает

Phaser.FrameData -

Данные кадра.

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

getImage(key, full) → {Image}

Получает объект Image из кэша. Возвращает объект DOM Image, а не Phaser.Image.

Объект ищется по заданному ключу.

Примечание: Если объект не найден, отображается сообщение console.warn.

Ищется только кэш Image, который включает изображения, загруженные через Loader.image, спрайт-листы и атласы текстур.

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

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	string	<optional>		Ключ ресурса для извлечения из кэша. Если не указан или равен null, возвращается изображение по умолчанию. Если указан, но не найден в кэше, выводится предупреждение, и возвращается изображение, отсутствующее в кэше.
full	boolean	<optional>	false	Если true, возвращается полный объект изображения; если false, возвращается только объект HTML Image.

Возвращает

Image -

Объект Image, если он найден в кэше; в противном случае null. Если full было true, возвращается JavaScript-объект.

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

getItem(key, cache, method, property) → {object}

Получить элемент из кэша на основе заданного ключа и свойства.

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

Параметры

Имя	Тип	Аргумент	Описание
key	строка		Ключ ресурса в кэше.
cache	целое число		Кэш для поиска. Один из констант Кэша, например Phaser.Cache.IMAGE или Phaser.Cache.SOUND.
method	строка	<необязательно>	Имя строки метода вызова getItem. Может быть пустым, в этом случае предупреждение в консоль не выводится.
property	строка	<необязательно>	Если вам нужна определённая свойство из элемента кэша, укажите его здесь.

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

объект -

Элемент кэша, если найден, в противном случае null. Если ключ неверный и method установлено, то в консоль выводится console.warn.

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

getJSON(key, clone) → {объект}

Получает JSON-объект из кэша.

Объект ищется по заданному ключу.

Примечание: Если объект не найден, выводится сообщение console.warn.

Вы можете вернуть объект по ссылке (по умолчанию) или скопированную копию,
установив аргумент clone в значение true.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	строка			Ключ ресурса для извлечения из кэша.
clone	логическое	<необязательно>	false	Возвратить копию исходного объекта (true) или ссылку на него (false)?

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

объект -

JSON-объект или массив, если ключ указывает на свойство массива. Если свойство не найдено, возвращается null.

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

getKeys(cache) → {Массив}

Получает все ключи, используемые в запрошенном кэше.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
cache	целое число	<необязательно>	Phaser.Cache.IMAGE	Кэш, из которого необходимо получить ключи. Может быть любой из констант кэша, например Phaser.Cache.IMAGE, Phaser.Cache.SOUND и т.д.

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

Массив -

Массив ключей в запрошенном кэше.

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

getPhysicsData(key, object, fixtureKey) → {объект}

Получает объект Physics Data из кэша.

Объект ищется по заданному ключу.

Примечание: Если объект не найден, выводится сообщение console.warn.

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

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	строка			Ключ ресурса для извлечения из кэша.
object	строка	<необязательно>	null	Если указано, будет возвращён только физический объект, который является частью данного ключа; если null, будут возвращены все.
fixtureKey	строка			Ключ приспособления внутри объекта. Этот ключ может быть установлен для каждого приспособления с помощью экспортера Phaser.

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

объект -

Запрошенные данные физического объекта, если найдены.

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

getRenderTexture(key) → {Объект}

Получает объект RenderTexture из кэша.

Объект ищется по заданному ключу.

Примечание: Если объект не найден, выводится сообщение console.warn.

Параметры

Имя	Тип	Описание
key	строка	Ключ ресурса для извлечения из кэша.

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

Объект -

Объект с Phaser.RenderTexture и Phaser.Frame.

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

getShader(key) → {строка}

Получает фрагментный шейдер из кэша.

Объект ищется по заданному ключу.

Примечание: Если объект не найден, выводится сообщение console.warn.

Параметры

Имя	Тип	Описание
key	строка	Ключ ресурса для извлечения из кэша.

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

строка -

Объект шейдера.

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

getSound(key) → {Phaser.Sound}

Получает объект Phaser.Sound из кэша.

Объект ищется по заданному ключу.

Примечание: Если объект не найден, выводится сообщение console.warn.

Параметры

Имя	Тип	Описание
key	строка	Ключ ресурса для извлечения из кэша.

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

Phaser.Sound -

Объект звука.

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

getSoundData(key) → {объект}

Получает необработанный объект данных звука из кэша.

Объект ищется по заданному ключу.

Примечание: Если объект не найден, выводится сообщение console.warn.

Параметры

Имя	Тип	Описание
key	строка	Ключ ресурса для извлечения из кэша.

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

object -

Данные звука.

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

getText(key) → {object}

Получает объект Text из кэша.

Объект ищется по заданному ключу.

Примечание: Если объект не найден, отображается сообщение console.warn.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса для извлечения из кэша.

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

object -

Данные текста.

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

getTextureFrame(key) → {Phaser.Frame}

Получить отдельный фрейм текстуры по ключу.

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

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса для извлечения из кэша.

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

Phaser.Frame -

Данные фрейма.

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

getTilemapData(key) → {object}

Получает объект данных карты тайлов из кэша. Он будет в формате CSV или JSON.

Объект ищется по заданному ключу.

Примечание: Если объект не найден, отображается сообщение console.warn.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса для извлечения из кэша.

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

object -

Необработанные данные карты тайлов в формате CSV или JSON.

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

getURL(url) → {object}

Получает кэшированный объект по URL.
Это возвращает значение только в том случае, если вы установили Cache.autoResolveURL в true до начала предварительной загрузки каких-либо ресурсов.
Учитывайте, что каждый вызов этой функции выполняет запрос DOM src, поэтому используйте с осторожностью и убедитесь в последствиях для ваших целевых браузеров/устройств.

Параметры

Имя	Тип	Описание
url	string	URL объекта, загруженного для получения из кэша.

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

object -

Кэшированный объект.

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

getVideo(key) → {Phaser.Video}

Получает объект Phaser.Video из кэша.

Объект ищется по заданному ключу.

Примечание: Если объект не найден, отображается сообщение console.warn.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса для извлечения из кэша.

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

Phaser.Video -

Объект видео.

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

getXML(key) → {object}

Получает объект XML из кэша.

Объект ищется по заданному ключу.

Примечание: Если объект не найден, отображается сообщение console.warn.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса для извлечения из кэша.

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

object -

Объект XML.

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

hasFrameData(key, cache) → {boolean}

Проверяет, существует ли FrameData для данного ключа в кэше изображений.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	string			Ключ ресурса данных фрейма для извлечения из кэша.
cache	integer	<необязательно>	Phaser.Cache.IMAGE	Кэш, в котором нужно искать элемент.

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

boolean -

True, если для данного ключа существуют данные фрейма в кэше, иначе false.

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

isSoundDecoded(key) → {boolean}

Проверяет, завершилась ли декодировка данного звука.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса в кэше.

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

boolean -

Состояние декодировки объекта Sound.

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

isSoundReady(key) → {boolean}

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

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса в кэше.

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

boolean -

True, если звук декодирован и устройство не заблокировано по касанию.

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

reloadSound(key)

Перезагрузить звуковой файл с сервера.

Parameters

Name	Type	Description
key	string	Ключ ресурса в кэше.

Source code: loader/Cache.js (Line 666)

reloadSoundComplete(key)

Генерирует событие onSoundUnlock, когда звук завершил перезагрузку.

Parameters

Name	Type	Description
key	string	Ключ ресурса в кэше.

Source code: loader/Cache.js (Line 691)

removeBinary(key)

Удаляет двоичный файл из кэша.

Обратите внимание, что это удаляет его только из Phaser.Cache. Если у вас все еще есть ссылки на данные где-либо еще,
то они сохранятся в памяти.

Parameters

Name	Type	Description
key	string	Ключ ресурса, который вы хотите удалить.

Source code: loader/Cache.js (Line 1747)

removeBitmapData(key)

Удаляет растровые данные из кэша.

Обратите внимание, что это удаляет его только из Phaser.Cache. Если у вас все еще есть ссылки на данные где-либо еще,
то они сохранятся в памяти.

Parameters

Name	Type	Description
key	string	Ключ ресурса, который вы хотите удалить.

Source code: loader/Cache.js (Line 1762)

removeBitmapFont(key)

Удаляет растровый шрифт из кэша.

Обратите внимание, что это удаляет его только из Phaser.Cache. Если у вас все еще есть ссылки на данные где-либо еще,
то они сохранятся в памяти.

Parameters

Name	Type	Description
key	string	Ключ ресурса, который вы хотите удалить.

Source code: loader/Cache.js (Line 1777)

removeCanvas(key)

Удаляет холст из кэша.

Обратите внимание, что это удаляет его только из Phaser.Cache. Если у вас все еще есть ссылки на данные где-либо еще,
то они сохранятся в памяти.

Parameters

Name	Type	Description
key	string	Ключ ресурса, который вы хотите удалить.

Source code: loader/Cache.js (Line 1641)

removeImage(key, destroyBaseTexture)

Удаляет изображение из кэша.

Вы можете дополнительно выбрать его уничтожение. Это вызывает BaseTexture.destroy.

Обратите внимание, что это удаляет его только из Phaser Cache. Если у вас все еще есть ссылки на данные где-либо еще,
то они сохранятся в памяти.

Parameters

Name	Type	Argument	Default	Description
key	string			Ключ ресурса, который вы хотите удалить.
destroyBaseTexture	boolean	<optional>	true	Следует ли также уничтожить BaseTexture, находящийся за этим изображением?

Source code: loader/Cache.js (Line 1656)

removeJSON(key)

Удаляет JSON-объект из кэша.

Обратите внимание, что это удаляет его только из Phaser.Cache. Если у вас все еще есть ссылки на данные где-либо еще,
то они сохранятся в памяти.

Parameters

Name	Type	Description
key	string	Ключ ресурса, который вы хотите удалить.

Source code: loader/Cache.js (Line 1792)

removePhysics(key)

Удаляет файл данных физики из кэша.

Обратите внимание, что это удаляет его только из Phaser.Cache. Если у вас все еще есть ссылки на данные где-либо еще,
то они сохранятся в памяти.

Parameters

Name	Type	Description
key	string	Ключ ресурса, который вы хотите удалить.

Source code: loader/Cache.js (Line 1717)

removeRenderTexture(key)

Удаляет текстуру рендеринга из кэша.

Обратите внимание, что это удаляет его только из Phaser.Cache. Если у вас все еще есть ссылки на данные где-либо еще,
то они сохранятся в памяти.

Parameters

Name	Type	Description
key	string	Ключ ресурса, который вы хотите удалить.

Source code: loader/Cache.js (Line 1852)

removeShader(key)

Удаляет шейдер из кэша.

Обратите внимание, что это удаляет его только из Phaser.Cache. Если у вас все еще есть ссылки на данные где-либо еще,
то они сохранятся в памяти.

Parameters

Name	Type	Description
key	string	Ключ ресурса, который вы хотите удалить.

Source code: loader/Cache.js (Line 1837)

removeSound(key)

Удаляет звук из кэша.

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

Обратите внимание, что это удаляет его только из Phaser.Cache. Если у вас все еще есть ссылки на данные где-либо еще,
то они сохранятся в памяти.

Parameters

Имя	Тип	Описание
key	string	Ключ ресурса, который вы хотите удалить.

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

removeSpriteSheet(key)

Удаляет спрайт-лист из кэша.

Обратите внимание, что это удаляет его только из кэша Phaser.Cache. Если у вас все еще есть ссылки на данные в других местах,
то они сохранятся в памяти.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса, который вы хотите удалить.

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

removeText(key)

Удаляет текстовый файл из кэша.

Обратите внимание, что это удаляет его только из кэша Phaser.Cache. Если у вас все еще есть ссылки на данные в других местах,
то они сохранятся в памяти.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса, который вы хотите удалить.

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

removeTextureAtlas(key)

Удаляет атлас текстур из кэша.

Обратите внимание, что это удаляет его только из кэша Phaser.Cache. Если у вас все еще есть ссылки на данные в других местах,
то они сохранятся в памяти.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса, который вы хотите удалить.

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

removeTilemap(key)

Удаляет карту тайлов из кэша.

Обратите внимание, что это удаляет его только из кэша Phaser.Cache. Если у вас все еще есть ссылки на данные в других местах,
то они сохранятся в памяти.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса, который вы хотите удалить.

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

removeVideo(key)

Удаляет видео из кэша.

Обратите внимание, что это удаляет его только из кэша Phaser.Cache. Если у вас все еще есть ссылки на данные в других местах,
то они сохранятся в памяти.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса, который вы хотите удалить.

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

removeXML(key)

Удаляет xml-объект из кэша.

Обратите внимание, что это удаляет его только из кэша Phaser.Cache. Если у вас все еще есть ссылки на данные в других местах,
то они сохранятся в памяти.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса, который вы хотите удалить.

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

updateFrameData(key, frameData, cache)

Заменяет набор frameData новым объектом Phaser.FrameData.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	string			Уникальный ключ, по которому вы будете ссылаться на этот объект.
frameData	number			Новый FrameData.
cache	integer	<optional>	Phaser.Cache.IMAGE	Кэш для поиска. Одно из констант Cache, таких как Phaser.Cache.IMAGE или Phaser.Cache.SOUND.

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

updateSound(key)

Обновляет объект звука в кэше.

Параметры

Имя	Тип	Описание
key	string	Ключ ресурса в кэше.

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