include/modules/help.h


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

/*
 * Anope IRC Services
 *
 * Copyright (C) 2014-2017 Anope Team <team@anope.org>
 *
 * This file is part of Anope. Anope is free software; you can
 * redistribute it and/or modify it under the terms of the GNU
 * General Public License as published by the Free Software
 * Foundation, version 2.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see see <http://www.gnu.org/licenses/>.
 */

namespace Event
{
	struct CoreExport Help : Events
	{
		static constexpr const char *NAME = "help";

		using Events::Events;

		/** Called when someone uses the generic/help command
		 * @param source Command source
		 * @param params Params
		 * @return EVENT_STOP to stop processing
		 */
		virtual EventReturn OnPreHelp(CommandSource &source, const std::vector<Anope::string> &params) anope_abstract;

		/** Called when someone uses the generic/help command
		 * @param source Command source
		 * @param params Params
		 */
		virtual void OnPostHelp(CommandSource &source, const std::vector<Anope::string> &params) anope_abstract;
	};
}