Skip to content

docs(abstraction): clarify Registerable and Saveable usage - #344

Merged
ifBars merged 2 commits into
betafrom
feat/beta-saveable-namespace
Oct 2, 2026
Merged

ifBars merged 2 commits into
betafrom
feat/beta-saveable-namespace

Conversation

@ifBars

@ifBars ifBars commented Oct 2, 2026 •

Copy link
Copy Markdown
Owner

Linked issue

Refs #343

Contributor checklist

  • I linked an issue opened before this PR.
  • I checked existing issues and PRs for duplicate or overlapping work.
  • This PR addresses one focused problem or request.

Summary

Clarify the intended use of the existing public abstraction classes:

  • Registerable is public because public API classes inherit it. Modders should use the appropriate API base class rather than inherit this infrastructure class directly.
  • Saveable is a supported modder-facing persistence base despite its internal namespace. Its documentation now describes standalone save data, SaveableField, lifecycle callbacks, load timing, and inherited NPC/quest persistence support.

The final diff contains only XML comments in these two existing files.

Compatibility

  • Public/protected API: No changes to types, namespaces, inheritance, accessibility, attributes, signatures, or virtual member shape.
  • Existing defaults and behavior: Unchanged; executable source matches the beta baseline.
  • Stable IDs, saves, and network payloads: Unchanged.
  • Source and binary compatibility are unchanged. No namespace migration, deprecation, IntelliSense attributes, compatibility shim, or planned type removal is introduced.

Validation

Mono

dotnet restore S1API/S1API.csproj -p:Configuration=MonoMelon -p:AutomateLocalDeployment=false

dotnet build S1API/S1API.csproj -c MonoMelon --no-restore -p:AutomateLocalDeployment=false

Build passed with zero warnings/errors.

IL2CPP

Matching restore/build with Il2CppMelon passed with zero warnings/errors. Local deployment was disabled.

Runtime evidence

No gameplay smoke or contract-suite rerun was needed for the final documentation-only scope. Verified that every added/removed line against beta baseline beed831 is an XML comment. The diff against that baseline passes whitespace checks.

Documentation

Update the class summaries and remarks for S1API.Internal.Abstraction.Registerable and S1API.Internal.Abstraction.Saveable.

@coderabbitai

coderabbitai Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Advanced

Run ID: b66ff5ad-173d-4ca7-852a-5d2fd0bf1b91

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


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

Comment @coderabbitai help to get the list of available commands.

@ifBars ifBars added saveables Native game save system beta A game update on the beta & alternate-beta steam branches labels Oct 2, 2026
@ifBars ifBars changed the title feat(saveables): expose public Saveable with legacy compatibility docs(abstraction): clarify Registerable and Saveable usage Oct 2, 2026
@ifBars ifBars added the documentation Improvements or additions to documentation label Oct 2, 2026
@ifBars
ifBars merged commit c3ec3a2 into beta Oct 2, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

beta A game update on the beta & alternate-beta steam branches documentation Improvements or additions to documentation saveables Native game save system

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant