The InspIRCd Project
Home | Developers | Wiki | Forums | Bug Tracker | SVN | Download
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

ModulePartMsgBan Class Reference

Inheritance diagram for ModulePartMsgBan:

Inheritance graph
[legend]
Collaboration diagram for ModulePartMsgBan:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ModulePartMsgBan (InspIRCd *Me)
virtual ~ModulePartMsgBan ()
virtual Version GetVersion ()
 Returns the version number of a Module.
virtual void OnUserPart (User *user, Channel *channel, std::string &partmessage, bool &silent)
 Called when a user parts a channel.
virtual void On005Numeric (std::string &output)
 Called when a 005 numeric is about to be output.

Detailed Description

Definition at line 18 of file m_nopartmsg.cpp.

Constructor & Destructor Documentation

ModulePartMsgBan::ModulePartMsgBan (  InspIRCd *  Me  )  [inline]
 

Definition at line 22 of file m_nopartmsg.cpp.

References ModuleManager::Attach(), I_On005Numeric, I_OnUserPart, InspIRCd::Modules, and Module::ServerInstance.

virtual ModulePartMsgBan::~ModulePartMsgBan (   )  [inline, virtual]
 

Definition at line 28 of file m_nopartmsg.cpp.

Member Function Documentation

virtual Version ModulePartMsgBan::GetVersion (   )  [inline, virtual]
 

Returns the version number of a Module.

The method should return a Version object with its version information assigned via Version::Version

Reimplemented from Module.

Definition at line 32 of file m_nopartmsg.cpp.

References API_VERSION, and VF_VENDOR.

virtual void ModulePartMsgBan::On005Numeric (  std::string &  output  )  [inline, virtual]
 

Called when a 005 numeric is about to be output.

The module should modify the 005 numeric if needed to indicate its features.

Parameters:
output The 005 string to be modified if neccessary.

Reimplemented from Module.

Definition at line 49 of file m_nopartmsg.cpp.

virtual void ModulePartMsgBan::OnUserPart (  User *  user,
Channel *  channel,
std::string &  partmessage,
bool &  silent
)  [inline, virtual]
 

Called when a user parts a channel.

The details of the leaving user are available to you in the parameter User *user, and the details of the channel they have left is available in the variable Channel *channel

Parameters:
user The user who is parting
channel The channel being parted
partmessage The part message, or an empty string (may be modified)
silent Change this to true if you want to conceal the PART command from the other users of the channel (useful for modules such as auditorium)

Reimplemented from Module.

Definition at line 38 of file m_nopartmsg.cpp.

References IS_LOCAL, and Channel::IsExtBanned().

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