Make light source detection more consistent #4541
Merged
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
cwisniew
approved these changes
Dec 9, 2023
Since players and GMs disagree on which light sources exist, and since GMs can enable "player view", we need to be able to track light sources based on the current role. This has implications for illumination as well, so we now key the light source map and illuminations cache by player role in addition to the existing keys. Doing so allows `lightSourceMap` to always be `ZoneView`'s source of truth when it comes to light sources, and it works even in the presence of view changes. On a related note, auras are now only filtered in `getDrawableAuras()`, but that method is now dependent on the current view. This makes it so that, e.g., GM-only auras are not returned when the GM is in player view. There is now one place (`updateLightSourcesFromTokens()`) that checks whether or not a token should be added to the light source map. This avoids inconsistencies in how tokens are handled at campaign load vs being added or modified later. The event handlers that need to use it have also been updated to avoid any repeated logic. With the other changes, `MapTool.getPlayer().isEffectiveGM()` is no longer needed since we always work off the provided view rather than trying to determine it ourselves. The same logic, if needed again, can be attained by checking `getEffectiveRole()` instead.
kwvanderlinde
force-pushed
the
bugfix/4298-inconsistent-light-display
branch
from
4774031 to
b9cf002
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.
Identify the Bug or Feature request
Addresses #4298
Description of the Change
This change addresses the inconsistent states that can be seen when modifying tokens and the use of player view. There are a few main aspects to it:
lightSourceMaphave distinct entries for player and GM roles, since they disagree on which lights even exist. This also affects the illuminations, soIlluminationKeyalso includes the role now so we don't use a GM illumination when in player view.Possible Drawbacks
Should be none.
Documentation Notes
N/A
Release Notes
This change is