search

mapeditor / tiled

Flexible level editor
https://www.mapeditor.org/
Other
11.26k stars 1.76k forks source link

[Draft] Added missing EditableWangSet::SetColorImageTile and EditableWangSet::SetColorProbability #4070

Open Racines opened 1 month ago

Racines commented 1 month ago

It's seems there is no way in the current api to edit wangcolor tile preview and probability: https://discord.com/channels/524610627545595904/524610627545595906/1292100220569653248

I added them in this PR but this has not been tested. However, after a discussion with eishiya on discord, a better way to expose these features is described here: https://github.com/mapeditor/tiled/issues/3900

eishiya commented 1 month ago

(Repeating what I wrote on Discord, but hopefully more coherent :)

I think it would be best to have an EditableWangColor that has the standard TiledObject methods for setting custom properties, and has color (the Terrain color), name, imageTile, probability, wangSet, and id (its index within its WangSet). This would make interacting with WangColor more like interacting with Tiles in a Tileset, or Layers in a TileMap.

WangSet's setColorName() and colorName() would be deprecated, and instead WangSet should get methods similar to those of Tileset to fetch WangColors, e.g. colors could return WangColor[], and color(id) could return the WangColor with that id, and editing the name and other properties would be handled via the WangColor, not the WangSet.

This PR, though useful (assuming it works xP), continues the current pattern of dealing with individual Wang colours via their WangSet. While that works and it's hard to argue with adding missing functionality, it's a different pattern from how similar entities work elsewhere in the API, and implementing all the methods for handling custom properties using this same approach would be a mess (setColorColorProperty(id, color) anyone?).

Wang colours have way too many properties useful to scripting to be treated as just a number within WangSet, and I think the API should reflect that. And the sooner these corrections are made, the fewer scripts will need adjustments, and the less functionality will need to be rewritten by whoever tackles this structural change.