summaryrefslogtreecommitdiff
path: root/src/SMAPI/Framework/Commands/IInternalCommand.cs
diff options
context:
space:
mode:
Diffstat (limited to 'src/SMAPI/Framework/Commands/IInternalCommand.cs')
-rw-r--r--src/SMAPI/Framework/Commands/IInternalCommand.cs24
1 files changed, 24 insertions, 0 deletions
diff --git a/src/SMAPI/Framework/Commands/IInternalCommand.cs b/src/SMAPI/Framework/Commands/IInternalCommand.cs
new file mode 100644
index 00000000..abf105b6
--- /dev/null
+++ b/src/SMAPI/Framework/Commands/IInternalCommand.cs
@@ -0,0 +1,24 @@
+namespace StardewModdingAPI.Framework.Commands
+{
+ /// <summary>A core SMAPI console command.</summary>
+ interface IInternalCommand
+ {
+ /*********
+ ** Accessors
+ *********/
+ /// <summary>The command name, which the user must type to trigger it.</summary>
+ string Name { get; }
+
+ /// <summary>The human-readable documentation shown when the player runs the built-in 'help' command.</summary>
+ string Description { get; }
+
+
+ /*********
+ ** Methods
+ *********/
+ /// <summary>Handle the console command when it's entered by the user.</summary>
+ /// <param name="args">The command arguments.</param>
+ /// <param name="monitor">Writes messages to the console.</param>
+ void HandleCommand(string[] args, IMonitor monitor);
+ }
+}