Modding:Console commands/cmd

Introduction

This template is used on Modding:Console commands to generate automatic anchor links and provide a consistent format for command documentation.

Template parameters

• command - The command name; if it has aliases, separate with commas. Clearest name should be listed first.
• params - Any parameters, separated by commas. Use the T template for required parameters and O template for optional ones. If there are no parameters, the Syntax line will not be printed.
• desc - The full description.
• example - Any examples, separated by semi-colons. These should include the full command (including "debug") in a code block along with a description of the expected result.

Examples:

Command with no aliases, parameters, or examples

{{/cmd
  | command = everythingshop 
  | desc    = Opens a shop menu containing a furniture [[catalogue]], all objects, all craftables, and all weapons. All items are free.
}}

command	description
everythingshop	Opens a shop menu containing a furniture catalogue, all objects, all craftables, and all weapons. All items are free.	#

Command with aliases only

{{/cmd
  | command = clear,ci
  | desc    = Removes all items currently in your inventory.
}}

command	description
clear, ci	Removes all items currently in your inventory.	#

Command with parameter but no examples

{{/cmd
  | command = backpack
  | params  = {{t|I:amount}}
  | desc    = Increases your inventory space by the specified amount; capped at 36 slots.
}}

command	description
backpack	Syntax: backpack <I:amount> Increases your inventory space by the specified amount; capped at 36 slots.	#

Command with single example

{{/cmd
  |command = bigitem,big,bi,b
  |params  = {{t|I:itemID}}
  |desc    = Adds the specified craftable to your inventory. See [[Modding:Big craftables data|big craftables data]] for a list of base game IDs.
  |example = <code>debug bigitem 12</code> would give you a [[keg]].
}}

command	description
bigitem, big, bi, b	Syntax: bigitem <I:itemID> Adds the specified craftable to your inventory. See big craftables data for a list of base game IDs. Example: debug bigitem 12 would give you a keg.	#

Command with everything (aliases, multiple parameters, and multiple examples)

{{/cmd
  |command = fuzzyitemnamed,fin,f
  |params  = {{t|S:itemName}},{{o|I:amount}},{{o|I:quality}}
  |desc    = Adds the specified item to your inventory. This is a fuzzy search and the game will look through objects, craftables, furniture, weapons, boots, hats, and clothes to match it. There is no reliable way to use names with spaces or differentiate items with the same name, so not all items can be accessed with this command. The optional parameters are for stack amount (defaults is 1) and quality (default is 0.)
  |example = <code>debug fuzzyitemnamed sturg 5 4</code> would give you a stack of five Iridium-quality [[Sturgeon]].; <code>debug fin galaxy</code> would give you a [[Galaxy Sword]].; <code>debug f grief</code> would give you a [[Shirts|"Good Grief" Shirt]].
}}

command	description
fuzzyitemnamed, fin, f	Syntax: fuzzyitemnamed <S:itemName> [I:amount] [I:quality] Adds the specified item to your inventory. This is a fuzzy search and the game will look through objects, craftables, furniture, weapons, boots, hats, and clothes to match it. There is no reliable way to use names with spaces or differentiate items with the same name, so not all items can be accessed with this command. The optional parameters are for stack amount (defaults is 1) and quality (default is 0.) Examples: debug fuzzyitemnamed sturg 5 4 would give you a stack of five Iridium-quality Sturgeon. debug fin galaxy would give you a Galaxy Sword. debug f grief would give you a "Good Grief" Shirt.	#