`createFromObjects()` doesn't copy custom properties

[samme]

Version

• Phaser Version: 3.60.0-beta.18

Description

For example giving an Object a property of alpha: 0.5 in Tiled will be reflected in the Game Object that is created.

This happened in v3.55.2 but it doesn't happen now.

Example Test Code

https://labs.phaser.io/edit.html?src=src/3.60\tilemap\create%20from%20objects.js&v=3.60.0-beta.18

const coinObject = this.map.objects[0].objects[3];

console.assert(coinObject.properties.alpha === 0.25);

const [ coin ] = this.map.createFromObjects('Coin Object Layer', [
    { id: coinObject.id, key: 'coin' }
]);

console.assert(coin.alpha === 0.25, 'Coin sprite should have alpha 0.25 not %s', coin.alpha);

[photonstorm]

Thank you for submitting this issue. We have fixed this and the fix has been pushed to the master branch. It will be part of the next release. If you get time to build and test it for yourself we would appreciate that.

[paxperscientiam]

@photonstorm I guess the currently documented behavior is changing, then? Per new docs, "Custom object properties that do not exist as a Game Object property are set in the Game Objects data."

That said, an option to automatically update gameobject properties based on custom properties sounds great.

[samme]

The correct behavior should be the same in v3.55 and v3.60. The incorrect behavior was in the some of the v3.60 betas only.

If you create a sprite from Tiled Object

{ alpha: 0.5, color: 'green' }

then the resulting sprite will have

alpha === 0.5
data.values.color === 'green'

Here color is the custom object property.

[paxperscientiam]

Thanks for underscoring that, @samme . I definitely misread it.

That said, I cannot get custom properties to have any effect. In my case, I'm creating game objects from a class that extends Physics.Matter.Image in this way:

        this.tileMap.createFromObjects("GameObjects/Ships", {
            name: "SimpleShip",
            scene: this,
            key: "ship",
            classType: SimpleShip,
        })

The corresponding "SimpleShip" entry in Tiled on the Tiled layer "GameObjects/Ships" is defined like this:

This works great, except for the custom properties issue.

Examining the data store ...

Only "alpha" and "color" show up. Alpha shouldn't even be there, if I understand you correctly. "dummy" should be there, but it's not.

gameObject.alpha, gameObject.flipX, and gameObject.flipY are the default values (1, false, false).

For completeness, I tried again without a custom class (I added to the aforementioned Tiled Layer an object named "LOL").

        const LOL = this.tileMap.createFromObjects("GameObjects/Ships", {
            name: "LOL",
            scene: this
        })

For the "LOL" object, all of the custom properties do show in the data store, including the ones that shouldn't (like alpha and scale).

Do you think there's an issue with my code, or perhaps there's a bug?

Thank you

Edit: i should add, I'm issuing the regular release of 3.60

[samme]

For the "LOL" object, all of the custom properties do show in the data store, including the ones that shouldn't (like alpha and scale).

This is definitely in Phaser v3.60.0, not a beta? I can't think of why that would happen. In tilemap/create from objects alpha is working correctly (see dim coin at top).

[paxperscientiam]

I just scrutinized "node_modules/phaser/package.json" and can confirm that package.json.version indicates as much.

I will try again from scratch with what you shared.

[photonstorm]

I just scrutinized "node_modules/phaser/package.json" and can confirm that package.json.version indicates as much.

Check the browser Dev Tools. Phaser logs its version number to the console when it boots. For example, you may have npm at 3.60 but override it with a different package / script tag. Worth checking.

[paxperscientiam]

Indicated there too, I'm afraid.

To clarify, I'm using vite as my build tool; only mentioning it because the only hard coded script tag in my project is that which points to vite's bundle.

I'll try to see if I can replicate what I'm experiencing with a minimal setup.

[paxperscientiam]

Hmm, I'm still getting unexpected results.

Tiled object:

I created a gist that will hopefully help anyone else reproduce what I'm seeing. 🤞

https://gist.github.com/paxperscientiam/c6a443d5315f2ce7b7e843c40353e073

[samme]

@paxperscientiam I reproduced your problem. @photonstorm could you reopen?

[paxperscientiam]

Thanks @samme