Anope IRC Services  Version 2.0
Public Member Functions | Protected Member Functions
CommandBSKickBase Class Referenceabstract
Inheritance diagram for CommandBSKickBase:
Inheritance graph
[legend]
Collaboration diagram for CommandBSKickBase:
Collaboration graph
[legend]

Public Member Functions

 CommandBSKickBase (Module *creator, const Anope::string &cname, int minarg, int maxarg)
 
virtual void Execute (CommandSource &source, const std::vector< Anope::string > &params) anope_override=0
 
virtual bool OnHelp (CommandSource &source, const Anope::string &subcommand) anope_override=0
 
- Public Member Functions inherited from Command
virtual ~Command ()
 
bool AllowUnregistered () const
 
bool RequireUser () const
 
virtual const Anope::string GetDesc (CommandSource &source) const
 
virtual void OnServHelp (CommandSource &source)
 
virtual void OnSyntaxError (CommandSource &source, const Anope::string &subcommand)
 
- Public Member Functions inherited from Service
 Service (Module *o, const Anope::string &t, const Anope::string &n)
 
virtual ~Service ()
 
void Register ()
 
void Unregister ()
 
- Public Member Functions inherited from Base
 Base ()
 
virtual ~Base ()
 
void AddReference (ReferenceBase *r)
 
void DelReference (ReferenceBase *r)
 

Protected Member Functions

bool CheckArguments (CommandSource &source, const std::vector< Anope::string > &params, ChannelInfo *&ci)
 
void Process (CommandSource &source, ChannelInfo *ci, const Anope::string &param, const Anope::string &ttb, size_t ttb_idx, const Anope::string &optname, KickerData *kd, bool &val)
 
- Protected Member Functions inherited from Command
 Command (Module *owner, const Anope::string &sname, size_t min_params, size_t max_params=0)
 
void SetDesc (const Anope::string &d)
 
void ClearSyntax ()
 
void SetSyntax (const Anope::string &s)
 
void SendSyntax (CommandSource &)
 
void AllowUnregistered (bool b)
 
void RequireUser (bool b)
 

Additional Inherited Members

- Static Public Member Functions inherited from Command
static void Run (CommandSource &source, const Anope::string &message)
 
static bool FindCommandFromService (const Anope::string &command_service, BotInfo *&bi, Anope::string &name)
 
- Static Public Member Functions inherited from Service
static ServiceFindService (const Anope::string &t, const Anope::string &n)
 
static std::vector< Anope::stringGetServiceKeys (const Anope::string &t)
 
static void AddAlias (const Anope::string &t, const Anope::string &n, const Anope::string &v)
 
static void DelAlias (const Anope::string &t, const Anope::string &n)
 
- Data Fields inherited from Command
size_t max_params
 
size_t min_params
 
Modulemodule
 
- Data Fields inherited from Service
Moduleowner
 
Anope::string type
 
Anope::string name
 

Detailed Description

Definition at line 163 of file bs_kick.cpp.

Constructor & Destructor Documentation

CommandBSKickBase::CommandBSKickBase ( Module creator,
const Anope::string cname,
int  minarg,
int  maxarg 
)
inline

Definition at line 166 of file bs_kick.cpp.

Member Function Documentation

bool CommandBSKickBase::CheckArguments ( CommandSource source,
const std::vector< Anope::string > &  params,
ChannelInfo *&  ci 
)
inlineprotected
virtual void CommandBSKickBase::Execute ( CommandSource source,
const std::vector< Anope::string > &  params 
)
pure virtual
virtual bool CommandBSKickBase::OnHelp ( CommandSource source,
const Anope::string subcommand 
)
pure virtual

Requested when the user is requesting help on this command. Help on this command should be sent to the user.

Parameters
sourceThe source
subcommandThe subcommand the user is requesting help on, or an empty string. (e.g. /ns help set foo bar lol gives a subcommand of "FOO BAR LOL")
Returns
true if help was provided to the user, false otherwise.

Reimplemented from Command.

Implemented in CommandBSKickUnderlines, CommandBSKickReverses, CommandBSKickRepeat, CommandBSKickItalics, CommandBSKickFlood, CommandBSKickColors, CommandBSKickCaps, CommandBSKickBolds, CommandBSKickBadwords, and CommandBSKickAMSG.

void CommandBSKickBase::Process ( CommandSource source,
ChannelInfo ci,
const Anope::string param,
const Anope::string ttb,
size_t  ttb_idx,
const Anope::string optname,
KickerData kd,
bool &  val 
)
inlineprotected

The documentation for this class was generated from the following file: