expand obsolete attributes (#766)
This commit is contained in:
parent
5683bc9c7d
commit
eebd8d54dc
|
@ -77,7 +77,7 @@ namespace StardewModdingAPI
|
|||
public static GameFramework GameFramework { get; } = EarlyConstants.GameFramework;
|
||||
|
||||
/// <summary>The path to the game folder.</summary>
|
||||
[Obsolete($"Use {nameof(Constants)}.{nameof(GamePath)} instead.")]
|
||||
[Obsolete($"Use {nameof(Constants)}.{nameof(GamePath)} instead. This property will be removed in SMAPI 4.0.0.")]
|
||||
public static string ExecutionPath
|
||||
{
|
||||
get
|
||||
|
|
|
@ -26,7 +26,7 @@ namespace StardewModdingAPI.Framework.Content
|
|||
public IAssetName NameWithoutLocale { get; }
|
||||
|
||||
/// <inheritdoc />
|
||||
[Obsolete($"Use {nameof(Name)} or {nameof(NameWithoutLocale)} instead.")]
|
||||
[Obsolete($"Use {nameof(Name)} or {nameof(NameWithoutLocale)} instead. This property will be removed in SMAPI 4.0.0.")]
|
||||
public string AssetName
|
||||
{
|
||||
get
|
||||
|
@ -64,7 +64,7 @@ namespace StardewModdingAPI.Framework.Content
|
|||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
[Obsolete($"Use {nameof(Name)}.{nameof(IAssetName.IsEquivalentTo)} or {nameof(NameWithoutLocale)}.{nameof(IAssetName.IsEquivalentTo)} instead.")]
|
||||
[Obsolete($"Use {nameof(Name)}.{nameof(IAssetName.IsEquivalentTo)} or {nameof(NameWithoutLocale)}.{nameof(IAssetName.IsEquivalentTo)} instead. This method will be removed in SMAPI 4.0.0.")]
|
||||
public bool AssetNameEquals(string path)
|
||||
{
|
||||
SCore.DeprecationManager.Warn(
|
||||
|
|
|
@ -6,7 +6,7 @@ namespace StardewModdingAPI
|
|||
public enum GameFramework
|
||||
{
|
||||
/// <summary>The XNA Framework, previously used on Windows.</summary>
|
||||
[Obsolete("Stardew Valley no longer uses XNA Framework on any supported platform.")]
|
||||
[Obsolete("Stardew Valley no longer uses XNA Framework on any supported platform. This value will be removed in SMAPI 4.0.0.")]
|
||||
Xna,
|
||||
|
||||
/// <summary>The MonoGame framework.</summary>
|
||||
|
|
|
@ -1,6 +1,10 @@
|
|||
namespace StardewModdingAPI
|
||||
using System;
|
||||
using StardewModdingAPI.Events;
|
||||
|
||||
namespace StardewModdingAPI
|
||||
{
|
||||
/// <summary>Edits matching content assets.</summary>
|
||||
[Obsolete($"Use {nameof(IMod.Helper)}.{nameof(IModHelper.Events)}.{nameof(IModEvents.Content)} instead. This interface will be removed in SMAPI 4.0.0.")]
|
||||
public interface IAssetEditor
|
||||
{
|
||||
/*********
|
||||
|
|
|
@ -20,7 +20,7 @@ namespace StardewModdingAPI
|
|||
public IAssetName NameWithoutLocale { get; }
|
||||
|
||||
/// <summary>The normalized asset name being read. The format may change between platforms; see <see cref="AssetNameEquals"/> to compare with a known path.</summary>
|
||||
[Obsolete($"Use {nameof(Name)} or {nameof(NameWithoutLocale)} instead.")]
|
||||
[Obsolete($"Use {nameof(Name)} or {nameof(NameWithoutLocale)} instead. This property will be removed in SMAPI 4.0.0.")]
|
||||
string AssetName { get; }
|
||||
|
||||
/// <summary>The content data type.</summary>
|
||||
|
@ -32,7 +32,7 @@ namespace StardewModdingAPI
|
|||
*********/
|
||||
/// <summary>Get whether the asset name being loaded matches a given name after normalization.</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>
|
||||
[Obsolete($"Use {nameof(Name)}.{nameof(IAssetName.IsEquivalentTo)} or {nameof(NameWithoutLocale)}.{nameof(IAssetName.IsEquivalentTo)} instead.")]
|
||||
[Obsolete($"Use {nameof(Name)}.{nameof(IAssetName.IsEquivalentTo)} or {nameof(NameWithoutLocale)}.{nameof(IAssetName.IsEquivalentTo)} instead. This method will be removed in SMAPI 4.0.0.")]
|
||||
bool AssetNameEquals(string path);
|
||||
}
|
||||
}
|
||||
|
|
|
@ -1,6 +1,10 @@
|
|||
namespace StardewModdingAPI
|
||||
using System;
|
||||
using StardewModdingAPI.Events;
|
||||
|
||||
namespace StardewModdingAPI
|
||||
{
|
||||
/// <summary>Provides the initial version for matching assets loaded by the game. SMAPI will raise an error if two mods try to load the same asset; in most cases you should use <see cref="IAssetEditor"/> instead.</summary>
|
||||
[Obsolete($"Use {nameof(IMod.Helper)}.{nameof(IModHelper.Events)}.{nameof(IModEvents.Content)} instead. This interface will be removed in SMAPI 4.0.0.")]
|
||||
public interface IAssetLoader
|
||||
{
|
||||
/*********
|
||||
|
|
|
@ -21,7 +21,7 @@ namespace StardewModdingAPI
|
|||
/// <param name="name">The command name.</param>
|
||||
/// <param name="arguments">The command arguments.</param>
|
||||
/// <returns>Returns whether a matching command was triggered.</returns>
|
||||
[Obsolete("Manually triggering console commands will no longer be supported in SMAPI 4.0.0.")]
|
||||
[Obsolete("Use mod-provided APIs to integrate with mods instead. This method will be removed in SMAPI 4.0.0.")]
|
||||
bool Trigger(string name, string[] arguments);
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue