summaryrefslogtreecommitdiff
path: root/src/TrainerMod/Framework/Commands/ITrainerCommand.cs
diff options
context:
space:
mode:
Diffstat (limited to 'src/TrainerMod/Framework/Commands/ITrainerCommand.cs')
-rw-r--r--src/TrainerMod/Framework/Commands/ITrainerCommand.cs34
1 files changed, 34 insertions, 0 deletions
diff --git a/src/TrainerMod/Framework/Commands/ITrainerCommand.cs b/src/TrainerMod/Framework/Commands/ITrainerCommand.cs
new file mode 100644
index 00000000..3d97e799
--- /dev/null
+++ b/src/TrainerMod/Framework/Commands/ITrainerCommand.cs
@@ -0,0 +1,34 @@
+using StardewModdingAPI;
+
+namespace TrainerMod.Framework.Commands
+{
+ /// <summary>A TrainerMod command to register.</summary>
+ internal interface ITrainerCommand
+ {
+ /*********
+ ** Accessors
+ *********/
+ /// <summary>The command name the user must type.</summary>
+ string Name { get; }
+
+ /// <summary>The command description.</summary>
+ string Description { get; }
+
+ /// <summary>Whether the command needs to perform logic when the game updates.</summary>
+ bool NeedsUpdate { get; }
+
+
+ /*********
+ ** Public methods
+ *********/
+ /// <summary>Handle the command.</summary>
+ /// <param name="monitor">Writes messages to the console and log file.</param>
+ /// <param name="command">The command name.</param>
+ /// <param name="args">The command arguments.</param>
+ void Handle(IMonitor monitor, string command, ArgumentParser args);
+
+ /// <summary>Perform any logic needed on update tick.</summary>
+ /// <param name="monitor">Writes messages to the console and log file.</param>
+ void Update(IMonitor monitor);
+ }
+}