![]() |
Terraria ModLoader
0.11.1
A framework for Terraria mods
|
This class represents a chat or console command. Use the CommandType to specify the scope of the command. More...
Public Member Functions | |
abstract void | Action (CommandCaller caller, string input, string[] args) |
The code that is executed when the command is triggered. More... | |
virtual bool | Autoload (ref string name) |
Autoload this command, defaults to Mod.Properties.Autoload. More... | |
Public Attributes | |
virtual string | Description => "" |
A short description of this command. More... | |
virtual string | Usage => "/" + Command |
A short usage explanation for this command. More... | |
Properties | |
abstract string | Command [get] |
The desired text to trigger this command. More... | |
Mod | mod [get, set] |
The Mod this ModCommand belongs to. More... | |
string | Name [get, set] |
Internal name of this command. More... | |
abstract CommandType | Type [get] |
A flag enum representing context where this command operates. More... | |
This class represents a chat or console command. Use the CommandType to specify the scope of the command.
Definition at line 31 of file ModCommand.cs.
|
pure virtual |
The code that is executed when the command is triggered.
Referenced by Terraria.ModLoader.CommandManager.Matches().
|
virtual |
Autoload this command, defaults to Mod.Properties.Autoload.
virtual string Terraria.ModLoader.ModCommand.Description => "" |
A short description of this command.
Definition at line 44 of file ModCommand.cs.
virtual string Terraria.ModLoader.ModCommand.Usage => "/" + Command |
A short usage explanation for this command.
Definition at line 42 of file ModCommand.cs.
|
get |
The desired text to trigger this command.
Definition at line 38 of file ModCommand.cs.
Referenced by Terraria.ModLoader.CommandManager.GetHelp(), and Terraria.ModLoader.CommandManager.Matches().
|
getset |
The Mod this ModCommand belongs to.
Definition at line 34 of file ModCommand.cs.
Referenced by Terraria.ModLoader.Mod.AddCommand().
|
getset |
Internal name of this command.
Definition at line 36 of file ModCommand.cs.
Referenced by Terraria.ModLoader.Mod.AddCommand().
|
get |
A flag enum representing context where this command operates.
Definition at line 40 of file ModCommand.cs.