Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ifBars merged 2 commits into from
Oct 2, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a08d22d
feat(saveables): expose public saveable base with legacy compatibility
ifBars Oct 2, 2026
50c7208
docs(abstraction): retain only registerable and saveable documentation
ifBars Oct 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions S1API/Internal/Abstraction/Registerable.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
namespace S1API.Internal.Abstraction
{
/// <summary>
/// INTERNAL: A registerable base class for use internally.
/// Not intended for modder use.
/// Infrastructure base class for S1API registration and lifecycle hooks.
/// </summary>
/// <remarks>
/// This class is public because public API classes inherit from it.
/// Modders should inherit from the appropriate API base class, such as
/// <c>NPC</c>, <c>Quest</c>, or <c>Saveable</c>, rather than this infrastructure class directly.
/// </remarks>
public abstract class Registerable : IRegisterable
{
/// <summary>
Expand Down
9 changes: 8 additions & 1 deletion S1API/Internal/Abstraction/Saveable.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,15 @@
namespace S1API.Internal.Abstraction
{
/// <summary>
/// Generic wrapper for saveable classes.
/// Base class for mod data persisted in the game's save slots.
/// </summary>
/// <remarks>
/// This is a supported modder-facing API despite its <c>S1API.Internal.Abstraction</c> namespace.
/// Inherit from this class for standalone mod save data and mark fields with
/// <see cref="SaveableField"/>. Override <see cref="OnLoaded"/> and <see cref="OnSaved"/>
/// to respond to persistence events, and <see cref="LoadOrder"/> to control load timing.
/// API classes such as <c>NPC</c> and <c>Quest</c> already inherit this persistence support.
/// </remarks>
public abstract class Saveable : Registerable, ISaveable
{
/// <summary>
Expand Down
Loading