PokéRogue
    Preparing search index...

    Class BaseCache

    A key-value store used by the Phaser framework to cache loaded assets and other data. Items are stored and retrieved using string-based keys. The BaseCache emits events when items are added or removed, allowing other systems to react to cache changes. Multiple BaseCache instances are owned by the CacheManager, one per asset type (JSON, binary, audio, etc.), and you can also create custom caches via CacheManager.addCustom().

    Index
    constructor
    entries events
    add destroy exists get getKeys has remove
    entries: Map<String, any>

    The Map in which the cache objects are stored.

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

    events: EventEmitter

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

    • 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

      • key: string

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

      • data: any

        The data to be stored in the cache.

      Returns this

      This BaseCache object.

    • Destroys this cache and all items within it. Clears the entries Map, removes all event listeners from the EventEmitter, and nulls the internal references.

      Returns void

    • 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

      • key: string

        The unique key of the item to be checked in this cache.

      Returns boolean

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

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

      Parameters

      • key: string

        The unique key of the item to be retrieved from this cache.

      Returns any

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

    • Returns all keys in use in this cache.undefined

      Returns string[]

      An array of strings containing all keys currently stored in this cache.

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

      Parameters

      • key: string

        The unique key of the item to be checked in this cache.

      Returns boolean

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

    • Removes an 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

      • key: string

        The unique key of the item to remove from the cache.

      Returns this

      This BaseCache object.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods