summaryrefslogtreecommitdiff
path: root/src/SMAPI/Framework/ModHelpers/CommandHelper.cs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2020-09-07 13:06:27 -0400
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2020-09-07 13:06:27 -0400
commit5e43bdbf5cd6dbab36c25287c85d42ccfeea2c83 (patch)
tree0a42305174eb84561a584549cd685c5e95670f36 /src/SMAPI/Framework/ModHelpers/CommandHelper.cs
parent8da88b8fe5b41739c5cd0df3280b9770fc7f10a4 (diff)
parentf9fac11028354f15d786d5b854608edb10716f79 (diff)
downloadSMAPI-5e43bdbf5cd6dbab36c25287c85d42ccfeea2c83.tar.gz
SMAPI-5e43bdbf5cd6dbab36c25287c85d42ccfeea2c83.tar.bz2
SMAPI-5e43bdbf5cd6dbab36c25287c85d42ccfeea2c83.zip
Merge branch 'develop' into stable
Diffstat (limited to 'src/SMAPI/Framework/ModHelpers/CommandHelper.cs')
-rw-r--r--src/SMAPI/Framework/ModHelpers/CommandHelper.cs13
1 files changed, 2 insertions, 11 deletions
diff --git a/src/SMAPI/Framework/ModHelpers/CommandHelper.cs b/src/SMAPI/Framework/ModHelpers/CommandHelper.cs
index e9d53d84..600f867f 100644
--- a/src/SMAPI/Framework/ModHelpers/CommandHelper.cs
+++ b/src/SMAPI/Framework/ModHelpers/CommandHelper.cs
@@ -28,23 +28,14 @@ namespace StardewModdingAPI.Framework.ModHelpers
this.CommandManager = commandManager;
}
- /// <summary>Add a console command.</summary>
- /// <param name="name">The command name, which the user must type to trigger it.</param>
- /// <param name="documentation">The human-readable documentation shown when the player runs the built-in 'help' command.</param>
- /// <param name="callback">The method to invoke when the command is triggered. This method is passed the command name and arguments submitted by the user.</param>
- /// <exception cref="ArgumentNullException">The <paramref name="name"/> or <paramref name="callback"/> is null or empty.</exception>
- /// <exception cref="FormatException">The <paramref name="name"/> is not a valid format.</exception>
- /// <exception cref="ArgumentException">There's already a command with that name.</exception>
+ /// <inheritdoc />
public ICommandHelper Add(string name, string documentation, Action<string, string[]> callback)
{
this.CommandManager.Add(this.Mod, name, documentation, callback);
return this;
}
- /// <summary>Trigger a command.</summary>
- /// <param name="name">The command name.</param>
- /// <param name="arguments">The command arguments.</param>
- /// <returns>Returns whether a matching command was triggered.</returns>
+ /// <inheritdoc />
public bool Trigger(string name, string[] arguments)
{
return this.CommandManager.Trigger(name, arguments);