X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fchannels.h;h=c42a64efca6291af03706cb87f08445b3c0b06ca;hb=131f659d91953c51823ef70c8314aa3170ce7a7e;hp=0557a5898b5974b74b7334eddc7f28f97f5d49a5;hpb=58a0a7e01422e62de1565a8eb0a1febdc463d04d;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/channels.h b/include/channels.h index 0557a5898..c42a64efc 100644 --- a/include/channels.h +++ b/include/channels.h @@ -1,10 +1,13 @@ /* * InspIRCd -- Internet Relay Chat Daemon * + * Copyright (C) 2013-2018 Attila Molnar + * Copyright (C) 2012-2013, 2017-2020 Sadie Powell + * Copyright (C) 2012 Robby * Copyright (C) 2009 Daniel De Graaf - * Copyright (C) 2007 Robin Burchell - * Copyright (C) 2007 Dennis Friis - * Copyright (C) 2003-2007 Craig Edwards + * Copyright (C) 2007-2008 Robin Burchell + * Copyright (C) 2007, 2009 Dennis Friis + * Copyright (C) 2006, 2008, 2010 Craig Edwards * * This file is part of InspIRCd. InspIRCd is free software: you can * redistribute it and/or modify it under the terms of the GNU General Public @@ -30,7 +33,7 @@ * This class contains a single element in a channel list, such as a banlist. */ -/** Holds all relevent information for a channel. +/** Holds all relevant information for a channel. * This class represents a channel, and contains its name, modes, topic, topic set time, * etc, and an instance of the BanList type. */ @@ -155,7 +158,7 @@ class CoreExport Channel : public Extensible * @param user The user to add * * The data inserted into the reference list is a table as it is - * an arbitary pointer compared to other users by its memory address, + * an arbitrary pointer compared to other users by its memory address, * as this is a very fast 32 or 64 bit integer comparison. */ Membership* AddUser(User* user); @@ -225,7 +228,7 @@ class CoreExport Channel : public Extensible /** Join a user to an existing channel, without doing any permission checks * @param user The user to join to the channel - * @param privs Priviliges (prefix mode letters) to give to this user, may be NULL + * @param privs Privileges (prefix mode letters) to give to this user, may be NULL * @param bursting True if this join is the result of a netburst (passed to modules in the OnUserJoin hook) * @param created_by_local True if this channel was just created by a local user (passed to modules in the OnUserJoin hook) * @return A newly created Membership object, or NULL if the user was already inside the channel or if the user is a server user @@ -235,7 +238,6 @@ class CoreExport Channel : public Extensible /** Write to all users on a channel except some users * @param protoev Event to send, may contain any number of messages. * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone - * @param text A std::string containing the output line without prefix * @param except_list List of users not to send to */ void Write(ClientProtocol::Event& protoev, char status = 0, const CUList& except_list = CUList()); @@ -244,17 +246,16 @@ class CoreExport Channel : public Extensible * @param protoevprov Protocol event provider for the message. * @param msg Message to send. * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone - * @param text A std::string containing the output line without prefix * @param except_list List of users not to send to */ void Write(ClientProtocol::EventProvider& protoevprov, ClientProtocol::Message& msg, char status = 0, const CUList& except_list = CUList()); /** 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>' + * @param showsecret If this is set to true, the value of secret parameters + * are shown, otherwise they are replaced with '<name>'. * @return The channel mode string */ - const char* ChanModes(bool showkey); + const char* ChanModes(bool showsecret); /** Get the value of a users prefix on this channel. * @param user The user to look up @@ -285,8 +286,10 @@ class CoreExport Channel : public Extensible /** Write a NOTICE to all local users on the channel * @param text Text to send + * @param status The minimum status rank to send this message to. */ - void WriteNotice(const std::string& text); + void WriteNotice(const std::string& text, char status = 0); + void WriteRemoteNotice(const std::string& text, char status = 0); }; inline bool Channel::HasUser(User* user)