src/SMAPI/Framework/Commands/IInternalCommand.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

#nullable disable

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);
    }
}