Phaser API Documentation

  Version: 
Event: CHANGE_DATA_KEY
Phaser.Data.Events.CHANGE_DATA_KEY
CHANGE_DATA_KEY

Description:

The Change Data Key Event.

This event is dispatched by a Data Manager when an item in the data store is changed.

Game Objects with data enabled have an instance of a Data Manager under the data property. So, to listen for the change of a specific data item from a Game Object you would use: sprite.on('changedata-key', listener), where key is the unique string key of the data item. For example, if you have a data item stored called gold then you can listen for sprite.on('changedata-gold').

Parameters:

name type description
parent any

A reference to the object that owns the instance of the Data Manager responsible for this event.

value any

The item that was updated in the Data Manager. This can be of any data type, i.e. a string, boolean, number, object or instance.

previousValue any

The previous item that was updated in the Data Manager. This can be of any data type, i.e. a string, boolean, number, object or instance.

Since: 3.16.1