ouch/inspircd
2
0
Fork 0
mirror of https://github.com/inspircd/inspircd.git synced 2025-03-10 02:59:01 -04:00
Code Issues Packages Projects Releases Wiki Activity

Documentation of new chanrec functions

Browse Source 
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@4894 e03df62e-2008-0410-955e-edbf42e46eb7
This commit is contained in:
brain 2006-08-11 19:17:31 +00:00
parent ec62d9d1ef
commit 6557d7fa40
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
include/channels.h
View File

@ -428,18 +428,44 @@ class chanrec : public Extensible
*/
void WriteAllExceptSender(userrec* user, char status, const std::string& text);
/** Returns the maximum number of bans allowed to be set on this channel
* @return The maximum number of bans allowed
*/
long GetMaxBans();
/** Return the channel's modes with parameters.
* @param showkey If this is set to true, the actual key is shown,
* otherwise it is replaced with '<KEY>'
* @return The channel mode string
*/
char* ChanModes(bool showkey);
/** Spool the NAMES list for this channel to the given user
* @param The user to spool the NAMES list to
*/
void UserList(userrec *user);
/** Get the number of invisible users on this channel
* @return Number of invisible users
*/
int CountInvisible();
/** Get a users status on this channel
* @param The user to look up
* @return One of STATUS_OP, STATUS_HOP, STATUS_VOICE, or zero.
*/
int GetStatus(userrec *user);
/** Get a users status on this channel in a bitmask
* @param The user to look up
* @return A bitmask containing zero or more of STATUS_OP, STATUS_HOP, STATUS_VOICE
*/
int GetStatusFlags(userrec *user);
/** Get a users status on this channel in a string
* @param The user to look up
* @return A character array containing the string "@", "%", "+" or ""
*/
const char* GetStatusChar(userrec *user);
/** Destructor for chanrec