fix(terrain helper): Fix for nullptr lookup and running without plugin

[hakasapl]

This PR fixes 2 things:

• Sometimes the default skyrim terrain TXST does not exist at data loaded time (this is hooked continuously by PBR until it does exist but TH does not do this so it occasionally CTDs on the nullptr resolution). TH doesn't actually need this since it only replaces parallax texture in the shader, not diffuse/normal, so it is simply removed.
• As a default texture set is required for terrain helper, this also adds an enabled bool which only enables if the plugin's record was found on data loaded. Otherwise the hooks will do nothing and terrain helper will do nothing, which is intentional.

In the future I would like to unify the default texture set system with PBR but need to do this in a non-breaking way to existing PBR terrain mods so I will think about that some more.

Summary by CodeRabbit

• New Features

  • Terrain helper functionality is now automatically enabled only when the required texture set is detected, ensuring it runs only when compatible mods are loaded.

• Bug Fixes

  • Prevented terrain helper features from running if the necessary texture set is missing, improving stability and reducing unwanted warnings.

[coderabbitai]

Walkthrough

A boolean enabled flag was introduced to the TerrainHelper class to control its activation based on the presence of a specific texture set. Methods now check this flag and exit early if disabled, preventing terrain helper logic from running unless the required conditions are met.

Changes

File(s)	Change Summary
src/Features/TerrainHelper.cpp	Added enabled flag logic; methods now exit early if enabled is false.
src/Features/TerrainHelper.h	Added bool enabled = false; member to TerrainHelper.

Sequence Diagram(s)

sequenceDiagram
    participant Game as Game Engine
    participant TerrainHelper as TerrainHelper

    Game->>TerrainHelper: DataLoaded()
    TerrainHelper->>TerrainHelper: Check for "LandscapeDefault" texture set
    alt Texture set found
        TerrainHelper->>TerrainHelper: enabled = true
    else Texture set not found
        TerrainHelper->>TerrainHelper: enabled = false
        TerrainHelper->>Game: Log warning
    end

    Game->>TerrainHelper: TESObjectLAND_SetupMaterial()
    alt enabled == false
        TerrainHelper-->>Game: Return early (no processing)
    else enabled == true
        TerrainHelper->>TerrainHelper: Proceed with material setup
    end

    Game->>TerrainHelper: BSLightingShader_SetupMaterial()
    alt enabled == false
        TerrainHelper-->>Game: Return early (no processing)
    else enabled == true
        TerrainHelper->>TerrainHelper: Proceed with material setup
    end

Loading

Possibly related PRs

• fix: support seasons swaps in PBR and TerrainHelper #1099: Modifies order and seasonal swap handling in TerrainHelper's TESObjectLAND_SetupMaterial, affecting related functions but not the enabled gating logic.

Suggested reviewers

• alandtse

Poem

In fields of code where textures lie,
A helper checks, then passes by—
If landscapes found, it hops along,
If not, it sings a warning song.
Enabled now, or else it sleeps,
The rabbit guards what terrain keeps! 🐇

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6479240 and 8c56be7.

📒 Files selected for processing (2)

• src/Features/TerrainHelper.cpp (2 hunks)
• src/Features/TerrainHelper.h (1 hunks)

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

• GitHub Check: Build plugin and addons

🔇 Additional comments (4)

src/Features/TerrainHelper.h (1)

44-44: LGTM! Clean addition of the enabled flag.

The boolean flag is appropriately initialized to false and will control whether the terrain helper functionality is active. This aligns perfectly with the PR objective to only activate the feature when the plugin is detected.

src/Features/TerrainHelper.cpp (3)

33-38: LGTM! Proper gating mechanism implementation.

The logic correctly enables the terrain helper only when the "LandscapeDefault" texture set is found, indicating the TerrainHelper.esp plugin is loaded. The warning message provides clear feedback when the plugin is not detected, and the feature remains disabled as intended.

---

43-46: LGTM! Clean early exit implementation.

The early exit guard prevents terrain material setup processing when the feature is disabled. Returning false appropriately indicates that no material setup was performed, which aligns with the method's contract.

---

155-158: LGTM! Consistent early exit pattern.

The early exit guard prevents shader material setup when the terrain helper is disabled, maintaining consistency with the other gated method. This ensures no terrain helper logic executes when the plugin is not detected.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

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]

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