Interface ICommandService

Namespace: SwiftlyS2.Shared.Commands

Assembly: SwiftlyS2.CS2.dll

public interface ICommandService

Methods

GetAllCommands()

Gets all registered commands by plugins.

List<string> GetAllCommands()

• List<string>

GetAllCommandsByPlugin()

Gets all plugins that have registered commands.

Dictionary<string, List<CommandInfo>> GetAllCommandsByPlugin()

• Dictionary<string, List<CommandInfo>> — Dictionary mapping plugin names to their registered command information.

GetAllCommandsInfo()

Gets all commands info for the commands registered by plugins.

List<CommandInfo> GetAllCommandsInfo()

• List<CommandInfo> — List of command information registered by the plugin.

GetCommandsByPlugin(string)

Gets all commands registered by a specific plugin.

List<CommandInfo> GetCommandsByPlugin(string pluginName)

• pluginName string — The name of the plugin.

• List<CommandInfo> — List of command information registered by the plugin.

HookClientChat(ClientChatHandler)

Hooks client chat, will be fired when a player sends any chat message.

Guid HookClientChat(ICommandService.ClientChatHandler handler)

• handler ICommandService.ClientChatHandler — The handler callback for the client chat.

• Guid

HookClientCommand(ClientCommandHandler)

Hooks client commands, will be fired when a player sends any command.

Guid HookClientCommand(ICommandService.ClientCommandHandler handler)

• handler ICommandService.ClientCommandHandler — The handler callback for the client command.

• Guid

IsCommandRegistered(string)

Checks if a command is registered.

bool IsCommandRegistered(string commandName)

• commandName string — The command name.

• bool — Whether the command is registered.

RegisterCommand(string, CommandListener, bool, string)

Registers a command (backward compatibility overload).

Guid RegisterCommand(string commandName, ICommandService.CommandListener handler, bool registerRaw, string permission)

• commandName string — The command name.
• handler ICommandService.CommandListener — The handler callback for the command.
• registerRaw bool — If set to true, the command will not starts with a sw_ prefix.
• permission string — The permission required to use the command.

• Guid — The guid of the command.

RegisterCommand(string, CommandListener, bool, string, string)

Registers a command.

Guid RegisterCommand(string commandName, ICommandService.CommandListener handler, bool registerRaw = false, string permission = "", string helpText = "SwiftlyS2 registered command")

• commandName string — The command name.
• handler ICommandService.CommandListener — The handler callback for the command.
• registerRaw bool — If set to true, the command will not starts with a sw_ prefix.
• permission string — The permission required to use the command.
• helpText string — The help text of the command.

• Guid — The guid of the command.

RegisterCommandAlias(string, string, bool)

Registers a command alias.

void RegisterCommandAlias(string commandName, string alias, bool registerRaw = false)

• commandName string — The command name.
• alias string — The alias.
• registerRaw bool — If set to true, the alias will not starts with a sw_ prefix.

UnhookClientChat(Guid)

Unhooks a client chat.

void UnhookClientChat(Guid guid)

• guid Guid — The guid of the client chat.

UnhookClientCommand(Guid)

Unhooks a client command.

void UnhookClientCommand(Guid guid)

• guid Guid — The guid of the client command.

UnregisterCommand(Guid)

Unregisters a command.

void UnregisterCommand(Guid guid)

• guid Guid — The guid of the command.

UnregisterCommand(string)

Unregisters all command listeners with the specified command name.

void UnregisterCommand(string commandName)

• commandName string — The command name.