using System;
using System.IO;
using Microsoft.Xna.Framework.Content;
using Microsoft.Xna.Framework.Graphics;
using StardewModdingAPI.Toolkit.Serialisation;
using StardewModdingAPI.Toolkit.Utilities;
using xTile;
namespace StardewModdingAPI.Framework
{
/// Manages access to a content pack's metadata and files.
internal class ContentPack : IContentPack
{
/*********
** Fields
*********/
/// Provides an API for loading content assets.
private readonly IContentHelper Content;
/// Encapsulates SMAPI's JSON file parsing.
private readonly JsonHelper JsonHelper;
/*********
** Accessors
*********/
/// The full path to the content pack's folder.
public string DirectoryPath { get; }
/// The content pack's manifest.
public IManifest Manifest { get; }
/// Provides translations stored in the content pack's i18n folder. See for more info.
public ITranslationHelper Translation { get; }
/*********
** Public methods
*********/
/// Construct an instance.
/// The full path to the content pack's folder.
/// The content pack's manifest.
/// Provides an API for loading content assets.
/// Provides translations stored in the content pack's i18n folder.
/// Encapsulates SMAPI's JSON file parsing.
public ContentPack(string directoryPath, IManifest manifest, IContentHelper content, ITranslationHelper translation, JsonHelper jsonHelper)
{
this.DirectoryPath = directoryPath;
this.Manifest = manifest;
this.Content = content;
this.Translation = translation;
this.JsonHelper = jsonHelper;
}
/// Get whether a given file exists in the content pack.
/// The file path to check.
public bool HasFile(string path)
{
this.AssertRelativePath(path, nameof(this.HasFile));
return File.Exists(Path.Combine(this.DirectoryPath, path));
}
/// Read a JSON file from the content pack folder.
/// The model type.
/// The file path relative to the contnet directory.
/// Returns the deserialised model, or null if the file doesn't exist or is empty.
/// The is not relative or contains directory climbing (../).
public TModel ReadJsonFile(string path) where TModel : class
{
this.AssertRelativePath(path, nameof(this.ReadJsonFile));
path = Path.Combine(this.DirectoryPath, PathUtilities.NormalisePathSeparators(path));
return this.JsonHelper.ReadJsonFileIfExists(path, out TModel model)
? model
: null;
}
/// Save data to a JSON file in the content pack's folder.
/// The model type. This should be a plain class that has public properties for the data you want. The properties can be complex types.
/// The file path relative to the mod folder.
/// The arbitrary data to save.
/// The is not relative or contains directory climbing (../).
public void WriteJsonFile(string path, TModel data) where TModel : class
{
this.AssertRelativePath(path, nameof(this.WriteJsonFile));
path = Path.Combine(this.DirectoryPath, PathUtilities.NormalisePathSeparators(path));
this.JsonHelper.WriteJsonFile(path, data);
}
/// Load content from the content pack folder (if not already cached), and return it. When loading a .png file, this must be called outside the game's draw loop.
/// The expected data type. The main supported types are , , and dictionaries; other types may be supported by the game's content pipeline.
/// The local path to a content file relative to the content pack folder.
/// The is empty or contains invalid characters.
/// The content asset couldn't be loaded (e.g. because it doesn't exist).
public T LoadAsset(string key)
{
return this.Content.Load(key, ContentSource.ModFolder);
}
/// Get the underlying key in the game's content cache for an asset. This can be used to load custom map tilesheets, but should be avoided when you can use the content API instead. This does not validate whether the asset exists.
/// The the local path to a content file relative to the content pack folder.
/// The is empty or contains invalid characters.
public string GetActualAssetKey(string key)
{
return this.Content.GetActualAssetKey(key, ContentSource.ModFolder);
}
/*********
** Private methods
*********/
/// Assert that a relative path was passed it to a content pack method.
/// The path to check.
/// The name of the method which was invoked.
private void AssertRelativePath(string path, string methodName)
{
if (!PathUtilities.IsSafeRelativePath(path))
throw new InvalidOperationException($"You must call {nameof(IContentPack)}.{methodName} with a relative path.");
}
}
}