You are browsing legacy Phaser documentation that is 4+ years out of date. Please see https://newdocs.phaser.io

Class: BaseCache

Phaser.Cache. BaseCache

The BaseCache is a base Cache class that can be used for storing references to any kind of data.

Data can be added, retrieved and removed based on the given keys.

Keys are string-based.

new BaseCache()

Since: 3.0.0
Source: src/cache/BaseCache.js (Line 12)

Members

entries :Phaser.Structs.Map.<String, *>

The Map in which the cache objects are stored.

You can query the Map directly or use the BaseCache methods.

Type:
Since: 3.0.0
Source: src/cache/BaseCache.js (Line 31)

events :Phaser.Events.EventEmitter

An instance of EventEmitter used by the cache to emit related events.

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

Methods

add(key, data)

Adds an item to this cache. The item is referenced by a unique string, which you are responsible for setting and keeping track of. The item can only be retrieved by using this string.

Parameters:
Name Type Description
key string

The unique key by which the data added to the cache will be referenced.
data *

The data to be stored in the cache.
Since: 3.0.0
Source: src/cache/BaseCache.js (Line 52)
Fires:
Returns:

This BaseCache object.

Type
Phaser.Cache.BaseCache

destroy()

Destroys this cache and all items within it.

Since: 3.0.0
Source: src/cache/BaseCache.js (Line 163)

exists(key)

Checks if this cache contains an item matching the given key. This performs the same action as BaseCache.has and is called directly by the Loader.

Parameters:
Name Type Description
key string

The unique key of the item to be checked in this cache.
Since: 3.7.0
Source: src/cache/BaseCache.js (Line 90)
Returns:

Returns true if the cache contains an item matching the given key, otherwise false.

Type
boolean

get(key)

Gets an item from this cache based on the given key.

Parameters:
Name Type Description
key string

The unique key of the item to be retrieved from this cache.
Since: 3.0.0
Source: src/cache/BaseCache.js (Line 106)
Returns:

The item in the cache, or null if no item matching the given key was found.

Type
*

getKeys()

Returns all keys in use in this cache.

Since: 3.17.0
Source: src/cache/BaseCache.js (Line 150)
Returns:

Array containing all the keys.

Type
Array.<string>

has(key)

Checks if this cache contains an item matching the given key. This performs the same action as BaseCache.exists.

Parameters:
Name Type Description
key string

The unique key of the item to be checked in this cache.
Since: 3.0.0
Source: src/cache/BaseCache.js (Line 74)
Returns:

Returns true if the cache contains an item matching the given key, otherwise false.

Type
boolean

remove(key)

Removes and item from this cache based on the given key.

If an entry matching the key is found it is removed from the cache and a remove event emitted. No additional checks are done on the item removed. If other systems or parts of your game code are relying on this item, it is up to you to sever those relationships prior to removing the item.

Parameters:
Name Type Description
key string

The unique key of the item to remove from the cache.
Since: 3.0.0
Source: src/cache/BaseCache.js (Line 121)
Fires:
Returns:

This BaseCache object.

Type
Phaser.Cache.BaseCache