Skip to content

CClientCommand

GeckoN edited this page Mar 29, 2017 · 5 revisions

The CClientCommand class represents a custom client command.

Type: Reference type.

Constructors

ConstructorDescription
CClientCommand@ CClientCommand(const string& in szName, const string& in szHelpInfo, ClientCommandCallback@ pCallback, const ConCommandFlags_t flags = ConCommandFlag::None)Creates a client command with the given name, help info, callback and flags.

Member functions

FunctionDescription
const string& GetName() constGets the name of this command.
const string& GetFullyQualifiedName() constGets the fully qualified name of this command. This is the name that the command is referred to when called.
const string& GetHelpInfo() constGets the help info describing this command.
ConCommandKind::Type GetKind() constGets the type of this console command.
const string& GetOwningModuleName() constGets the name of the module that owns (created) this command.
bool HasBeenAdded() constWhether this command was added to the list of commands. Must be added to be usable from the console.

Funcdefs

FuncdefDescription
void ClientCommandCallback(const CCommand@ args)Called when the command is executed.

Clone this wiki locally