Changes

{{../../header}}

{{../../header}}

SMAPI can add custom commands to the SMAPI console, which players can type to do certain actions. These are also available in the in-game chat for players using the {{nexus mod|2092|Chat Commands}} mod.

You can add commands to the SMAPI console (the terminal window that opens alongside the game), and invoke them by typing directly into the console. Note that most players aren't comfortable with a command-line interface, so you should prefer in-game interfaces for player-facing features.

Each console command must have:

Each console command must have:

* a name which the player types to invoke the command.

* A name which the player types to invoke the command.

* a description shown when the player uses the <tt>help</tt> command. This should explain what the command does, how to use it, and what arguments it accepts. The example below shows the recommended convention.

* A description shown when the player uses the <samp>help</samp> command. This should explain what the command does, how to use it, and what arguments it accepts. The example below shows the recommended convention.

* the code to run when the command is called.

* The method to call when the command is entered.

The code below creates a <tt>player_setmoney</tt> command (but don't forget to validate input, this is just an example).

This code creates a minimal <samp>player_setmoney</samp> command:

<source lang="C#">

<syntaxhighlight lang="C#">

public override void Entry(IModHelper helper)

/// <summary>The main entry point for the mod.</summary>

public class ModEntry : Mod

{

{

  helper.ConsoleCommands.Add("player_setmoney", "Sets the player's money.\n\nUsage: player_setmoney <value>\n- value: the integer amount.", this.SetMoney);

}

        helper.ConsoleCommands.Add("player_setmoney", "Sets the player's money.\n\nUsage: player_setmoney <value>\n- value: the integer amount.", this.SetMoney);

    }

 

/// <summary>Set the player's money when the 'player_setmoney' command is invoked.</summary>

/// <param name="command">The name of the command invoked.</param>

/// <param name="args">The arguments received by the command. Each word after the command name is a separate argument.</param>

private void SetMoney(string command, string[] args)

    /// <summary>Set the player's money when the 'player_setmoney' command is invoked.</summary>

{

    /// <param name="command">The name of the command invoked.</param>

  Game1.player.money = int.Parse(args[0]);

    /// <param name="args">The arguments received by the command. Each word after the command name is a separate argument.</param>

  this.Monitor.Log($"OK, set your money to {args[0]}.");

    private void SetMoney(string command, string[] args)

    {

        Game1.player.Money = int.Parse(args[0]);

        this.Monitor.Log($"OK, set your money to {args[0]}.", LogLevel.Info);

}

}

</source>

</syntaxhighlight>

Here's how the player would use it:

Here's how the player would use it:

> OK, set your money to 5000.

> OK, set your money to 5000.

</pre>

</pre>