S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

IConsoleCommandManager

Registers console commands owned by the current mod.

View source ↗
CMAPI 1.0.0Standalone runtimeWindows x64Tested with Planet Crafter 2.008
Namespace CMAPIInterfaceAssembly CMAPI.API.dll
public interface IConsoleCommandManager

Registers console commands owned by the current mod.

Members

AddRegisters a command whose usage is just its name.methodAddRegisters a command with explicit usage text.methodAddRegisters a command with catalog metadata and optional aliases.methodRemoveRemoves a command previously registered by the current mod.method

Add

method
void Add( string name, string description, ConsoleCommandHandler handler )

Registers a command whose usage is just its name.

Add

method
void Add( string name, string description, string usage, ConsoleCommandHandler handler )

Registers a command with explicit usage text.

Add

method
void Add( string name, string description, ConsoleCommandOptions options, ConsoleCommandHandler handler )

Registers a command with catalog metadata and optional aliases.

Remove

method
bool Remove(string name)

Removes a command previously registered by the current mod.