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

Public Member Functions

 CommandNSSetMessage (Module *creator, const Anope::string &sname="nickserv/set/message", size_t min=1)
 
void Run (CommandSource &source, const Anope::string &user, const Anope::string &param)
 
void Execute (CommandSource &source, const std::vector< Anope::string > &params) anope_override
 
bool OnHelp (CommandSource &source, const Anope::string &) anope_override
 
void OnServHelp (CommandSource &source) 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 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 876 of file ns_set.cpp.

Constructor & Destructor Documentation

CommandNSSetMessage::CommandNSSetMessage ( Module creator,
const Anope::string sname = "nickserv/set/message",
size_t  min = 1 
)
inline

Definition at line 879 of file ns_set.cpp.

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

Member Function Documentation

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

Execute this command.

Parameters
sourceThe source
paramsCommand parameters

Implements Command.

Reimplemented in CommandNSSASetMessage.

Definition at line 928 of file ns_set.cpp.

References Run().

bool CommandNSSetMessage::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.

Reimplemented in CommandNSSASetMessage.

Definition at line 933 of file ns_set.cpp.

References _, Anope::string::c_str(), CommandSource::command, Anope::string::find_last_of(), Anope::string::npos, CommandSource::Reply(), Command::SendSyntax(), Anope::string::substr(), and Anope::string::upper().

void CommandNSSetMessage::OnServHelp ( CommandSource source)
inlinevirtual

Called when HELP is requsted for the client this command is on.

Parameters
sourceThe source

Reimplemented from Command.

Definition at line 948 of file ns_set.cpp.

References Command::OnServHelp().

void CommandNSSetMessage::Run ( CommandSource source,
const Anope::string user,
const Anope::string param 
)
inline

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