Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

ModuleAbbreviation Class Reference

Inheritance diagram for ModuleAbbreviation:

[legend]Collaboration diagram for ModuleAbbreviation:

[legend]List of all members.

Public Member Functions
	ModuleAbbreviation (InspIRCd *Me)
virtual Version	GetVersion ()
	Returns the version number of a Module.
virtual int	OnPreCommand (std::string &command, std::vector< std::string > &parameters, User *user, bool validated, const std::string &original_line)
	Called whenever any command is about to be executed.

---

Detailed Description

Definition at line 18 of file m_abbreviation.cpp.

---

Constructor & Destructor Documentation

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

Definition at line 23 of file m_abbreviation.cpp. References ModuleManager::Attach(), I_OnPreCommand, InspIRCd::Modules, PRIO_FIRST, and ModuleManager::SetPriority().

---

Member Function Documentation

virtual Version ModuleAbbreviation::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 31 of file m_abbreviation.cpp. References API_VERSION, and VF_VENDOR.

virtual int ModuleAbbreviation::OnPreCommand (  std::string &  command, std::vector< std::string > &  parameters, User *  user, bool  validated, const std::string &  original_line )  [inline, virtual]

Called whenever any command is about to be executed. This event occurs for all registered commands, wether they are registered in the core, or another module, and for invalid commands. Invalid commands may only be sent to this function when the value of validated is false. By returning 1 from this method you may prevent the command being executed. If you do this, no output is created by the core, and it is down to your module to produce any output neccessary. Note that unless you return 1, you should not destroy any structures (e.g. by using InspIRCd::QuitUser) otherwise when the command's handler function executes after your method returns, it will be passed an invalid pointer to the user object and crash!) Parameters: command  The command being executed parameters  An array of array of characters containing the parameters for the command pcnt  The nuimber of parameters passed to the command user  the user issuing the command validated  True if the command has passed all checks, e.g. it is recognised, has enough parameters, the user has permission to execute it, etc. You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs). original_line  The entire original line as passed to the parser from the user Returns: 1 to block the command, 0 to allow Reimplemented from Module. Definition at line 36 of file m_abbreviation.cpp. References CommandParser::cmdlist, User::nick, InspIRCd::Parser, Module::ServerInstance, and User::WriteNumeric().

---

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

• m_abbreviation.cpp