PokéRogue
    Preparing search index...

    Class Map<K, V>

    A custom Map implementation that stores entries as key-value pairs with ordered iteration. Unlike a native JavaScript Map, it also maintains an internal array of entries for efficient indexed access and iteration. Supports filtering, merging, and contains/size operations. Used internally by various Phaser systems for managing collections.

    var map = new Map([
       [ 1, 'one' ],
       [ 2, 'two' ],
       [ 3, 'three' ]
    ]);

    Type Parameters

    • K
    • V
    Index
    constructor
    entries size
    clear contains delete dump each get getArray has keys merge set setAll values

    • Type Parameters

      • K
      • V

      Parameters

      • elements: V[]

        An optional array of key-value pairs to populate this Map with.

      Returns Map<K, V>

    entries: { [key: string]: V }

    The entries in this Map.

    size: number

    The number of key / value pairs in this Map.

    • Delete all entries from this Map.undefined

      Returns Map<K, V>

      This Map object.

    • Returns true if the value exists within this Map. Otherwise, returns false.

      Parameters

      • value: V

        The value to search for.

      Returns boolean

      true if the value is found, otherwise false.

    • Delete the specified element from this Map.

      Parameters

      • key: K

        The key of the element to delete from this Map.

      Returns Map<K, V>

      This Map object.

    • Dumps the contents of this Map to the console via console.group.

      Returns void

    • Iterates through all entries in this Map, passing each one to the given callback.

      If the callback returns false, the iteration will break.

      Parameters

      • callback: EachMapCallback<V>

        The callback which will receive the keys and entries held in this Map.

      Returns Map<K, V>

      This Map object.

    • Returns the value associated to the key, or undefined if there is none.

      Parameters

      • key: K

        The key of the element to return from the Map object.

      Returns V

      The element associated with the specified key or undefined if the key can't be found in this Map object.

    • Returns an Array of all the values stored in this Map.undefined

      Returns V[]

      An array of the values stored in this Map.

    • Returns a boolean indicating whether an element with the specified key exists or not.

      Parameters

      • key: K

        The key of the element to test for presence of in this Map.

      Returns boolean

      Returns true if an element with the specified key exists in this Map, otherwise false.

    • Returns an array of all entry keys in this Map.undefined

      Returns K[]

      Array containing entries' keys.

    • Merges all new keys from the given Map into this one. If it encounters a key that already exists it will be skipped unless override is set to true.

      Parameters

      • map: Map<K, V>

        The Map to merge in to this Map.

      • Optionaloverride: boolean

        Set to true to replace values in this Map with those from the source map, or false to skip them. Default false.

      Returns Map<K, V>

      This Map object.

    • Adds an element with a specified key and value to this Map.

      If the key already exists, the value will be replaced.

      If you wish to add multiple elements in a single call, use the setAll method instead.

      Parameters

      • key: K

        The key of the element to be added to this Map.

      • value: V

        The value of the element to be added to this Map.

      Returns Map<K, V>

      This Map object.

    • Adds all the elements in the given array to this Map.

      If the key already exists, the value will be replaced.

      Type Parameters

      • K
      • V

      Parameters

      • elements: V[]

        An array of key-value pairs to populate this Map with.

      Returns this

      This Map object.

    • Returns an Array of all values stored in this Map.undefined

      Returns V[]

      An Array of values.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods