[Breaking change] refactor(IMaaContext): make pipelineOverride an optional trailing parameter

Author: moomiji

src/MaaFramework.Binding.Native/MaaContext.cs

@@ -31,7 +31,7 @@ public MaaContext(MaaContextHandle contextHandle)
     /// <remarks>
     ///     Wrapper of <see cref="MaaContextRunTask"/>.
     /// </remarks>
-    public TaskDetail? RunTask(string entry, [StringSyntax("Json")] string pipelineOverride)
+    public TaskDetail? RunTask(string entry, [StringSyntax("Json")] string pipelineOverride = "{}")
     {
         var taskId = MaaContextRunTask(Handle, entry, pipelineOverride);
         return taskId == Interop.Native.MaaDef.MaaInvalidId
@@ -40,14 +40,14 @@ public MaaContext(MaaContextHandle contextHandle)
     }
 
     /// <inheritdoc/>
-    public RecognitionDetail? RunRecognition(string entry, [StringSyntax("Json")] string pipelineOverride, IMaaImageBuffer image)
-        => RunRecognition(entry, pipelineOverride, (MaaImageBuffer)image);
+    public RecognitionDetail? RunRecognition(string entry, IMaaImageBuffer image, [StringSyntax("Json")] string pipelineOverride = "{}")
+        => RunRecognition(entry, (MaaImageBuffer)image, pipelineOverride);
 
     /// <inheritdoc cref="IMaaContext.RunRecognition"/>
     /// <remarks>
     ///     Wrapper of <see cref="MaaContextRunRecognition"/>.
     /// </remarks>
-    public RecognitionDetail? RunRecognition(string entry, [StringSyntax("Json")] string pipelineOverride, MaaImageBuffer image)
+    public RecognitionDetail? RunRecognition(string entry, MaaImageBuffer image, [StringSyntax("Json")] string pipelineOverride = "{}")
     {
         ArgumentNullException.ThrowIfNull(image);
         var recognitionId = MaaContextRunRecognition(Handle, entry, pipelineOverride, image.Handle);
@@ -57,14 +57,14 @@ public MaaContext(MaaContextHandle contextHandle)
     }
 
     /// <inheritdoc/>
-    public NodeDetail? RunAction(string entry, [StringSyntax("Json")] string pipelineOverride, IMaaRectBuffer recognitionBox, string recognitionDetail)
-        => RunAction(entry, pipelineOverride, (MaaRectBuffer)recognitionBox, recognitionDetail);
+    public NodeDetail? RunAction(string entry, IMaaRectBuffer recognitionBox, string recognitionDetail, [StringSyntax("Json")] string pipelineOverride = "{}")
+        => RunAction(entry, (MaaRectBuffer)recognitionBox, recognitionDetail, pipelineOverride);
 
     /// <inheritdoc cref="IMaaContext.RunAction"/>
     /// <remarks>
     ///     Wrapper of <see cref="MaaContextRunAction"/>.
     /// </remarks>
-    public NodeDetail? RunAction(string entry, [StringSyntax("Json")] string pipelineOverride, MaaRectBuffer recognitionBox, string recognitionDetail)
+    public NodeDetail? RunAction(string entry, MaaRectBuffer recognitionBox, string recognitionDetail, [StringSyntax("Json")] string pipelineOverride = "{}")
     {
         ArgumentNullException.ThrowIfNull(recognitionBox);
         var nodeId = MaaContextRunAction(Handle, entry, pipelineOverride, recognitionBox.Handle, recognitionDetail);

src/MaaFramework.Binding.UnitTests/Test_Custom.cs

@@ -46,7 +46,7 @@ public bool Analyze(in IMaaContext context, in AnalyzeArgs args, in AnalyzeResul
 #endif
             Assert.IsNotNull(cloneContext);
             Assert.IsNull(
-                cloneContext.RunRecognition(DiffEntry, "{}", (IMaaImageBuffer<nint>)args.Image));
+                cloneContext.RunRecognition(DiffEntry, args.Image));
             if (!context.Tasker.IsStateless)
             {
                 Assert.AreSame(
@@ -57,7 +57,7 @@ public bool Analyze(in IMaaContext context, in AnalyzeArgs args, in AnalyzeResul
                 context.TaskJob.Id, cloneContext.TaskJob.Id);
 
             var recognitionDetail =
-                context.RunRecognition(DiffEntry, DiffParam, args.Image);
+                context.RunRecognition(DiffEntry, args.Image, DiffParam);
             Assert.IsNotNull(
                 recognitionDetail?.HitBox);
 
@@ -106,7 +106,7 @@ public bool Run(in IMaaContext context, in RunArgs args)
             Assert.AreNotEqual(Detail, args.RecognitionDetail.Detail);
             Assert.AreEqual(Box, $"{args.RecognitionBox.X}{args.RecognitionBox.Y}{args.RecognitionBox.Width}{args.RecognitionBox.Height}");
 
-            var nodeDetail = context.RunAction(DiffEntry, DiffParam, args.RecognitionBox, args.RecognitionDetail.Detail);
+            var nodeDetail = context.RunAction(DiffEntry, args.RecognitionBox, args.RecognitionDetail.Detail, DiffParam);
             Assert.IsNotNull(nodeDetail);
             return true;
         }

src/MaaFramework.Binding/IMaaContext.cs

@@ -26,28 +26,28 @@ public interface IMaaContext : ICloneable
     /// <param name="entry">The entry name of the task.</param>
     /// <param name="pipelineOverride">The json used to override the pipeline.</param>
     /// <returns><see cref="TaskDetail"/> if the operation was executed successfully; otherwise, <see langword="null"/>.</returns>
-    TaskDetail? RunTask(string entry, [StringSyntax("Json")] string pipelineOverride);
+    TaskDetail? RunTask(string entry, [StringSyntax("Json")] string pipelineOverride = "{}");
 
     /// <summary>
     ///     Run a recognition.
     /// </summary>
     /// <param name="entry">The recognition entry name.</param>
-    /// <param name="pipelineOverride">The json used to override the pipeline.</param>
     /// <param name="image">The image to be recognized.</param>
+    /// <param name="pipelineOverride">The json used to override the pipeline.</param>
     /// <returns><see cref="RecognitionDetail"/> if the operation was executed successfully; otherwise, <see langword="null"/>.</returns>
     /// <exception cref="ArgumentNullException"/>
-    RecognitionDetail? RunRecognition(string entry, [StringSyntax("Json")] string pipelineOverride, IMaaImageBuffer image);
+    RecognitionDetail? RunRecognition(string entry, IMaaImageBuffer image, [StringSyntax("Json")] string pipelineOverride = "{}");
 
     /// <summary>
     ///     Run an action.
     /// </summary>
     /// <param name="entry">The action entry name.</param>
-    /// <param name="pipelineOverride">The json used to override the pipeline.</param>
     /// <param name="recognitionBox">The rect buffer containing current rect in the recognition result.</param>
     /// <param name="recognitionDetail">The rect detail in the recognition result.</param>
+    /// <param name="pipelineOverride">The json used to override the pipeline.</param>
     /// <returns><see cref="NodeDetail"/> if the operation was executed successfully; otherwise, <see langword="null"/>.</returns>
     /// <exception cref="ArgumentNullException"/>
-    NodeDetail? RunAction(string entry, [StringSyntax("Json")] string pipelineOverride, IMaaRectBuffer recognitionBox, string recognitionDetail);
+    NodeDetail? RunAction(string entry, IMaaRectBuffer recognitionBox, [StringSyntax("Json")] string recognitionDetail, [StringSyntax("Json")] string pipelineOverride = "{}");
 
     /// <summary>
     ///     Override a pipeline.