diff options
Diffstat (limited to 'src/StardewModdingAPI/Advanced/IConfigFile.cs')
-rw-r--r-- | src/StardewModdingAPI/Advanced/IConfigFile.cs | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/src/StardewModdingAPI/Advanced/IConfigFile.cs b/src/StardewModdingAPI/Advanced/IConfigFile.cs new file mode 100644 index 00000000..78fd44a6 --- /dev/null +++ b/src/StardewModdingAPI/Advanced/IConfigFile.cs @@ -0,0 +1,25 @@ +namespace StardewModdingAPI.Advanced +{ + /// <summary>Wraps a configuration file with IO methods for convenience.</summary> + public interface IConfigFile + { + /********* + ** Accessors + *********/ + /// <summary>Provides methods for interacting with the mod directory, including read/writing the config file.</summary> + ModHelper ModHelper { get; set; } + + /// <summary>The file path from which the model was loaded, relative to the mod directory.</summary> + string FilePath { get; set; } + + + /********* + ** Methods + *********/ + /// <summary>Reparse the underlying file and update this model.</summary> + void Reload(); + + /// <summary>Save this model to the underlying file.</summary> + void Save(); + } +} |