summaryrefslogtreecommitdiff
path: root/src/SMAPI/Framework/ModHelpers/ModContentHelper.cs
blob: 74ea73de69cc02889189ec785e8b9ae330d77aa3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
using System;
using Microsoft.Xna.Framework.Content;
using StardewModdingAPI.Framework.Content;
using StardewModdingAPI.Framework.ContentManagers;
using StardewModdingAPI.Framework.Exceptions;
using StardewModdingAPI.Framework.Reflection;
using StardewModdingAPI.Toolkit.Utilities.PathLookups;

namespace StardewModdingAPI.Framework.ModHelpers
{
    /// <inheritdoc cref="IModContentHelper"/>
    internal class ModContentHelper : BaseHelper, IModContentHelper
    {
        /*********
        ** Fields
        *********/
        /// <summary>SMAPI's core content logic.</summary>
        private readonly ContentCoordinator ContentCore;

        /// <summary>A content manager for this mod which manages files from the mod's folder.</summary>
        private readonly ModContentManager ModContentManager;

        /// <summary>The friendly mod name for use in errors.</summary>
        private readonly string ModName;

        /// <summary>A lookup for relative paths within the <see cref="ContentManager.RootDirectory"/>.</summary>
        private readonly IFilePathLookup RelativePathLookup;

        /// <summary>Simplifies access to private code.</summary>
        private readonly Reflector Reflection;


        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        /// <param name="contentCore">SMAPI's core content logic.</param>
        /// <param name="modFolderPath">The absolute path to the mod folder.</param>
        /// <param name="mod">The mod using this instance.</param>
        /// <param name="modName">The friendly mod name for use in errors.</param>
        /// <param name="gameContentManager">The game content manager used for map tilesheets not provided by the mod.</param>
        /// <param name="relativePathLookup">A lookup for relative paths within the <paramref name="relativePathLookup"/>.</param>
        /// <param name="reflection">Simplifies access to private code.</param>
        public ModContentHelper(ContentCoordinator contentCore, string modFolderPath, IModMetadata mod, string modName, IContentManager gameContentManager, IFilePathLookup relativePathLookup, Reflector reflection)
            : base(mod)
        {
            string managedAssetPrefix = contentCore.GetManagedAssetPrefix(mod.Manifest.UniqueID);

            this.ContentCore = contentCore;
            this.ModContentManager = contentCore.CreateModContentManager(managedAssetPrefix, modName, modFolderPath, gameContentManager);
            this.ModName = modName;
            this.RelativePathLookup = relativePathLookup;
            this.Reflection = reflection;
        }

        /// <inheritdoc />
        public T Load<T>(string relativePath)
            where T : notnull
        {
            relativePath = this.RelativePathLookup.GetAssetName(relativePath);

            IAssetName assetName = this.ContentCore.ParseAssetName(relativePath, allowLocales: false);

            try
            {
                return this.ModContentManager.LoadExact<T>(assetName, useCache: false);
            }
            catch (Exception ex) when (ex is not SContentLoadException)
            {
                throw new SContentLoadException($"{this.ModName} failed loading content asset '{relativePath}' from its mod folder.", ex);
            }
        }

        /// <inheritdoc />
        public IAssetName GetInternalAssetName(string relativePath)
        {
            relativePath = this.RelativePathLookup.GetAssetName(relativePath);
            return this.ModContentManager.GetInternalAssetKey(relativePath);
        }

        /// <inheritdoc />
        public IAssetData GetPatchHelper<T>(T data, string? relativePath = null)
            where T : notnull
        {
            if (data == null)
                throw new ArgumentNullException(nameof(data), "Can't get a patch helper for a null value.");

            relativePath = relativePath != null
                ? this.RelativePathLookup.GetAssetName(relativePath)
                : $"temp/{Guid.NewGuid():N}";

            return new AssetDataForObject(
                locale: this.ContentCore.GetLocale(),
                assetName: this.ContentCore.ParseAssetName(relativePath, allowLocales: false),
                data: data,
                getNormalizedPath: key => this.ContentCore.ParseAssetName(key, allowLocales: false).Name,
                reflection: this.Reflection
            );
        }
    }
}