PokéRogue
    Preparing search index...

    Class DataManager

    The Data Manager provides a way to store, retrieve, and manage arbitrary key-value data on any Game Object, System, or Plugin. Each entry is stored by a string key and can hold any value type.

    Data changes are communicated through events: a setdata event fires when a new key is created, and changedata / changedata-key events fire when an existing value is updated. This makes the Data Manager well suited for driving UI, triggering game logic, or syncing state between systems.

    The parent object must either extend EventEmitter directly, or expose a property called events that is an instance of EventEmitter.

    Index
    constructor
    count events freeze list parent values
    destroy each get getAll has inc merge pop query remove reset set setFreeze toggle

    • Parameters

      • parent: object

        The object that this DataManager belongs to.

      • OptionaleventEmitter: EventEmitter

        The DataManager's event emitter.

      Returns DataManager

    count: number

    Return the total number of entries in this Data Manager.

    events: EventEmitter

    The DataManager's event emitter.

    freeze: boolean

    Gets or sets the frozen state of this Data Manager. A frozen Data Manager will block all attempts to create new values or update existing ones.

    list: { [key: string]: any }

    The data list.

    parent: any

    The object that this DataManager belongs to.

    values: { [key: string]: any }

    The public values list. You can use this to access anything you have stored in this Data Manager. For example, if you set a value called gold you can access it via:

    this.data.values.gold;

    You can also modify it directly:

    this.data.values.gold += 1000;

    Doing so will emit a changedata event from the parent of this Data Manager.

    Do not modify this object directly. Adding properties directly to this object will not emit any events. Always use DataManager.set to create new items the first time around.

    • Destroys this Data Manager. All stored data is deleted, all event listeners are removed, and the reference to the parent object is cleared. This is called automatically when the parent emits a destroy event.

      Returns void

    • Passes all data entries to the given callback. The callback is invoked for every entry in the Data Manager, receiving the parent object, the key, the value, and any additional arguments provided to this method.

      Parameters

      • callback: DataEachCallback

        The function to call.

      • Optionalcontext: any

        Value to use as this when executing callback.

      • ...args: any[]

        Additional arguments that will be passed to the callback, after the game object, key, and data.

      Returns this

      This Data Manager instance.

    • Retrieves the value for the given key, or undefined if it doesn't exist.

      You can also access values via the values object. For example, if you had a key called gold you can do either:

      this.data.get('gold');

      Or access the value directly:

      this.data.values.gold;

      You can also pass in an array of keys, in which case an array of values will be returned:

      this.data.get([ 'gold', 'armor', 'health' ]);

      This approach is useful for destructuring arrays in ES6.

      Parameters

      • key: string | string[]

        The key of the value to retrieve, or an array of keys.

      Returns any

      The value belonging to the given key, or an array of values, the order of which will match the input array.

    • Retrieves all data values in a new object.undefined

      Returns { [key: string]: any }

      All data values.

    • Determines whether the given key is set in this Data Manager.

      Please note that the keys are case-sensitive and must be valid JavaScript Object property strings. This means the keys gold and Gold are treated as two unique values within the Data Manager.

      Parameters

      • key: string

        The key to check.

      Returns boolean

      Returns true if the key exists, otherwise false.

    • Increases a value for the given key. If the key doesn't already exist in the Data Manager then it is created with a value of 0 before being increased.

      When the key is first created, a setdata event is emitted. If the key already exists, a changedata event and a changedata-key event are emitted instead, where key is replaced with the actual key name.

      Parameters

      • key: string

        The key to change the value for.

      • Optionalamount: number

        The amount to increase the given key by. Pass a negative value to decrease the key. Default 1.

      Returns this

      This Data Manager instance.

    • Merge the given object of key value pairs into this DataManager.

      Any newly created values will emit a setdata event. Any updated values (see the overwrite argument) will emit a changedata event.

      Parameters

      • data: { [key: string]: any }

        The data to merge.

      • Optionaloverwrite: boolean

        Whether to overwrite existing data. Defaults to true. Default true.

      Returns this

      This Data Manager instance.

    • Retrieves the data associated with the given 'key', deletes it from this Data Manager, then returns it.

      Parameters

      • key: string

        The key of the value to retrieve and delete.

      Returns any

      The value of the given key.

    • Queries the DataManager for the values of keys matching the given regular expression.

      Parameters

      • search: RegExp

        A regular expression object. If a non-RegExp object obj is passed, it is implicitly converted to a RegExp by using new RegExp(obj).

      Returns { [key: string]: any }

      The values of the keys matching the search string.

    • Remove the value for the given key.

      If the key is found in this Data Manager it is removed from the internal lists and a removedata event is emitted.

      You can also pass in an array of keys, in which case all keys in the array will be removed:

      this.data.remove([ 'gold', 'armor', 'health' ]);

      Parameters

      • key: string | string[]

        The key to remove, or an array of keys to remove.

      Returns this

      This Data Manager instance.

    • Delete all data in this Data Manager and unfreeze it.undefined

      Returns this

      This Data Manager instance.

    • Sets a value for the given key. If the key doesn't already exist in the Data Manager then it is created.

      data.set('name', 'Red Gem Stone');

      You can also pass in an object of key value pairs as the first argument:

      data.set({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });

      To get a value back again you can call get:

      data.get('gold');

      Or you can access the value directly via the values property, where it works like any other variable:

      data.values.gold += 50;

      When the value is first set, a setdata event is emitted.

      If the key already exists, a changedata event is emitted instead, along an event named after the key. For example, if you updated an existing key called PlayerLives then it would emit the event changedata-PlayerLives. These events will be emitted regardless if you use this method to set the value, or the direct values setter.

      Please note that the data keys are case-sensitive and must be valid JavaScript Object property strings. This means the keys gold and Gold are treated as two unique values within the Data Manager.

      Type Parameters

      • T extends unknown

      Parameters

      • key: string | T

        The key to set the value for. Or an object of key value pairs. If an object the data argument is ignored.

      • Optionaldata: any

        The value to set for the given key. If an object is provided as the key this argument is ignored.

      Returns this

      This Data Manager instance.

    • Freeze or unfreeze this Data Manager. A frozen Data Manager will block all attempts to create new values or update existing ones.

      Parameters

      • value: boolean

        Whether to freeze or unfreeze the Data Manager.

      Returns this

      This Data Manager instance.

    • Toggles a boolean value for the given key. If the key doesn't already exist in the Data Manager then it is created with a value of false before being toggled.

      When the key is first created, a setdata event is emitted. If the key already exists, a changedata event and a changedata-key event are emitted instead, where key is replaced with the actual key name.

      Parameters

      • key: string

        The key to toggle the value for.

      Returns this

      This Data Manager instance.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods