fix: using unused cell flag to toggle ISS by sicsix · Pull Request #1082 · community-shaders/skyrim-community-shaders

sicsix · 2025-05-19T05:15:47Z

Enabling Interior Sun Shadows now requires setting unused bit 15 on the interior cell in xEdit
Allows for mods to use interior weathers without enabling ISS
RE shows bit 15 appears unused, testing in-game shows no bits above 9 were set - cannot be 100% certain on this but highly likely it is fine

The required flags including bit 15 can be set in on the cell in xEdit as below:

Summary by CodeRabbit

New Features
- Improved detection for interiors with sunlight by refining the criteria used to identify such spaces.
- Made the interior sunlight detection method accessible for use in other features.
Refactor
- Unified and streamlined the logic for determining interiors with sunlight across relevant features.

coderabbitai · 2025-05-19T05:15:53Z

Walkthrough

The changes update the logic for determining whether an interior cell has sunlight shadows by introducing a new flag check and centralizing this logic in the InteriorSunShadows::IsInteriorWithSun method, which is now public. Related code in volumetric lighting now calls this method for consistency.

Changes

File(s)	Change Summary
src/Features/InteriorSunShadows.cpp	Updated `IsInteriorWithSun` to require an additional `kSunlightShadows` flag for true result.
src/Features/InteriorSunShadows.h	Moved `IsInteriorWithSun` to public; added private `CellFlagExt` enum for `kSunlightShadows`.
src/Features/VolumetricLighting.cpp	Replaced flag checks with a call to `InteriorSunShadows::IsInteriorWithSun`; added header include.

Sequence Diagram(s)

sequenceDiagram
    participant VolumetricLighting
    participant InteriorSunShadows
    participant TESObjectCELL

    VolumetricLighting->>TESObjectCELL: Get interiorCell
    VolumetricLighting->>InteriorSunShadows: IsInteriorWithSun(interiorCell)
    InteriorSunShadows->>TESObjectCELL: Check cellFlags for required flags
    InteriorSunShadows-->>VolumetricLighting: Return true/false
    VolumetricLighting->>VolumetricLighting: Set inInteriorWithSunShadows accordingly

Poem

In the world of code where shadows run,
A rabbit hops beneath the sun.
Four flags now guard the sunlit door,
Interior secrets, checked once more.
With logic neat and headers new—
The sunlight shines where it is due!
☀️🐇

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 645f312 and 0ad8198.

📒 Files selected for processing (3)

src/Features/InteriorSunShadows.cpp (1 hunks)
src/Features/InteriorSunShadows.h (1 hunks)
src/Features/VolumetricLighting.cpp (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

src/Features/VolumetricLighting.cpp (1)

src/Features/InteriorSunShadows.cpp (2)

IsInteriorWithSun (47-50)

IsInteriorWithSun (47-47)

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: build plugin and addons

🔇 Additional comments (5)

src/Features/InteriorSunShadows.h (2)

54-55: Good refactoring - making the method public for reuse

Moving the IsInteriorWithSun method to the public section properly centralizes this logic, allowing it to be called from VolumetricLighting.cpp. This helps maintain consistency in how interior sun shadows are detected throughout the codebase.

57-61: Appropriately using an unused flag bit for new functionality

Adding the CellFlagExt enum with the kSunlightShadows flag at bit 15 is a good approach. This aligns with the PR objective of using an unused cell flag to control Interior Sun Shadows independently from other interior cell properties. Based on the PR description, bit 15 has been verified to be unused in the Creation Engine documentation and through in-game testing.

src/Features/VolumetricLighting.cpp (2)

3-3: Proper header inclusion

Adding the include for "InteriorSunShadows.h" is necessary since the code now calls InteriorSunShadows::IsInteriorWithSun.

193-193: Good centralization of logic

Replacing the inline cell flag checks with a call to InteriorSunShadows::IsInteriorWithSun properly centralizes the logic for determining if an interior cell has sun shadows. This ensures consistency and makes future modifications easier to maintain.

src/Features/InteriorSunShadows.cpp (1)

49-49: Implementation now checks for the additional flag

The implementation now correctly requires all four flags to be set: the original three (kIsInteriorCell, kShowSky, kUseSkyLighting) plus the new kSunlightShadows flag. This meets the PR objective of requiring explicit opt-in for Interior Sun Shadows via the cell flag.

Note that modders will need to explicitly set this flag (bit 15) on interior cells in xEdit to enable Interior Sun Shadows, which achieves the goal of decoupling interior weather effects from ISS activation.

✨ Finishing Touches

📝 Docstrings were successfully generated. (🔄 Check again to generate docstrings again)

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions · 2025-05-19T05:33:04Z

✅ A pre-release build is available for this PR:
Download

@alandtse

Docstrings generation was requested by @alandtse. * #1082 (comment) The following files were modified: * `src/Features/InteriorSunShadows.cpp` * `src/Features/InteriorSunShadows.h` * `src/Features/VolumetricLighting.cpp`

coderabbitai · 2025-05-19T05:33:25Z

Note

Generated docstrings for this pull request at #1083

alandtse

Should we add to commonlib for others? It's possible to gate by a DLL being present. I'd also double check no one is using it for mods. Maybe step modifications? Are there any common tools that should be modified for this? Niftools? I think hakaspl had to get that modified.

sicsix · 2025-05-19T05:51:20Z

Should we add to commonlib for others? It's possible to gate by a DLL being present. I'd also double check no one is using it for mods. Maybe step modifications? Are there any common tools that should be modified for this? Niftools? I think hakaspl had to get that modified.

Not sure to be honest, it would at least signify the bit is used in case anybody else using CommonLib needs to hijack one but also means it's building in support for this feature that doesn't exist in the original code.

I can't imagine anyone is using this bit for other mods but I wouldn't know where to start checking that either. Activation is gated by four different bits here at least and it does solve the issue with mods that are enabling kShowSky and kUseSkyLighting to use interior weathers for lighting and activating ISS as an unwanted side effect.

The only tool that I think would benefit from including this would be xEdit. Both Interior Sun Shadows and Inverse Square Lighting are hijacking spare bits and currently these are just listed as Unknown X in the UI.

alandtse · 2025-05-19T15:08:31Z

Maybe PR to xedit to label the bits?

alandtse

Can you see the AI generated docstrings PR and see if you should merge in your PR branch? I mean it could be totally wrong.

fix: using unused cell flag to toggle ISS

0ad8198

coderabbitai Bot mentioned this pull request May 19, 2025

docs: 📝 Add docstrings to iss_flag #1083

Closed

alandtse reviewed May 19, 2025

View reviewed changes

alandtse approved these changes May 19, 2025

View reviewed changes

doodlum approved these changes May 20, 2025

View reviewed changes

alandtse merged commit 8ccb696 into community-shaders:dev May 24, 2025
13 checks passed

coderabbitai Bot mentioned this pull request May 27, 2025

fix(iss): fix cell change detection logic #1095

Merged

coderabbitai Bot mentioned this pull request Jun 24, 2025

docs: feature descriptions, mod links, tooltips #1198

Merged

alandtse pushed a commit to alandtse/open-shaders that referenced this pull request Jul 20, 2025

fix: use unused cell flag to toggle ISS (community-shaders#1082)

f80655f

coderabbitai Bot mentioned this pull request Aug 11, 2025

refactor(interior sun): rename interior sun shadows #1387

Merged

coderabbitai Bot mentioned this pull request Nov 1, 2025

feat(interior sun): force single shadow cascade option #1589

Closed

coderabbitai Bot mentioned this pull request Feb 23, 2026

fix(Volumetric Shadows): Interior Sun Compatibility #1935

Closed

coderabbitai Bot mentioned this pull request Mar 17, 2026

fix(sky sync): early return for invalid cells #1991

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: using unused cell flag to toggle ISS#1082

fix: using unused cell flag to toggle ISS#1082
alandtse merged 1 commit into
community-shaders:devfrom
sicsix:iss_flag

sicsix commented May 19, 2025 •

edited

Loading

Uh oh!

coderabbitai Bot commented May 19, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

github-actions Bot commented May 19, 2025

Uh oh!

coderabbitai Bot commented May 19, 2025

Uh oh!

alandtse left a comment

Uh oh!

sicsix commented May 19, 2025 •

edited

Loading

Uh oh!

alandtse commented May 19, 2025

Uh oh!

alandtse left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

sicsix commented May 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented May 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions Bot commented May 19, 2025

Uh oh!

coderabbitai Bot commented May 19, 2025

Uh oh!

alandtse left a comment

Choose a reason for hiding this comment

Uh oh!

sicsix commented May 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alandtse commented May 19, 2025

Uh oh!

alandtse left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

sicsix commented May 19, 2025 •

edited

Loading

coderabbitai Bot commented May 19, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

sicsix commented May 19, 2025 •

edited

Loading