|
| ParamModeBase (Module *Creator, const std::string &Name, char modeletter, ParamSpec ps) |
|
ModeAction | OnModeChange (User *source, User *dest, Channel *channel, std::string ¶m, bool adding) CXX11_OVERRIDE |
|
virtual bool | IsParameterSecret () |
|
virtual void | OnUnset (User *source, Channel *chan) |
|
virtual ModeAction | OnSet (User *source, Channel *chan, std::string ¶m)=0 |
|
virtual void | GetParameter (Channel *chan, std::string &out)=0 |
|
Public Member Functions inherited from ModeHandler |
| ModeHandler (Module *me, const std::string &name, char modeletter, ParamSpec params, ModeType type, Class mclass=MC_OTHER) |
|
CullResult | cull () CXX11_OVERRIDE |
|
void | RegisterService () CXX11_OVERRIDE |
|
bool | IsListMode () const |
|
PrefixMode * | IsPrefixMode () |
|
const PrefixMode * | IsPrefixMode () const |
|
ListModeBase * | IsListModeBase () |
|
const ListModeBase * | IsListModeBase () const |
|
ParamModeBase * | IsParameterMode () |
|
const ParamModeBase * | IsParameterMode () const |
|
ModeType | GetModeType () const |
|
bool | NeedsOper () const |
|
bool | NeedsParam (bool adding) const |
|
char | GetModeChar () const |
|
Id | GetId () const |
|
virtual std::string | GetUserParameter (const User *user) const |
|
virtual ModResult | AccessCheck (User *source, Channel *channel, std::string ¶meter, bool adding) |
|
virtual void | DisplayList (User *user, Channel *channel) |
|
virtual void | OnParameterMissing (User *user, User *dest, Channel *channel) |
|
virtual void | DisplayEmptyList (User *user, Channel *channel) |
|
virtual bool | ResolveModeConflict (std::string &their_param, const std::string &our_param, Channel *channel) |
|
void | RemoveMode (User *user) |
|
virtual void | RemoveMode (Channel *channel, Modes::ChangeList &changelist) |
|
unsigned int | GetLevelRequired (bool adding) const |
|
const std::string & | GetSyntax () const |
|
| ServiceProvider (Module *Creator, const std::string &Name, ServiceType Type) |
|
const char * | GetTypeString () const |
|
void | DisableAutoRegister () |
|
◆ OnModeChange()
ModeAction ParamModeBase::OnModeChange |
( |
User * |
source, |
|
|
User * |
dest, |
|
|
Channel * |
channel, |
|
|
std::string & |
parameter, |
|
|
bool |
adding |
|
) |
| |
|
virtual |
Called when a mode change for your mode occurs.
- Parameters
-
source | Contains the user setting the mode. |
dest | For usermodes, contains the destination user the mode is being set on. For channelmodes, this is an undefined value. |
channel | For channel modes, contains the destination channel the modes are being set on. For usermodes, this is an undefined value. |
parameter | The parameter for your mode, if you indicated that your mode requires a parameter when being set or unset. Note that if you alter this value, the new value becomes the one displayed and send out to the network, also, if you set this to an empty string but you specified your mode REQUIRES a parameter, this is equivalent to returning MODEACTION_DENY and will prevent the mode from being displayed. |
adding | This value is true when the mode is being set, or false when it is being unset. |
- Returns
- MODEACTION_ALLOW to allow the mode, or MODEACTION_DENY to prevent the mode, also see the description of 'parameter'.
Reimplemented from ModeHandler.
The documentation for this class was generated from the following files: