Public Member Functions

CommandNSSetMessage Class Reference

Inherits Command.

Inherited by CommandNSSASetMessage.

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

Detailed Description

Definition at line 1003 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 1006 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 
) [inline, virtual]

Execute this command.

Parameters:
source The source
params Command parameters

Implements Command.

Reimplemented in CommandNSSASetMessage.

Definition at line 1049 of file ns_set.cpp.

References Run().

bool CommandNSSetMessage::OnHelp ( CommandSource source,
const Anope::string subcommand 
) [inline, virtual]

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

Parameters:
source The source
subcommand The 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 1054 of file ns_set.cpp.

References _, CommandSource::Reply(), and Command::SendSyntax().

void CommandNSSetMessage::OnServHelp ( CommandSource source  )  [inline, virtual]

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

Parameters:
source The source

Reimplemented from Command.

Definition at line 1064 of file ns_set.cpp.

References Config, and ServerConfig::UsePrivmsg.

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: