From 6557d7fa40b312027deb2b902a79ea0eba3dfcd0 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 11 Aug 2006 19:17:31 +0000 Subject: [PATCH] Documentation of new chanrec functions git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@4894 e03df62e-2008-0410-955e-edbf42e46eb7 --- include/channels.h | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/include/channels.h b/include/channels.h index cbc4a423f..8f3b8ba3d 100644 --- a/include/channels.h +++ b/include/channels.h @@ -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 -- 2.39.5