diff options
Diffstat (limited to 'src/StardewModdingAPI.AssemblyRewriters/IInstructionRewriter.cs')
| -rw-r--r-- | src/StardewModdingAPI.AssemblyRewriters/IInstructionRewriter.cs | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/src/StardewModdingAPI.AssemblyRewriters/IInstructionRewriter.cs b/src/StardewModdingAPI.AssemblyRewriters/IInstructionRewriter.cs index b230f227..3a7b1365 100644 --- a/src/StardewModdingAPI.AssemblyRewriters/IInstructionRewriter.cs +++ b/src/StardewModdingAPI.AssemblyRewriters/IInstructionRewriter.cs @@ -3,10 +3,17 @@ using Mono.Cecil.Cil; namespace StardewModdingAPI.AssemblyRewriters { - /// <summary>Rewrites a CIL instruction for compatibility.</summary> - public interface IInstructionRewriter : IInstructionFinder + /// <summary>Rewrites CIL instructions for compatibility.</summary> + public interface IInstructionRewriter { /********* + ** Accessors + *********/ + /// <summary>A brief noun phrase indicating what the rewriter matches.</summary> + string NounPhrase { get; } + + + /********* ** Methods *********/ /// <summary>Rewrite a CIL instruction for compatibility.</summary> @@ -14,6 +21,9 @@ namespace StardewModdingAPI.AssemblyRewriters /// <param name="cil">The CIL rewriter.</param> /// <param name="instruction">The instruction to rewrite.</param> /// <param name="assemblyMap">Metadata for mapping assemblies to the current platform.</param> - void Rewrite(ModuleDefinition module, ILProcessor cil, Instruction instruction, PlatformAssemblyMap assemblyMap); + /// <param name="platformChanged">Whether the mod was compiled on a different platform.</param> + /// <returns>Returns whether the instruction was rewritten.</returns> + /// <exception cref="IncompatibleInstructionException">The CIL instruction is not compatible, and can't be rewritten.</exception> + bool Rewrite(ModuleDefinition module, ILProcessor cil, Instruction instruction, PlatformAssemblyMap assemblyMap, bool platformChanged); } } |