113 lines
3.8 KiB
C++
113 lines
3.8 KiB
C++
/**
|
|
* vim: set ts=4 :
|
|
* ===============================================================
|
|
* SourceMod, Copyright (C) 2004-2007 AlliedModders LLC.
|
|
* All rights reserved.
|
|
* ===============================================================
|
|
*
|
|
* This file is part of the SourceMod/SourcePawn SDK. This file may only be
|
|
* used or modified under the Terms and Conditions of its License Agreement,
|
|
* which is found in public/licenses/LICENSE.txt. As of this notice, derivative
|
|
* works must be licensed under the GNU General Public License (version 2 or
|
|
* greater). A copy of the GPL is included under public/licenses/GPL.txt.
|
|
*
|
|
* To view the latest information, see: http://www.sourcemod.net/license.php
|
|
*
|
|
* Version: $Id$
|
|
*/
|
|
|
|
#ifndef _INCLUDE_SOURCEMOD_ROOT_CONSOLE_MENU_H_
|
|
#define _INCLUDE_SOURCEMOD_ROOT_CONSOLE_MENU_H_
|
|
|
|
/**
|
|
* @file IRootConsoleMenu.h
|
|
* @brief Defines the interface for adding options to the "sm" console command.
|
|
*
|
|
* This interface is not yet exported. It will be eventually. The initial reason should
|
|
* be obvious: we do not want users actually touching it. If we exposed this, every little
|
|
* plugin would be dropping down a silly set of user commands, and exploiting/cluttering the menu.
|
|
* Since this menu is explicitly provided for stuff that only Core itself is capable of managing,
|
|
* we won't expose it until a legitimate reason comes up.
|
|
*/
|
|
|
|
namespace SourceMod
|
|
{
|
|
/**
|
|
* @brief Handles a root console menu action.
|
|
*/
|
|
class IRootConsoleCommand
|
|
{
|
|
public:
|
|
virtual void OnRootConsoleCommand(const char *command, unsigned int argcount) =0;
|
|
};
|
|
|
|
/**
|
|
* @brief Manages the root console menu - the "sm" command for servers.
|
|
*/
|
|
class IRootConsole
|
|
{
|
|
public:
|
|
/**
|
|
* @brief Adds a root console command handler. The command must be unique.
|
|
*
|
|
* @param cmd String containing the console command.
|
|
* @param text Description text.
|
|
* @param pHandler An IRootConsoleCommand pointer to handle the command.
|
|
* @return True on success, false on too many commands or duplicate command.
|
|
*/
|
|
virtual bool AddRootConsoleCommand(const char *cmd, const char *text, IRootConsoleCommand *pHandler) =0;
|
|
|
|
/**
|
|
* @brief Removes a root console command handler.
|
|
*
|
|
* @param cmd String containing the console command.
|
|
* @param pHandler An IRootConsoleCommand pointer for verification.
|
|
* @return True on success, false otherwise.
|
|
*/
|
|
virtual bool RemoveRootConsoleCommand(const char *cmd, IRootConsoleCommand *pHandler) =0;
|
|
|
|
/**
|
|
* @brief Prints text back to the console.
|
|
*
|
|
* @param fmt Format of string.
|
|
* @param ... Format arguments.
|
|
*/
|
|
virtual void ConsolePrint(const char *fmt, ...) =0;
|
|
|
|
/**
|
|
* @brief Returns the string of an argument.
|
|
*
|
|
* @param argno The index of the argument.
|
|
* @return A string containing the argument, or nothing if invalid.
|
|
*/
|
|
virtual const char *GetArgument(unsigned int argno) =0;
|
|
|
|
/**
|
|
* @brief Returns the number of arguments.
|
|
*
|
|
* @return Number of arguments.
|
|
*/
|
|
virtual unsigned int GetArgumentCount() =0;
|
|
|
|
/**
|
|
* @brief Returns the entire argument string.
|
|
*
|
|
* @return String containing all arguments.
|
|
*/
|
|
virtual const char *GetArguments() =0;
|
|
|
|
/**
|
|
* @brief Draws a generic command/description pair.
|
|
* NOTE: The pair is currently four spaces indented and 16-N spaces of separation,
|
|
* N being the length of the command name. This is subject to change in case we
|
|
* account for Valve's font choices.
|
|
*
|
|
* @param cmd String containing the command option.
|
|
* @param text String containing the command description.
|
|
*/
|
|
virtual void DrawGenericOption(const char *cmd, const char *text) =0;
|
|
};
|
|
}
|
|
|
|
#endif //_INCLUDE_SOURCEMOD_ROOT_CONSOLE_MENU_H_
|