GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • S1API

This view

  • Original page
  • New address

GeezerVison is showing ifbars.github.io — Class BaseConsoleCommand | S1API Documentation

Table of Contents

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.

Edit this page
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.