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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
using System;
using System.Collections.Generic;
using System.Text.RegularExpressions;
using Microsoft.Xna.Framework.Graphics;
namespace StardewModdingAPI.Framework
{
/// <summary>Encapsulates access and changes to content being read from a data file.</summary>
internal class ContentEventHelper : EventArgs, IContentEventHelper
{
/*********
** Properties
*********/
/// <summary>Normalises an asset key to match the cache key.</summary>
private readonly Func<string, string> GetNormalisedPath;
/*********
** Accessors
*********/
/// <summary>The normalised asset path being read. The format may change between platforms; see <see cref="IsPath"/> to compare with a known path.</summary>
public string Path { get; }
/// <summary>The content data being read.</summary>
public object Data { get; private set; }
/*********
** Public methods
*********/
/// <summary>Construct an instance.</summary>
/// <param name="path">The file path being read.</param>
/// <param name="data">The content data being read.</param>
/// <param name="getNormalisedPath">Normalises an asset key to match the cache key.</param>
public ContentEventHelper(string path, object data, Func<string, string> getNormalisedPath)
{
this.Path = path;
this.Data = data;
this.GetNormalisedPath = getNormalisedPath;
}
/// <summary>Get whether the asset path being loaded matches a given path after normalisation.</summary>
/// <param name="path">The expected asset path, relative to the game folder and without the .xnb extension (like 'Data\ObjectInformation').</param>
/// <param name="matchLocalisedVersion">Whether to match a localised version of the asset file (like 'Data\ObjectInformation.ja-JP').</param>
public bool IsPath(string path, bool matchLocalisedVersion = true)
{
path = this.GetNormalisedPath(path);
// equivalent
if (this.Path.Equals(path, StringComparison.InvariantCultureIgnoreCase))
return true;
// localised version
if (matchLocalisedVersion)
{
return
this.Path.StartsWith($"{path}.", StringComparison.InvariantCultureIgnoreCase) // starts with given path
&& Regex.IsMatch(this.Path.Substring(path.Length + 1), "^[a-z]+-[A-Z]+$"); // ends with locale (e.g. pt-BR)
}
// no match
return false;
}
/// <summary>Get the data as a given type.</summary>
/// <typeparam name="TData">The expected data type.</typeparam>
/// <exception cref="InvalidCastException">The data can't be converted to <typeparamref name="TData"/>.</exception>
public TData GetData<TData>()
{
if (!(this.Data is TData))
throw new InvalidCastException($"The content data of type {this.Data.GetType().FullName} can't be converted to the requested {typeof(TData).FullName}.");
return (TData)this.Data;
}
/// <summary>Add or replace an entry in the dictionary data.</summary>
/// <typeparam name="TKey">The entry key type.</typeparam>
/// <typeparam name="TValue">The entry value type.</typeparam>
/// <param name="key">The entry key.</param>
/// <param name="value">The entry value.</param>
/// <exception cref="InvalidOperationException">The content being read isn't a dictionary.</exception>
public void SetDictionaryEntry<TKey, TValue>(TKey key, TValue value)
{
IDictionary<TKey, TValue> data = this.GetData<Dictionary<TKey, TValue>>();
data[key] = value;
}
/// <summary>Add or replace an entry in the dictionary data.</summary>
/// <typeparam name="TKey">The entry key type.</typeparam>
/// <typeparam name="TValue">The entry value type.</typeparam>
/// <param name="key">The entry key.</param>
/// <param name="value">A callback which accepts the current value and returns the new value.</param>
/// <exception cref="InvalidOperationException">The content being read isn't a dictionary.</exception>
public void SetDictionaryEntry<TKey, TValue>(TKey key, Func<TValue, TValue> value)
{
IDictionary<TKey, TValue> data = this.GetData<Dictionary<TKey, TValue>>();
data[key] = value(data[key]);
}
/// <summary>Replace the entire content value with the given value. This is generally not recommended, since it may break compatibility with other mods or different versions of the game.</summary>
/// <param name="value">The new content value.</param>
/// <exception cref="ArgumentNullException">The <paramref name="value"/> is null.</exception>
/// <exception cref="InvalidCastException">The <paramref name="value"/>'s type is not compatible with the loaded asset's type.</exception>
public void ReplaceWith(object value)
{
if (value == null)
throw new ArgumentNullException(nameof(value), "Can't set a loaded asset to a null value.");
if (!this.Data.GetType().IsInstanceOfType(value))
throw new InvalidCastException($"Can't replace loaded asset of type {this.GetFriendlyTypeName(this.Data.GetType())} with value of type {this.GetFriendlyTypeName(value.GetType())}. The new type must be compatible to prevent game errors.");
this.Data = value;
}
/*********
** Private methods
*********/
/// <summary>Get a human-readable type name.</summary>
/// <param name="type">The type to name.</param>
private string GetFriendlyTypeName(Type type)
{
// dictionary
if (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(Dictionary<,>))
{
Type[] genericArgs = type.GetGenericArguments();
return $"Dictionary<{this.GetFriendlyTypeName(genericArgs[0])}, {this.GetFriendlyTypeName(genericArgs[1])}>";
}
// texture
if (type == typeof(Texture2D))
return type.Name;
// native type
if (type == typeof(int))
return "int";
if (type == typeof(string))
return "string";
// default
return type.FullName;
}
}
}
|
