Fall back to the map name when the display name is equal or set empty #3861
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
Calls to `MapFunctions.checkTrusted()` have been replaced with calls to the existing method `FunctionUtil.blockUntrustedMacro()`. Calls to `MapFunctions.getNamedMap()` have been replaced with calls to the existing method `FunctionUtil.getZoneRendererFromParam()`, or the new method `FunctionUtil.getZoneRenderer()` when the name is required. A new method `FunctionUtil.delimitedResult()` has been added for joining results into string lists or JSON arrays depending on a user-provided value.
The behaviour of these function is back to their 1.12.2 behaviour, as they will no longer return `null` values for maps that have no player alias set: - `getMapDisplayName()` - `getAllMapDisplayNames()` - `getVisibleMapDisplayNames()` Also `getMapName()` will once again be able to find maps by matching the name when no player alias is set. The new method `Zone.getDisplayName()` can be used to get the name of the zone to show to players, whether that is the player alias or the regular name.
kwvanderlinde
force-pushed
the
bugfix/3857-getMapDisplayName-npe
branch
from
f310e58 to
715e9c2
Compare
Phergus
approved these changes
Mar 16, 2023
There was a problem hiding this comment.
Reviewed 5 of 5 files at r1, all commit messages.
Reviewable status:complete! all files reviewed, all discussions resolved (waiting on @kwvanderlinde)
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 #3857
Description of the Change
Now that player aliases can internally be
null(e.g., when upgrading a campaign, or when the user sets the display name to the same as the regular name), a few macro functions started returningnullor generating NPEs. These functions now fallback to the map name when a player alias is not set:getMapDisplayName()getMapName()getAllMapDisplayNames()getVisibleMapDisplayNames()getInfo("map")The loading banner will also now show the map name rather than
'null'if no player alias is set.The new method
Zone.getDisplayName()is used to consistently get the player-visible name of a map, whether that is the player alias or the map name.Possible Drawbacks
Should be none
Documentation Notes
None (restores 1.12.2 behaviour)
Release Notes
N/A
This change is