From ad8912047beaf84ce34f4918703d55841be13ff0 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sat, 26 Mar 2022 01:43:40 -0400 Subject: add asset edit priority (#766) --- src/SMAPI/Events/AssetEditPriority.cs | 16 ++++++++++++++++ src/SMAPI/Events/AssetRequestedEventArgs.cs | 4 +++- 2 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 src/SMAPI/Events/AssetEditPriority.cs (limited to 'src/SMAPI/Events') diff --git a/src/SMAPI/Events/AssetEditPriority.cs b/src/SMAPI/Events/AssetEditPriority.cs new file mode 100644 index 00000000..d41dfd7d --- /dev/null +++ b/src/SMAPI/Events/AssetEditPriority.cs @@ -0,0 +1,16 @@ +namespace StardewModdingAPI.Events +{ + /// The priority for an asset edit when multiple apply for the same asset. + /// You can also specify arbitrary intermediate values, like AssetLoadPriority.Low + 5. + public enum AssetEditPriority + { + /// This edit should be applied before (i.e. 'under') edits. + Early = -1000, + + /// The default priority. + Default = 0, + + /// This edit should be applied after (i.e. 'on top of') edits. + Late = 1000 + } +} diff --git a/src/SMAPI/Events/AssetRequestedEventArgs.cs b/src/SMAPI/Events/AssetRequestedEventArgs.cs index 9e2cde7f..4d9ee236 100644 --- a/src/SMAPI/Events/AssetRequestedEventArgs.cs +++ b/src/SMAPI/Events/AssetRequestedEventArgs.cs @@ -100,6 +100,7 @@ namespace StardewModdingAPI.Events /// Edit the asset after it's loaded. /// Apply changes to the asset. + /// If there are multiple edits that apply to the same asset, the priority with which this one should be applied. /// The content pack ID on whose behalf you're applying the change. This is only valid for content packs for your mod. /// /// Usage notes: @@ -108,11 +109,12 @@ namespace StardewModdingAPI.Events /// You can apply any number of edits to the asset. Each edit will be applied on top of the previous one (i.e. it'll see the merged asset from all previous edits as its input). /// /// - public void Edit(Action apply, string onBehalfOf = null) + public void Edit(Action apply, AssetEditPriority priority = AssetEditPriority.Default, string onBehalfOf = null) { this.EditOperations.Add( new AssetEditOperation( mod: this.Mod, + priority: priority, onBehalfOf: this.GetOnBehalfOf(this.Mod, onBehalfOf, "edit assets"), apply ) -- cgit