summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/Framework/ModHelpers/CommandHelper.cs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <github@jplamondonw.com>2017-10-07 23:07:10 -0400
committerJesse Plamondon-Willard <github@jplamondonw.com>2017-10-07 23:07:10 -0400
commit929dccb75a1405737975d76648e015a3e7c00177 (patch)
tree659fe16509327e694555db363caf7f47f326443b /src/StardewModdingAPI/Framework/ModHelpers/CommandHelper.cs
parent926894f8f52c2a5cf104fcac2f7f34b637f7b531 (diff)
downloadSMAPI-929dccb75a1405737975d76648e015a3e7c00177.tar.gz
SMAPI-929dccb75a1405737975d76648e015a3e7c00177.tar.bz2
SMAPI-929dccb75a1405737975d76648e015a3e7c00177.zip
reorganise repo structure
Diffstat (limited to 'src/StardewModdingAPI/Framework/ModHelpers/CommandHelper.cs')
-rw-r--r--src/StardewModdingAPI/Framework/ModHelpers/CommandHelper.cs54
1 files changed, 0 insertions, 54 deletions
diff --git a/src/StardewModdingAPI/Framework/ModHelpers/CommandHelper.cs b/src/StardewModdingAPI/Framework/ModHelpers/CommandHelper.cs
deleted file mode 100644
index bdedb07c..00000000
--- a/src/StardewModdingAPI/Framework/ModHelpers/CommandHelper.cs
+++ /dev/null
@@ -1,54 +0,0 @@
-using System;
-
-namespace StardewModdingAPI.Framework.ModHelpers
-{
- /// <summary>Provides an API for managing console commands.</summary>
- internal class CommandHelper : BaseHelper, ICommandHelper
- {
- /*********
- ** Accessors
- *********/
- /// <summary>The friendly mod name for this instance.</summary>
- private readonly string ModName;
-
- /// <summary>Manages console commands.</summary>
- private readonly CommandManager CommandManager;
-
-
- /*********
- ** Public methods
- *********/
- /// <summary>Construct an instance.</summary>
- /// <param name="modID">The unique ID of the relevant mod.</param>
- /// <param name="modName">The friendly mod name for this instance.</param>
- /// <param name="commandManager">Manages console commands.</param>
- public CommandHelper(string modID, string modName, CommandManager commandManager)
- : base(modID)
- {
- this.ModName = modName;
- 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>
- public ICommandHelper Add(string name, string documentation, Action<string, string[]> callback)
- {
- this.CommandManager.Add(this.ModName, 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>
- public bool Trigger(string name, string[] arguments)
- {
- return this.CommandManager.Trigger(name, arguments);
- }
- }
-}