Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Cache . CacheManager

This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Cache . CacheManager

The Cache Manager is the global cache owned and maintained by the Game instance.

Various systems, such as the file Loader, rely on this cache in order to store the files it has loaded. The manager itself doesn't store any files, but instead owns multiple BaseCache instances, one per type of file. You can also add your own custom caches.

Constructor:

new CacheManager(game)

Parameters:

name type description
game Phaser.Game

A reference to the Phaser.Game instance that owns this CacheManager.

Since: 3.0.0
Source: src/cache/CacheManager.js (Line 11)

Members

Description:

A Cache storing all non-streaming audio files, typically added via the Loader.

Type:
Since: 3.0.0
Source: src/cache/CacheManager.js (Line 88)
Focus
Focus

Description:

A Cache storing all binary files, typically added via the Loader.

Type:
Since: 3.0.0
Source: src/cache/CacheManager.js (Line 42)
Focus
Focus

Description:

A Cache storing all bitmap font data files, typically added via the Loader. Only the font data is stored in this cache, the textures are part of the Texture Manager.

Type:
Since: 3.0.0
Source: src/cache/CacheManager.js (Line 51)
Focus
Focus
custom: Object.<Phaser.Cache.BaseCache>
Focus
Focus

Description:

An object that contains your own custom BaseCache entries. Add to this via the addCustom method.

Type:
Since: 3.0.0
Focus
Focus
<protected> game: Phaser.Game
Focus
Focus

Description:

A reference to the Phaser.Game instance that owns this CacheManager.

Type:
Since: 3.0.0
Source: src/cache/CacheManager.js (Line 32)
Focus
Focus

Description:

A Cache storing all html files, typically added via the Loader.

Type:
Since: 3.12.0
Focus
Focus

Description:

A Cache storing all JSON data files, typically added via the Loader.

Type:
Since: 3.0.0
Source: src/cache/CacheManager.js (Line 61)
Focus
Focus

Description:

A Cache storing all WaveFront OBJ files, typically added via the Loader.

Type:
Since: 3.0.0
Focus
Focus

Description:

A Cache storing all physics data files, typically added via the Loader.

Type:
Since: 3.0.0
Source: src/cache/CacheManager.js (Line 70)
Focus
Focus

Description:

A Cache storing all shader source files, typically added via the Loader.

Type:
Since: 3.0.0
Source: src/cache/CacheManager.js (Line 79)
Focus
Focus

Description:

A Cache storing all text files, typically added via the Loader.

Type:
Since: 3.0.0
Focus
Focus

Description:

A Cache storing all tilemap data files, typically added via the Loader. Only the data is stored in this cache, the textures are part of the Texture Manager.

Type:
Since: 3.0.0
Focus
Focus

Description:

A Cache storing all non-streaming video files, typically added via the Loader.

Type:
Since: 3.20.0
Source: src/cache/CacheManager.js (Line 97)
Focus
Focus

Description:

A Cache storing all xml data files, typically added via the Loader.

Type:
Since: 3.0.0
Focus
Focus

Methods

addCustom(key)
Focus
Focus

Description:

Add your own custom Cache for storing your own files. The cache will be available under Cache.custom.key. The cache will only be created if the key is not already in use.

Parameters:

name type description
key string

The unique key of your custom cache.

Returns:
Description:

A reference to the BaseCache that was created. If the key was already in use, a reference to the existing cache is returned instead.

Examples:
Since: 3.0.0
Focus
Focus
destroy()
Focus
Focus

Description:

Removes all entries from all BaseCaches and destroys all custom caches.

Examples:
Since: 3.0.0
Focus
Focus