Fix onTokenMove not being called when lib: tokens are off the Token layer #4363
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
The culprit was that the `TokensAdded` and `TokensRemoved` events were only be called with Token-layer tokens and not
for stamps (difference between `Zone.getTokens()` vs `Zone.getAllTokens()`). This has been rectified.
There were several other places that had the same mistake and thus have slightly different behaviour now. Changes
unlikely to be observed by a user are marked as [minor], while the others may still not be important but can be easily
observed:
- Application changes:
- [minor] Pasting a token now checks the new exposed area GUID against all tokens.
- [minor] Closing the adjust grid tool now updates all tokens.
- Renaming a token property type will now change the name on all tokens.
- Renaming a token will now validate the name against all tokens.
- Macro function changes:
- [minor] Change to `createToken()`, `copyToken()`, and `copyTokens()` to check the new exposed area GUID against all
tokens.
- Change to `test.run()` to find `test:` tokens on all layers.
- Change to `selectTokens()` to select on the current layer rather than the Token layer when no parameters are given.
- Change to `getInfo("client")` to include `lib:` and `image:` tokens not on the Token layer.
- JS API changes:
- Change to `MapTool.tokens.getMapTokens()` to return all tokens, not just those on the token layer.
- Change to `MapTool.clientInfo.libraryTokens()` to return all `lib:` tokens, not just those on the token layer.
- Web API changes:
- Change to `setProperties` handler to find the `Zone` for a `Token` even if the `Token` is not on the Token layer.
cwisniew
approved these changes
Nov 3, 2023
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.
Identify the Bug or Feature request
Fixes #3581
Description of the Change
The culprit was that the
TokensAddedandTokensRemovedevents were only be called with Token-layer tokens and not for stamps (difference betweenZone.getTokens()vsZone.getAllTokens()). This has been rectified.There were several other places that had the same mistake and I've taken the opportunity to update them. As such, there will be slightly different behaviour for those places that have been updated. Changes unlikely to be observed by a user I've marked as [minor], while the others may still not be important but can be easily observed:
createToken(),copyToken(), andcopyTokens()to check the new exposed area GUID against all tokens.test.run()to findtest:tokens on all layers.selectTokens()to select on the current layer rather than the Token layer when no parameters are given.getInfo("client")to includelib:andimage:tokens not on the Token layer.MapTool.tokens.getMapTokens()to return all tokens, not just those on the token layer.MapTool.clientInfo.libraryTokens()to return alllib:tokens, not just those on the token layer.setPropertieshandler to find theZonefor aTokeneven if theTokenis not on the Token layer.Possible Drawbacks
Various bits have slightly different behaviour, can impact frameworks that are relying on functionality being specific to the Token layer.
Documentation Notes
I believe this change actually brings all these bits into alignment with their documentation.
Release Notes
lib:token events and various other behaviours regarding tokens not on the Token layer.This change is