SMAPI/StardewModdingAPI/Mod.cs

51 lines
1.7 KiB
C#
Raw Normal View History

using System.IO;
2016-02-28 19:55:35 +08:00
namespace StardewModdingAPI
{
public class Mod
{
/// <summary>
/// The mod's manifest
2016-02-28 19:55:35 +08:00
/// </summary>
public Manifest Manifest { get; internal set; }
2016-02-28 19:55:35 +08:00
/// <summary>
/// Where the mod is located on the disk.
/// </summary>
public string PathOnDisk { get; internal set; }
2016-03-23 08:36:04 +08:00
/// <summary>
/// A basic path to store your mod's config at.
2016-03-23 08:36:04 +08:00
/// </summary>
public string BaseConfigPath => PathOnDisk + "\\config.json";
/// <summary>
/// A basic path to where per-save configs are stored
2016-03-23 08:36:04 +08:00
/// </summary>
public string PerSaveConfigFolder => GetPerSaveConfigFolder();
/// <summary>
/// A basic path to store your mod's config at, dependent on the current save.
/// The Manifest must allow for per-save configs. This is to keep from having an
/// empty directory in every mod folder.
2016-03-23 08:36:04 +08:00
/// </summary>
public string PerSaveConfigPath => Constants.CurrentSavePathExists ? Path.Combine(PerSaveConfigFolder, Constants.SaveFolderName + ".json") : "";
2016-02-28 19:55:35 +08:00
/// <summary>
/// A basic method that is the entry-point of your mod. It will always be called once when the mod loads.
2016-02-28 19:55:35 +08:00
/// </summary>
2016-03-04 03:01:32 +08:00
public virtual void Entry(params object[] objects)
2016-02-28 19:55:35 +08:00
{
}
2016-03-23 08:36:04 +08:00
private string GetPerSaveConfigFolder()
{
if (Manifest.PerSaveConfigs)
{
return Path.Combine(PathOnDisk, "psconfigs");
}
Log.AsyncR($"The mod [{Manifest.Name}] is not configured to use per-save configs.");
2016-03-23 08:36:04 +08:00
return "";
}
2016-02-28 19:55:35 +08:00
}
}