diff --git a/S1API/Internal/Abstraction/Registerable.cs b/S1API/Internal/Abstraction/Registerable.cs index e0b9b920..9383c441 100644 --- a/S1API/Internal/Abstraction/Registerable.cs +++ b/S1API/Internal/Abstraction/Registerable.cs @@ -1,9 +1,13 @@ namespace S1API.Internal.Abstraction { /// - /// INTERNAL: A registerable base class for use internally. - /// Not intended for modder use. + /// Infrastructure base class for S1API registration and lifecycle hooks. /// + /// + /// This class is public because public API classes inherit from it. + /// Modders should inherit from the appropriate API base class, such as + /// NPC, Quest, or Saveable, rather than this infrastructure class directly. + /// public abstract class Registerable : IRegisterable { /// diff --git a/S1API/Internal/Abstraction/Saveable.cs b/S1API/Internal/Abstraction/Saveable.cs index f0886f69..a93ea17d 100644 --- a/S1API/Internal/Abstraction/Saveable.cs +++ b/S1API/Internal/Abstraction/Saveable.cs @@ -25,8 +25,15 @@ namespace S1API.Internal.Abstraction { /// - /// Generic wrapper for saveable classes. + /// Base class for mod data persisted in the game's save slots. /// + /// + /// This is a supported modder-facing API despite its S1API.Internal.Abstraction namespace. + /// Inherit from this class for standalone mod save data and mark fields with + /// . Override and + /// to respond to persistence events, and to control load timing. + /// API classes such as NPC and Quest already inherit this persistence support. + /// public abstract class Saveable : Registerable, ISaveable { ///