Class ConsoleCommand
A custom console command.
Inheritance
ConsoleCommand
Assembly: Jotunn.dll
Syntax
public abstract class ConsoleCommand : CustomEntity
Properties
Name |
Description |
Help
|
The help text that will be displayed to the user for your command when they type `help` into their console. |
IsCheat
|
If true, this command will only work after `devcommands` is run in the console. |
IsNetwork
|
If true, this command will be allowed in networked play. |
IsSecret
|
If true, this command will not be shown when the user types `help` into their console. |
Name
|
The command that the user will need to type in their console to run your command. |
OnlyServer
|
If true, and IsNetwork is true, this command will be allowed in networked play, but only for the server. |
Methods
Name |
Description |
CommandOptionList()
|
Override this function to return a list of strings that are valid options for your command |
Run(string[])
|
The function that will be called when the user runs your console command, with space-delimited arguments. |
ToString()
|
Returns a string that represents the current object. |
Extension Methods