src/TrainerMod/Framework/Commands/ITrainerCommand.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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, string[] 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);
    }
}