summaryrefslogtreecommitdiff
path: root/src/SMAPI/Framework/Commands/IInternalCommand.cs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2020-06-20 12:43:08 -0400
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2020-06-20 12:43:08 -0400
commite64ecc89f94641d4054162eff4943f660f43030f (patch)
treec43ca79f9947b3e16f946e1dc5fd1d02f70ce571 /src/SMAPI/Framework/Commands/IInternalCommand.cs
parentdf6e745c6b842290338317ed1d3e969ee222998c (diff)
parentcb9ff7019995eff92104703f097856d2523e02ce (diff)
downloadSMAPI-e64ecc89f94641d4054162eff4943f660f43030f.tar.gz
SMAPI-e64ecc89f94641d4054162eff4943f660f43030f.tar.bz2
SMAPI-e64ecc89f94641d4054162eff4943f660f43030f.zip
Merge branch 'develop' into stable
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);
+ }
+}