Class BaseConsoleCommand

Namespace

S1API.Console

Assembly

S1API.dll

Abstract base class for creating console commands. Inherit from this base class to auto-register a custom command in the API.

public abstract class BaseConsoleCommand

Inheritance

object

BaseConsoleCommand

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ReflectionUtils.GetValueTupleItems(object)

ReflectionUtils.IsValueTuple(object)

Constructors

BaseConsoleCommand()

protected BaseConsoleCommand()

Properties

CommandDescription

A brief description of what the command does.

public abstract string CommandDescription { get; }

Property Value

string

CommandWord

The command word that triggers this console command.

public abstract string CommandWord { get; }

Property Value

string

ExampleUsage

An example of how to use the command.

public abstract string ExampleUsage { get; }

Property Value

string

Methods

ExecuteCommand(List<string>)

Executes the command with the provided arguments.

public abstract void ExecuteCommand(List<string> args)

Parameters

args List<string>

The list of arguments passed to the command.