1.18 - Fix token image tables #5823
Merged
Conversation
This file contains hidden or 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
`ImageUtil#getTokenImage(Token, ImageObserver[])` is redundant and has been removed. Any callers of this method can instead just call `Token#getTokenImageAssetId()` followed by `ImageManager.getImage(MD5Key, ImageObserver[])`. The `TokenRenderer` no longer tries to cache token images per facing, and instead uses the above technique to get the image each time. This cache wasn't really functional since entries could never be ejected or updated. Being static, this also meant it was a memory leak as all the images ever cached would be kept in `TokenRenderer#imageTableMap`.
All `null` results from the image table lookup are now guaranteed to use the fallback to `Token#getImageAssetId()`.
This was
linked to
issues
Oct 18, 2025
cwisniew
approved these changes
Oct 19, 2025
github-project-automation
bot
moved this from Awaiting-Review
to To-Be-Merged
in MapTool 1.18
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Identify the Bug or Feature request
Fixes #5819
Fixes #5817
Description of the Change
Makes
Token#getTokenImageAssetId()the only way to do lookups in image tables. Any other place that needs to map a token facing to an image now callsToken#getTokenImageAssetId()followed byImageManager.getImage(MD5Key, ImageObserver[]).Token#getTokenImageAssetId()itself has been fixed to returnToken#getImageAssetId()when a matching entry has no image. The new implementation of the method guarantees that allnullcases nowToken#getImageAssetId()as a fallback.TokenRendererno longer caches image table results, but now callsToken#getImageAssetId()as needed. The calculation for populating the cache was not accurate compared to real table lookups, and there was no cache invalidation. This also meant it leaked memory, as all cachedBufferedImageobjects would remain in memory forever.The NPE reported in #5817 is no longer possible because it originated from the
TokenRenderer's image table cache.Possible Drawbacks
None
Documentation Notes
N/A
Release Notes
NullPointerExceptionthrown when a token has the "Has image table?" option selected with no image table name specified.This change is