Anope IRC Services  Version 2.0
Public Member Functions
CommandCSModes Class Reference
Inheritance diagram for CommandCSModes:
Inheritance graph
[legend]
Collaboration diagram for CommandCSModes:
Collaboration graph
[legend]

Public Member Functions

 CommandCSModes (Module *creator)
 
void Execute (CommandSource &source, const std::vector< Anope::string > &params) anope_override
 
const Anope::string GetDesc (CommandSource &source) const anope_override
 
bool OnHelp (CommandSource &source, const Anope::string &subcommand) anope_override
 
- Public Member Functions inherited from Command
virtual ~Command ()
 
bool AllowUnregistered () const
 
bool RequireUser () 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)
 

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
 
- 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)
 

Detailed Description

Definition at line 747 of file cs_mode.cpp.

Constructor & Destructor Documentation

CommandCSModes::CommandCSModes ( Module creator)
inline

Definition at line 750 of file cs_mode.cpp.

References _, and Command::SetSyntax().

Member Function Documentation

void CommandCSModes::Execute ( CommandSource source,
const std::vector< Anope::string > &  params 
)
inlinevirtual
const Anope::string CommandCSModes::GetDesc ( CommandSource source) const
inlinevirtual

Get the command description

Parameters
sourceThe source wanting the command description
Returns
The commands description

Reimplemented from Command.

Definition at line 827 of file cs_mode.cpp.

References _, Anope::printf(), and Language::Translate().

bool CommandCSModes::OnHelp ( CommandSource source,
const Anope::string subcommand 
)
inlinevirtual

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.

Definition at line 841 of file cs_mode.cpp.

References _, and Command::SendSyntax().


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