CConCommand - baso88/SC_AngelScript GitHub Wiki
The CConCommand class represents a custom server command.
Type: Reference type.
Constructors
| Constructor |
Description |
| CConCommand(const string& in szName, const string& in szHelpInfo, ConCommandCallback@ pCallback, const ConCommandFlags_t flags = ConCommandFlag::None) |
Creates a new command with the given name, help info, callback and flags. |
Member functions
| Function |
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. |
Funcdefs
| Funcdef |
Description |
| void ConCommandCallback(const CCommand@ args) |
Called when the command is executed. |