blob: be8290eb4640b23cb2bbec4a3a9581b811d5b9ae (
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
|
using System;
namespace StardewModdingAPI
{
/// <summary>Encapsulates access and changes to content being read from a data file.</summary>
public interface IContentEventHelper
{
/*********
** Accessors
*********/
/// <summary>The content's locale code, if the content is localised.</summary>
string Locale { get; }
/// <summary>The normalised asset name being read. The format may change between platforms; see <see cref="IsAssetName"/> to compare with a known path.</summary>
string AssetName { get; }
/// <summary>The content data being read.</summary>
object Data { get; }
/*********
** Public methods
*********/
/// <summary>Get whether the asset name being loaded matches a given name after normalisation.</summary>
/// <param name="path">The expected asset path, relative to the game's content folder and without the .xnb extension or locale suffix (like 'Data\ObjectInformation').</param>
bool IsAssetName(string path);
/// <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>
TData GetData<TData>();
/// <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>
void SetDictionaryEntry<TKey, TValue>(TKey key, TValue 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>
void SetDictionaryEntry<TKey, TValue>(TKey key, Func<TValue, TValue> value);
/// <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>
void ReplaceWith(object value);
}
}
|
