tModLoader  0.12 Alpha
A mod to make and play Terraria mods
Terraria.ModLoader.ModCommand Class Referenceabstract

This class represents a chat or console command. Use the CommandType to specify the scope of the command. More...

Inherits Terraria.ModLoader.ModType.

Inherited by Terraria.ModLoader.Default.HelpCommand, and Terraria.ModLoader.Default.ModlistCommand.

Public Member Functions

abstract void Action (CommandCaller caller, string input, string[] args)
 The code that is executed when the command is triggered. More...
 
sealed override void SetupContent ()
 If you make a new ModType, seal this override, and call SetStaticDefaults in it. More...
 
- Public Member Functions inherited from Terraria.ModLoader.ModType
virtual bool IsLoadingEnabled (Mod mod)
 Allows you to stop Mod.AddContent from actually adding this content. Useful for items that can be disabled by a config. More...
 
virtual void Load ()
 Allows you to perform one-time loading tasks. Beware that mod content has not finished loading here, things like ModContent lookup tables or ID Sets are not fully populated. More...
 
virtual void SetStaticDefaults ()
 Allows you to modify the properties after initial loading has completed. More...
 
virtual void Unload ()
 Allows you to safely unload things you added in Load. More...
 

Protected Member Functions

override sealed void Register ()
 If you make a new ModType, seal this override. More...
 

Properties

abstract string Command [get]
 The desired text to trigger this command. More...
 
virtual string Description [get]
 A short description of this command. More...
 
abstract CommandType Type [get]
 A flag enum representing context where this command operates. More...
 
virtual string Usage [get]
 A short usage explanation for this command. More...
 
- Properties inherited from Terraria.ModLoader.ModType
string FullName [get]
 The internal name of this, including the mod it is from. More...
 
Mod Mod [get, set]
 The mod this belongs to. More...
 
virtual string Name [get]
 The internal name of this. More...
 
- Properties inherited from Terraria.ModLoader.IModType
string FullName [get]
 => $"{Mod.Name}/{Name}" More...
 
Mod Mod [get]
 The mod this belongs to. More...
 
string Name [get]
 The internal name of this instance. More...
 

Detailed Description

This class represents a chat or console command. Use the CommandType to specify the scope of the command.

Member Function Documentation

◆ Action()

abstract void Terraria.ModLoader.ModCommand.Action ( CommandCaller  caller,
string  input,
string[]  args 
)
pure virtual

The code that is executed when the command is triggered.

◆ Register()

override sealed void Terraria.ModLoader.ModCommand.Register ( )
protectedvirtual

If you make a new ModType, seal this override.

Implements Terraria.ModLoader.ModType.

◆ SetupContent()

sealed override void Terraria.ModLoader.ModCommand.SetupContent ( )
virtual

If you make a new ModType, seal this override, and call SetStaticDefaults in it.

Reimplemented from Terraria.ModLoader.ModType.

Property Documentation

◆ Command

abstract string Terraria.ModLoader.ModCommand.Command
get

The desired text to trigger this command.

◆ Description

virtual string Terraria.ModLoader.ModCommand.Description
get

A short description of this command.

◆ Type

abstract CommandType Terraria.ModLoader.ModCommand.Type
get

A flag enum representing context where this command operates.

◆ Usage

virtual string Terraria.ModLoader.ModCommand.Usage
get

A short usage explanation for this command.