|
ds@1952
|
1 |
/** |
|
ds@1952
|
2 |
* vim: set ts=4 : |
|
ds@1952
|
3 |
* ============================================================================= |
|
ds@1952
|
4 |
* SourceMod |
|
ds@1952
|
5 |
* Copyright (C) 2004-2008 AlliedModders LLC. All rights reserved. |
|
ds@1952
|
6 |
* ============================================================================= |
|
ds@1952
|
7 |
* |
|
ds@1952
|
8 |
* This program is free software; you can redistribute it and/or modify it under |
|
ds@1952
|
9 |
* the terms of the GNU General Public License, version 3.0, as published by the |
|
ds@1952
|
10 |
* Free Software Foundation. |
|
ds@1952
|
11 |
* |
|
ds@1952
|
12 |
* This program is distributed in the hope that it will be useful, but WITHOUT |
|
ds@1952
|
13 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
|
ds@1952
|
14 |
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more |
|
ds@1952
|
15 |
* details. |
|
ds@1952
|
16 |
* |
|
ds@1952
|
17 |
* You should have received a copy of the GNU General Public License along with |
|
ds@1952
|
18 |
* this program. If not, see <http://www.gnu.org/licenses/>. |
|
ds@1952
|
19 |
* |
|
ds@1952
|
20 |
* As a special exception, AlliedModders LLC gives you permission to link the |
|
ds@1952
|
21 |
* code of this program (as well as its derivative works) to "Half-Life 2," the |
|
ds@1952
|
22 |
* "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software |
|
ds@1952
|
23 |
* by the Valve Corporation. You must obey the GNU General Public License in |
|
ds@1952
|
24 |
* all respects for all other code used. Additionally, AlliedModders LLC grants |
|
ds@1952
|
25 |
* this exception to all derivative works. AlliedModders LLC defines further |
|
ds@1952
|
26 |
* exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007), |
|
ds@1952
|
27 |
* or <http://www.sourcemod.net/license.php>. |
|
ds@1952
|
28 |
* |
|
ds@1952
|
29 |
* Version: $Id$ |
|
ds@1952
|
30 |
*/ |
|
ds@1952
|
31 |
|
|
ds@1952
|
32 |
#ifndef _INCLUDE_SOURCEMOD_ROOT_CONSOLE_MENU_H_ |
|
ds@1952
|
33 |
#define _INCLUDE_SOURCEMOD_ROOT_CONSOLE_MENU_H_ |
|
ds@1952
|
34 |
|
|
ds@1952
|
35 |
/** |
|
ds@1952
|
36 |
* @file IRootConsoleMenu.h |
|
ds@1952
|
37 |
* @brief Defines the interface for adding options to the "sm" console command. |
|
ds@1952
|
38 |
* |
|
ds@1952
|
39 |
* You must be using the compat_wrappers.h header file to use this on |
|
ds@1952
|
40 |
* Original/Episode1 builds. |
|
ds@1952
|
41 |
*/ |
|
ds@1952
|
42 |
|
|
ds@1952
|
43 |
#define SMINTERFACE_ROOTCONSOLE_NAME "IRootConsole" |
|
ds@1952
|
44 |
#define SMINTERFACE_ROOTCONSOLE_VERSION 1 |
|
ds@1952
|
45 |
|
|
ds@1952
|
46 |
class CCommand; |
|
ds@1952
|
47 |
|
|
ds@1952
|
48 |
namespace SourceMod |
|
ds@1952
|
49 |
{ |
|
ds@1952
|
50 |
/** |
|
ds@1952
|
51 |
* @brief Handles a root console menu action. |
|
ds@1952
|
52 |
*/ |
|
ds@1952
|
53 |
class IRootConsoleCommand |
|
ds@1952
|
54 |
{ |
|
ds@1952
|
55 |
public: |
|
ds@1952
|
56 |
virtual void OnRootConsoleCommand(const char *cmdname, const CCommand &command) =0; |
|
ds@1952
|
57 |
}; |
|
ds@1952
|
58 |
|
|
ds@1952
|
59 |
/** |
|
ds@1952
|
60 |
* @brief Manages the root console menu - the "sm" command for servers. |
|
ds@1952
|
61 |
*/ |
|
ds@1952
|
62 |
class IRootConsole : public SMInterface |
|
ds@1952
|
63 |
{ |
|
ds@1952
|
64 |
public: |
|
ds@1952
|
65 |
/** |
|
ds@1952
|
66 |
* @brief Adds a root console command handler. The command must be unique. |
|
ds@1952
|
67 |
* |
|
ds@1952
|
68 |
* @param cmd String containing the console command. |
|
ds@1952
|
69 |
* @param text Description text. |
|
ds@1952
|
70 |
* @param pHandler An IRootConsoleCommand pointer to handle the command. |
|
ds@1952
|
71 |
* @return True on success, false on too many commands or duplicate command. |
|
ds@1952
|
72 |
*/ |
|
ds@1952
|
73 |
virtual bool AddRootConsoleCommand(const char *cmd, const char *text, IRootConsoleCommand *pHandler) =0; |
|
ds@1952
|
74 |
|
|
ds@1952
|
75 |
/** |
|
ds@1952
|
76 |
* @brief Removes a root console command handler. |
|
ds@1952
|
77 |
* |
|
ds@1952
|
78 |
* @param cmd String containing the console command. |
|
ds@1952
|
79 |
* @param pHandler An IRootConsoleCommand pointer for verification. |
|
ds@1952
|
80 |
* @return True on success, false otherwise. |
|
ds@1952
|
81 |
*/ |
|
ds@1952
|
82 |
virtual bool RemoveRootConsoleCommand(const char *cmd, IRootConsoleCommand *pHandler) =0; |
|
ds@1952
|
83 |
|
|
ds@1952
|
84 |
/** |
|
ds@1952
|
85 |
* @brief Prints text back to the console. |
|
ds@1952
|
86 |
* |
|
ds@1952
|
87 |
* @param fmt Format of string. |
|
ds@1952
|
88 |
* @param ... Format arguments. |
|
ds@1952
|
89 |
*/ |
|
ds@1952
|
90 |
virtual void ConsolePrint(const char *fmt, ...) =0; |
|
ds@1952
|
91 |
|
|
ds@1952
|
92 |
/** |
|
ds@1952
|
93 |
* @brief Draws a generic command/description pair. |
|
ds@1952
|
94 |
* NOTE: The pair is currently four spaces indented and 16-N spaces of separation, |
|
ds@1952
|
95 |
* N being the length of the command name. This is subject to change in case we |
|
ds@1952
|
96 |
* account for Valve's font choices. |
|
ds@1952
|
97 |
* |
|
ds@1952
|
98 |
* @param cmd String containing the command option. |
|
ds@1952
|
99 |
* @param text String containing the command description. |
|
ds@1952
|
100 |
*/ |
|
ds@1952
|
101 |
virtual void DrawGenericOption(const char *cmd, const char *text) =0; |
|
ds@1952
|
102 |
}; |
|
ds@1952
|
103 |
} |
|
ds@1952
|
104 |
|
|
ds@1952
|
105 |
#endif //_INCLUDE_SOURCEMOD_ROOT_CONSOLE_MENU_H_ |
