#include <ctables.h>
A structure that defines a command. Every command available in InspIRCd must be defined as derived from Command.
◆ CommandBase()
CommandBase::CommandBase |
( |
Module * |
me, |
|
|
const std::string & |
cmd, |
|
|
unsigned int |
minpara = 0 , |
|
|
unsigned int |
maxpara = 0 |
|
) |
| |
Create a new command.
- Parameters
-
me | The module which created this command. |
cmd | Command name. This must be UPPER CASE. |
minpara | Minimum parameters required for the command. |
maxpara | Maximum number of parameters this command may have - extra parameters will be tossed into one last space-separated param. |
◆ EncodeParameter()
void CommandBase::EncodeParameter |
( |
std::string & |
parameter, |
|
|
unsigned int |
index |
|
) |
| |
|
virtual |
Encode a parameter for server->server transmission. Used for parameters for which the translation type is TR_CUSTOM.
- Parameters
-
parameter | The parameter to encode. Can be modified in place. |
index | The parameter index (0 == first parameter). |
◆ allow_empty_last_param
bool CommandBase::allow_empty_last_param |
True if the command allows an empty last parameter. When false and the last parameter is empty, it's popped BEFORE checking there are enough params, etc. (i.e. the handler won't be called if there aren't enough params after popping the empty param). True by default
◆ max_params
const unsigned int CommandBase::max_params |
Maximum number of parameters command takes. This is used by the command parser to join extra parameters into one last param. If not set, no munging is done to this command.
◆ min_params
const unsigned int CommandBase::min_params |
Minimum number of parameters command takes
◆ translation
std::vector<TranslateType> CommandBase::translation |
Translation type list for possible parameters, used to tokenize parameters into UIDs and SIDs etc.
The documentation for this class was generated from the following files: