Anope IRC Services  Version 2.0
Public Member Functions | Static Private Member Functions | Static Private Attributes
CommandHelp Class Reference
Inheritance diagram for CommandHelp:
Inheritance graph
Collaboration diagram for CommandHelp:
Collaboration graph

Public Member Functions

 CommandHelp (Module *creator)
void Execute (CommandSource &source, const std::vector< Anope::string > &params) anope_override
- 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 bool OnHelp (CommandSource &source, const Anope::string &subcommand)
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)

Static Private Member Functions

static CommandGroupFindGroup (const Anope::string &name)

Static Private Attributes

static const unsigned help_wrap_len = 40

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
- Data Fields inherited from Service
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 14 of file help.cpp.

Constructor & Destructor Documentation

◆ CommandHelp()

CommandHelp::CommandHelp ( Module creator)

Definition at line 31 of file help.cpp.

References _, Command::AllowUnregistered(), and Command::SetDesc().

Member Function Documentation

◆ Execute()

void CommandHelp::Execute ( CommandSource source,
const std::vector< Anope::string > &  params 

◆ FindGroup()

static CommandGroup* CommandHelp::FindGroup ( const Anope::string name)

Definition at line 18 of file help.cpp.

References CommandGroup::name.

Referenced by Execute().

Field Documentation

◆ help_wrap_len

const unsigned CommandHelp::help_wrap_len = 40

Definition at line 16 of file help.cpp.

Referenced by Execute().

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