Scripting: Added Tile.image for accessing a tile's image data #3882
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Usually one could load the image based on Tile.imageFileName, but when a tile's image has been set directly using Tile.setImage, this is not possible. This can happen for example when an importer has used this function since there was no external image file to refer to, or it used an unsupported image format. Tile.image now provides convenient access to the tile's image, falling back to the Tileset's image when the tile has no individual image. As such, this function also provides access to the tileset's image, which would ideally be available through Tileset.image, but this property was already taken and used for the image file name. To free up this property in the future it is now deprecated. Extensions should switch to the new Tileset.imageFileName property. Part of issue mapeditor#3630
This was referenced Jan 31, 2024
As a generally more convenient alternative to imageSource, which is a URL.
Now it also clears an existing file name, when no file name is specified. This way the function should behave more like expected, and more consistent with ImageLayer.setImage (which takes a URL however...) and Tileset.loadFromImage. Also fixed updating of the map view, when using Tileset.loadFromImage and Tile.setImage. Issue mapeditor#3630
bjorn
force-pushed
the
scripting-tile-image
branch
from
60aa1c4
to
7a6c42b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Usually one could load the image based on
Tile.imageFileName, but when a tile's image has been set directly usingTile.setImage, this is not possible. This can happen for example when an importer has used this function since there was no external image file to refer to, or it used an unsupported image format.Tile.imagenow provides convenient access to the tile's image, falling back to the tileset's image when the tile has no individual image.As such, this function also provides access to the tileset's image, which would ideally be available through
Tileset.image, but this property was already taken and used for the image file name. To free up this property in the future it is now deprecated. Extensions should switch to the newTileset.imageFileNameproperty.Part of issue #3630