Class ConsoleCommand

A custom console command

Inheritance

System.Object

ConsoleCommand

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: JotunnLib.Entities

Assembly: JotunnLib.dll

Syntax

public abstract class ConsoleCommand

Properties

Help

The help text that will be displayed to the user for your command when they type help into their console.

Declaration

public abstract string Help { get; }

Property Value

Type	Description
System.String

Name

The command that the user will need to type in their console to run your command.

Declaration

public abstract string Name { get; }

Property Value

Type	Description
System.String

Methods

Run(String[])

The function that will be called when the user runs your console command, with space-delimited arguments.

Declaration

public abstract void Run(string[] args)

Parameters

Type	Name	Description
System.String[]	args	The arguments the user types, with spaces being the delimiter.