Difference between revisions of "CClientCommand"
Jump to navigation
Jump to search
Outerbeast (talk | contribs) (Created page with "The CClientCommand class represents a custom client command. Type: Reference type. <hr> This constructor creates a client command with the given name, help info, callback and...") |
Outerbeast (talk | contribs) m (→Methods) |
||
| Line 32: | Line 32: | ||
| Whether this command was added to the list of commands. Must be added to be usable from the console. | | Whether this command was added to the list of commands. Must be added to be usable from the console. | ||
|} | |} | ||
| − | [[Category:Scripting | + | [[Category:Scripting]] |
Latest revision as of 21:56, 5 April 2025
The CClientCommand class represents a custom client command.
Type: Reference type.
This constructor creates a client command with the given name, help info, callback and flags:
CClientCommand@ CClientCommand(const string& in szName, const string& in szHelpInfo, ClientCommandCallback@ pCallback, const ConCommandFlags_t flags = ConCommandFlag::None)
Funcdef - Called when the command is executed:
void ClientCommandCallback(const CCommand@ args)
Methods
| Method | Description |
|---|---|
const string& GetName() const
|
Gets the name of this command. |
const string& GetFullyQualifiedName() const
|
Gets the fully qualified name of this command. This is the name that the command is referred to when called. |
const string& GetHelpInfo() const
|
Gets the help info describing this command. |
ConCommandKind::Type GetKind() const
|
Gets the type of this console command. |
const string& GetOwningModuleName() const
|
Gets the name of the module that owns (created) this command. |
bool HasBeenAdded() const
|
Whether this command was added to the list of commands. Must be added to be usable from the console. |