S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

ConsoleCommandOptions

Describes how a console command appears in CMAPI's command catalog.

View source ↗
CMAPI 1.0.0Standalone runtimeWindows x64Tested with Planet Crafter 2.008
Namespace CMAPIClassAssembly CMAPI.API.dll
public sealed class ConsoleCommandOptions

Describes how a console command appears in CMAPI's command catalog.

Members

UsageGets the full syntax shown by help <command>.propertyCategoryGets the catalog category used to group the command.propertyAliasesGets the optional alternative names which run the command.propertyConsoleCommandOptionsCreates catalog metadata in the default Mods category.methodConsoleCommandOptionsCreates catalog metadata with a category and optional aliases.method

Usage

property
public string Usage

Gets the full syntax shown by help <command>.

Category

property
public string Category

Gets the catalog category used to group the command.

Aliases

property
public IReadOnlyList<string> Aliases

Gets the optional alternative names which run the command.

ConsoleCommandOptions

method
public ConsoleCommandOptions(string usage) : this(usage, "Mods")

Creates catalog metadata in the default Mods category.

ConsoleCommandOptions

method
public ConsoleCommandOptions( string usage, string category, params string[] aliases)

Creates catalog metadata with a category and optional aliases.