SourceMod::IRootConsole Class Reference

Manages the root console menu - the "sm" command for servers. More...

#include <public/IRootConsoleMenu.h>

Inherits SourceMod::SMInterface.

Collaboration diagram for SourceMod::IRootConsole:

List of all members.

Public Member Functions
virtual bool	AddRootConsoleCommand (const char *cmd, const char *text, IRootConsoleCommand *pHandler)=0
	Adds a root console command handler. The command must be unique.
virtual bool	RemoveRootConsoleCommand (const char *cmd, IRootConsoleCommand *pHandler)=0
	Removes a root console command handler.
virtual void	ConsolePrint (const char *fmt,...)=0
	Prints text back to the console.
virtual void	DrawGenericOption (const char *cmd, const char *text)=0
	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.
virtual bool	AddRootConsoleCommand2 (const char *cmd, const char *text, IRootConsoleCommand *pHandler)=0
	Adds a root console command handler. The command must be unique.

---

Detailed Description

Manages the root console menu - the "sm" command for servers.

Definition at line 97 of file IRootConsoleMenu.h.

---

Member Function Documentation

virtual bool SourceMod::IRootConsole::AddRootConsoleCommand	(	const char *	cmd,
		const char *	text,
		IRootConsoleCommand *	pHandler
	)			[pure virtual]

Adds a root console command handler. The command must be unique.

Parameters:

	cmd	String containing the console command.
	text	Description text.
	pHandler	An IRootConsoleCommand pointer to handle the command.

Returns:

True on success, false on too many commands or duplicate command.

virtual bool SourceMod::IRootConsole::RemoveRootConsoleCommand	(	const char *	cmd,
		IRootConsoleCommand *	pHandler
	)			[pure virtual]

Removes a root console command handler.

Parameters:

	cmd	String containing the console command.
	pHandler	An IRootConsoleCommand pointer for verification.

Returns:

True on success, false otherwise.

virtual void SourceMod::IRootConsole::ConsolePrint	(	const char *	fmt,
			...
	)			[pure virtual]

Prints text back to the console.

Parameters:

	fmt	Format of string.
	...	Format arguments.

virtual void SourceMod::IRootConsole::DrawGenericOption	(	const char *	cmd,
		const char *	text
	)			[pure virtual]

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.

Parameters:

	cmd	String containing the command option.
	text	String containing the command description.

virtual bool SourceMod::IRootConsole::AddRootConsoleCommand2	(	const char *	cmd,
		const char *	text,
		IRootConsoleCommand *	pHandler
	)			[pure virtual]

Adds a root console command handler. The command must be unique.

This version of the function uses the OnRootConsoleCommand2 callback.

Parameters:

	cmd	String containing the console command.
	text	Description text.
	pHandler	An IRootConsoleCommand pointer to handle the command.

Returns:

True on success, false on too many commands or duplicate command.

---

The documentation for this class was generated from the following file:

• public/IRootConsoleMenu.h